{"action":"created","comment":{"url":"https://api.github.com/repos/gem/oq-engine/pulls/comments/44915499","id":44915499,"diff_hunk":"@@ -1,33 +1,84 @@\n-~~ DRAFT ~~\n-\n-# Start the webui\n-content\n-# Start the calculation\n-content\n-# Use the webui\n-## Download the outputs\n-content\n-## Watch the log\n-content\n-## Remove a calculation\n-content\n-# Advanced use\n-## Authentication support\n+# The OpenQuake WebUI\n+\n+## Starting the webui\n+### From sources\n+```bash\n+$ cd /path/to/oq-engine/openquake/server\n+$ python manage.py runserver\n+```\n+\n+### From packages\n+```bash\n+$ cd /usr/lib/python2.7/dist-packages/openquake/server\n+$ python manage.py runserver\n+```\n+\n+To stop the WebUI process press `CTRL-C`\n+\n+## Using the webui\n+\n+Open Firefox or Chrome and load the [http://localhost:8000/engine](http://localhost:8000/engine) page\n+![WebUI main page](../img/WebUI-main.png)\n+\n+### Start a calculation\n+\n+Before starting a new calculation you need to prepare inputs. All the inputs file and the `job.ini` must be placed in a compressed zip file.\n+\n+To start a calculation, having the input zip file, select the `Run a Calculation` button in the header menu. A dialog window will appear: select the zip file to be uploaded and press `Open` to confirm\n+\n+![WebUI start a calculation](../img/WebUI-run.gif)\n+\n+### Watch the console log\n+\n+It can be possible to watch the log from a running calculation\n+\n+![WebUI log](../img/WebUI-log.gif)\n+\n+The log from a previous run can be also inspected.\n+\n+### Download outputs\n+\n+If a calculation has run succesfully an `Outputs` button is provided. Click the `Outputs` button to see the list of outputs available for the specific calculation type. Output formats (`xml`, `csv`, `geojson`) availability depends on the type of artifacts generated by the calculation. Click on the desired output/format to download the corresponding file\n+\n+![WebUI outputs](../img/WebUI-outputs.gif)\n+\n+### Run a risk calculation on top of hazard\n+\n+To run a risk-only calculation on top of a previous hazard run you have to click the `Run Risk` button on the corresponding hazard calculation and select the zip file containing the risk `job.ini` and the related inputs\n+\n+![WebUI outputs](../img/WebUI-risk.gif)\n+\n+### Remove a calculation\n+\n+To remove a calculation from the list press the `Remove` button\n+\n+![WebUI remove](../img/WebUI-remove.gif)\n+\n+### Calculation status\n+\n+A calculation can be in the following statuses `pre_executing`, `executing`, `complete`, `failed`\n+","path":"doc/server/OpenQuake-engine-webui.md","position":75,"original_position":75,"commit_id":"4d754fe04ad67c1ff3fe3e02617012ffcd888339","original_commit_id":"4d754fe04ad67c1ff3fe3e02617012ffcd888339","user":{"login":"micheles","id":2463856,"avatar_url":"https://avatars.githubusercontent.com/u/2463856?v=3","gravatar_id":"","url":"https://api.github.com/users/micheles","html_url":"https://github.com/micheles","followers_url":"https://api.github.com/users/micheles/followers","following_url":"https://api.github.com/users/micheles/following{/other_user}","gists_url":"https://api.github.com/users/micheles/gists{/gist_id}","starred_url":"https://api.github.com/users/micheles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micheles/subscriptions","organizations_url":"https://api.github.com/users/micheles/orgs","repos_url":"https://api.github.com/users/micheles/repos","events_url":"https://api.github.com/users/micheles/events{/privacy}","received_events_url":"https://api.github.com/users/micheles/received_events","type":"User","site_admin":false},"body":"Please add a colon after statuses:","created_at":"2015-11-16T11:59:00Z","updated_at":"2015-11-16T11:59:00Z","html_url":"https://github.com/gem/oq-engine/pull/1903#discussion_r44915499","pull_request_url":"https://api.github.com/repos/gem/oq-engine/pulls/1903","_links":{"self":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/comments/44915499"},"html":{"href":"https://github.com/gem/oq-engine/pull/1903#discussion_r44915499"},"pull_request":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/1903"}}},"pull_request":{"url":"https://api.github.com/repos/gem/oq-engine/pulls/1903","id":50796742,"html_url":"https://github.com/gem/oq-engine/pull/1903","diff_url":"https://github.com/gem/oq-engine/pull/1903.diff","patch_url":"https://github.com/gem/oq-engine/pull/1903.patch","issue_url":"https://api.github.com/repos/gem/oq-engine/issues/1903","number":1903,"state":"open","locked":false,"title":"WebUI doc","user":{"login":"daniviga","id":1818657,"avatar_url":"https://avatars.githubusercontent.com/u/1818657?v=3","gravatar_id":"","url":"https://api.github.com/users/daniviga","html_url":"https://github.com/daniviga","followers_url":"https://api.github.com/users/daniviga/followers","following_url":"https://api.github.com/users/daniviga/following{/other_user}","gists_url":"https://api.github.com/users/daniviga/gists{/gist_id}","starred_url":"https://api.github.com/users/daniviga/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/daniviga/subscriptions","organizations_url":"https://api.github.com/users/daniviga/orgs","repos_url":"https://api.github.com/users/daniviga/repos","events_url":"https://api.github.com/users/daniviga/events{/privacy}","received_events_url":"https://api.github.com/users/daniviga/received_events","type":"User","site_admin":false},"body":"Not perfect, but enough for 1.6.0\r\n\r\nFinal result: https://github.com/gem/oq-engine/blob/webui-doc/doc/server/OpenQuake-engine-webui.md\r\nCloses #1878 ","created_at":"2015-11-16T11:04:52Z","updated_at":"2015-11-16T11:59:00Z","closed_at":null,"merged_at":null,"merge_commit_sha":"9c2850fbbac31222c45cd5ac81baa1eadfd4bd48","assignee":{"login":"micheles","id":2463856,"avatar_url":"https://avatars.githubusercontent.com/u/2463856?v=3","gravatar_id":"","url":"https://api.github.com/users/micheles","html_url":"https://github.com/micheles","followers_url":"https://api.github.com/users/micheles/followers","following_url":"https://api.github.com/users/micheles/following{/other_user}","gists_url":"https://api.github.com/users/micheles/gists{/gist_id}","starred_url":"https://api.github.com/users/micheles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micheles/subscriptions","organizations_url":"https://api.github.com/users/micheles/orgs","repos_url":"https://api.github.com/users/micheles/repos","events_url":"https://api.github.com/users/micheles/events{/privacy}","received_events_url":"https://api.github.com/users/micheles/received_events","type":"User","site_admin":false},"milestone":{"url":"https://api.github.com/repos/gem/oq-engine/milestones/1","html_url":"https://github.com/gem/oq-engine/milestones/Engine%201.6.0","labels_url":"https://api.github.com/repos/gem/oq-engine/milestones/1/labels","id":1288369,"number":1,"title":"Engine 1.6.0","description":"","creator":{"login":"micheles","id":2463856,"avatar_url":"https://avatars.githubusercontent.com/u/2463856?v=3","gravatar_id":"","url":"https://api.github.com/users/micheles","html_url":"https://github.com/micheles","followers_url":"https://api.github.com/users/micheles/followers","following_url":"https://api.github.com/users/micheles/following{/other_user}","gists_url":"https://api.github.com/users/micheles/gists{/gist_id}","starred_url":"https://api.github.com/users/micheles/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micheles/subscriptions","organizations_url":"https://api.github.com/users/micheles/orgs","repos_url":"https://api.github.com/users/micheles/repos","events_url":"https://api.github.com/users/micheles/events{/privacy}","received_events_url":"https://api.github.com/users/micheles/received_events","type":"User","site_admin":false},"open_issues":3,"closed_issues":47,"state":"open","created_at":"2015-09-03T13:25:22Z","updated_at":"2015-11-16T11:04:52Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/gem/oq-engine/pulls/1903/commits","review_comments_url":"https://api.github.com/repos/gem/oq-engine/pulls/1903/comments","review_comment_url":"https://api.github.com/repos/gem/oq-engine/pulls/comments{/number}","comments_url":"https://api.github.com/repos/gem/oq-engine/issues/1903/comments","statuses_url":"https://api.github.com/repos/gem/oq-engine/statuses/4d754fe04ad67c1ff3fe3e02617012ffcd888339","head":{"label":"gem:webui-doc","ref":"webui-doc","sha":"4d754fe04ad67c1ff3fe3e02617012ffcd888339","user":{"login":"gem","id":316546,"avatar_url":"https://avatars.githubusercontent.com/u/316546?v=3","gravatar_id":"","url":"https://api.github.com/users/gem","html_url":"https://github.com/gem","followers_url":"https://api.github.com/users/gem/followers","following_url":"https://api.github.com/users/gem/following{/other_user}","gists_url":"https://api.github.com/users/gem/gists{/gist_id}","starred_url":"https://api.github.com/users/gem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gem/subscriptions","organizations_url":"https://api.github.com/users/gem/orgs","repos_url":"https://api.github.com/users/gem/repos","events_url":"https://api.github.com/users/gem/events{/privacy}","received_events_url":"https://api.github.com/users/gem/received_events","type":"Organization","site_admin":false},"repo":{"id":744916,"name":"oq-engine","full_name":"gem/oq-engine","owner":{"login":"gem","id":316546,"avatar_url":"https://avatars.githubusercontent.com/u/316546?v=3","gravatar_id":"","url":"https://api.github.com/users/gem","html_url":"https://github.com/gem","followers_url":"https://api.github.com/users/gem/followers","following_url":"https://api.github.com/users/gem/following{/other_user}","gists_url":"https://api.github.com/users/gem/gists{/gist_id}","starred_url":"https://api.github.com/users/gem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gem/subscriptions","organizations_url":"https://api.github.com/users/gem/orgs","repos_url":"https://api.github.com/users/gem/repos","events_url":"https://api.github.com/users/gem/events{/privacy}","received_events_url":"https://api.github.com/users/gem/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gem/oq-engine","description":"OpenQuake's Engine for Seismic Hazard and Risk Analysis","fork":false,"url":"https://api.github.com/repos/gem/oq-engine","forks_url":"https://api.github.com/repos/gem/oq-engine/forks","keys_url":"https://api.github.com/repos/gem/oq-engine/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gem/oq-engine/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gem/oq-engine/teams","hooks_url":"https://api.github.com/repos/gem/oq-engine/hooks","issue_events_url":"https://api.github.com/repos/gem/oq-engine/issues/events{/number}","events_url":"https://api.github.com/repos/gem/oq-engine/events","assignees_url":"https://api.github.com/repos/gem/oq-engine/assignees{/user}","branches_url":"https://api.github.com/repos/gem/oq-engine/branches{/branch}","tags_url":"https://api.github.com/repos/gem/oq-engine/tags","blobs_url":"https://api.github.com/repos/gem/oq-engine/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gem/oq-engine/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gem/oq-engine/git/refs{/sha}","trees_url":"https://api.github.com/repos/gem/oq-engine/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gem/oq-engine/statuses/{sha}","languages_url":"https://api.github.com/repos/gem/oq-engine/languages","stargazers_url":"https://api.github.com/repos/gem/oq-engine/stargazers","contributors_url":"https://api.github.com/repos/gem/oq-engine/contributors","subscribers_url":"https://api.github.com/repos/gem/oq-engine/subscribers","subscription_url":"https://api.github.com/repos/gem/oq-engine/subscription","commits_url":"https://api.github.com/repos/gem/oq-engine/commits{/sha}","git_commits_url":"https://api.github.com/repos/gem/oq-engine/git/commits{/sha}","comments_url":"https://api.github.com/repos/gem/oq-engine/comments{/number}","issue_comment_url":"https://api.github.com/repos/gem/oq-engine/issues/comments{/number}","contents_url":"https://api.github.com/repos/gem/oq-engine/contents/{+path}","compare_url":"https://api.github.com/repos/gem/oq-engine/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gem/oq-engine/merges","archive_url":"https://api.github.com/repos/gem/oq-engine/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gem/oq-engine/downloads","issues_url":"https://api.github.com/repos/gem/oq-engine/issues{/number}","pulls_url":"https://api.github.com/repos/gem/oq-engine/pulls{/number}","milestones_url":"https://api.github.com/repos/gem/oq-engine/milestones{/number}","notifications_url":"https://api.github.com/repos/gem/oq-engine/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gem/oq-engine/labels{/name}","releases_url":"https://api.github.com/repos/gem/oq-engine/releases{/id}","created_at":"2010-06-28T14:59:42Z","updated_at":"2015-10-26T02:33:34Z","pushed_at":"2015-11-16T11:06:54Z","git_url":"git://github.com/gem/oq-engine.git","ssh_url":"git@github.com:gem/oq-engine.git","clone_url":"https://github.com/gem/oq-engine.git","svn_url":"https://github.com/gem/oq-engine","homepage":"https://github.com/gem/oq-engine/blob/master/doc/engine/About.md","size":524367,"stargazers_count":74,"watchers_count":74,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":51,"mirror_url":null,"open_issues_count":11,"forks":51,"open_issues":11,"watchers":74,"default_branch":"master"}},"base":{"label":"gem:engine-1.6","ref":"engine-1.6","sha":"14303263fd56649ad67a7f907f22c0dfb348d7c9","user":{"login":"gem","id":316546,"avatar_url":"https://avatars.githubusercontent.com/u/316546?v=3","gravatar_id":"","url":"https://api.github.com/users/gem","html_url":"https://github.com/gem","followers_url":"https://api.github.com/users/gem/followers","following_url":"https://api.github.com/users/gem/following{/other_user}","gists_url":"https://api.github.com/users/gem/gists{/gist_id}","starred_url":"https://api.github.com/users/gem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gem/subscriptions","organizations_url":"https://api.github.com/users/gem/orgs","repos_url":"https://api.github.com/users/gem/repos","events_url":"https://api.github.com/users/gem/events{/privacy}","received_events_url":"https://api.github.com/users/gem/received_events","type":"Organization","site_admin":false},"repo":{"id":744916,"name":"oq-engine","full_name":"gem/oq-engine","owner":{"login":"gem","id":316546,"avatar_url":"https://avatars.githubusercontent.com/u/316546?v=3","gravatar_id":"","url":"https://api.github.com/users/gem","html_url":"https://github.com/gem","followers_url":"https://api.github.com/users/gem/followers","following_url":"https://api.github.com/users/gem/following{/other_user}","gists_url":"https://api.github.com/users/gem/gists{/gist_id}","starred_url":"https://api.github.com/users/gem/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gem/subscriptions","organizations_url":"https://api.github.com/users/gem/orgs","repos_url":"https://api.github.com/users/gem/repos","events_url":"https://api.github.com/users/gem/events{/privacy}","received_events_url":"https://api.github.com/users/gem/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/gem/oq-engine","description":"OpenQuake's Engine for Seismic Hazard and Risk Analysis","fork":false,"url":"https://api.github.com/repos/gem/oq-engine","forks_url":"https://api.github.com/repos/gem/oq-engine/forks","keys_url":"https://api.github.com/repos/gem/oq-engine/keys{/key_id}","collaborators_url":"https://api.github.com/repos/gem/oq-engine/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/gem/oq-engine/teams","hooks_url":"https://api.github.com/repos/gem/oq-engine/hooks","issue_events_url":"https://api.github.com/repos/gem/oq-engine/issues/events{/number}","events_url":"https://api.github.com/repos/gem/oq-engine/events","assignees_url":"https://api.github.com/repos/gem/oq-engine/assignees{/user}","branches_url":"https://api.github.com/repos/gem/oq-engine/branches{/branch}","tags_url":"https://api.github.com/repos/gem/oq-engine/tags","blobs_url":"https://api.github.com/repos/gem/oq-engine/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/gem/oq-engine/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/gem/oq-engine/git/refs{/sha}","trees_url":"https://api.github.com/repos/gem/oq-engine/git/trees{/sha}","statuses_url":"https://api.github.com/repos/gem/oq-engine/statuses/{sha}","languages_url":"https://api.github.com/repos/gem/oq-engine/languages","stargazers_url":"https://api.github.com/repos/gem/oq-engine/stargazers","contributors_url":"https://api.github.com/repos/gem/oq-engine/contributors","subscribers_url":"https://api.github.com/repos/gem/oq-engine/subscribers","subscription_url":"https://api.github.com/repos/gem/oq-engine/subscription","commits_url":"https://api.github.com/repos/gem/oq-engine/commits{/sha}","git_commits_url":"https://api.github.com/repos/gem/oq-engine/git/commits{/sha}","comments_url":"https://api.github.com/repos/gem/oq-engine/comments{/number}","issue_comment_url":"https://api.github.com/repos/gem/oq-engine/issues/comments{/number}","contents_url":"https://api.github.com/repos/gem/oq-engine/contents/{+path}","compare_url":"https://api.github.com/repos/gem/oq-engine/compare/{base}...{head}","merges_url":"https://api.github.com/repos/gem/oq-engine/merges","archive_url":"https://api.github.com/repos/gem/oq-engine/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/gem/oq-engine/downloads","issues_url":"https://api.github.com/repos/gem/oq-engine/issues{/number}","pulls_url":"https://api.github.com/repos/gem/oq-engine/pulls{/number}","milestones_url":"https://api.github.com/repos/gem/oq-engine/milestones{/number}","notifications_url":"https://api.github.com/repos/gem/oq-engine/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/gem/oq-engine/labels{/name}","releases_url":"https://api.github.com/repos/gem/oq-engine/releases{/id}","created_at":"2010-06-28T14:59:42Z","updated_at":"2015-10-26T02:33:34Z","pushed_at":"2015-11-16T11:06:54Z","git_url":"git://github.com/gem/oq-engine.git","ssh_url":"git@github.com:gem/oq-engine.git","clone_url":"https://github.com/gem/oq-engine.git","svn_url":"https://github.com/gem/oq-engine","homepage":"https://github.com/gem/oq-engine/blob/master/doc/engine/About.md","size":524367,"stargazers_count":74,"watchers_count":74,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":51,"mirror_url":null,"open_issues_count":11,"forks":51,"open_issues":11,"watchers":74,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/1903"},"html":{"href":"https://github.com/gem/oq-engine/pull/1903"},"issue":{"href":"https://api.github.com/repos/gem/oq-engine/issues/1903"},"comments":{"href":"https://api.github.com/repos/gem/oq-engine/issues/1903/comments"},"review_comments":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/1903/comments"},"review_comment":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/gem/oq-engine/pulls/1903/commits"},"statuses":{"href":"https://api.github.com/repos/gem/oq-engine/statuses/4d754fe04ad67c1ff3fe3e02617012ffcd888339"}}}}