{"action":"created","comment":{"url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/comments/191394491","pull_request_review_id":123955925,"id":191394491,"diff_hunk":"@@ -0,0 +1,84 @@\n+.. _quick_start:\n+\n+Quick Start\n+===========\n+\n+This quick-start contains an overview of how the ``xpdAn`` software works.\n+To understand more details about it, please refer to the detailed documentation in :ref:`xpdu`\n+\n+Please use this page as a reminder of the workflow and to copy & paste code snippets into the\n+ipython terminals that are controlling your experiment and analysis.  After\n+pasting, hit enter.\n+\n+Remember, to post questions about anything XPD, including software, and to see archived answers, at the `XPD-Users Google group\n+<https://groups.google.com/forum/#!forum/xpd-users;context-place=overview>`_ . If you are not already a member please request to join\n+the community\n+\n+XPD Data Analysis Workflow Summary\n+------------------------------------\n+\n+This is the summary of the steps for analysis data at XPD.\n+The steps are explained below.\n+Carry out the steps in this order to ensure a successful analysis.\n+\n+  1. If you haven't already, join `XPD-Users Google group <https://groups.google.com/forum/#!forum/xpd-users;context-place=overview>`_ . Look here for answers if you get stuck and if the answer to your question is not already there, please ask it!\n+\n+  2. Start the analysis by running ``{{ start_analysis }}`` in a terminal\n+\n+  3. Your data will be automatically saved and visualized via the analysis pipeline.\n+\n+    * The data will be saved in the directory\n+      ``.../xpdUser/tiff_base/<Sample_name_from_spreadsheet>``.\n+\n+    * The pipeline will save:\n+\n+        1. Dark corrected image (as ``.tiff``)\n+        2. Mask (as ``.msk`` and ``.npy``,\n+           ``.msk`` files are read by ``fit2d`` while ``.npy`` files are read\n+           by numpy). The frequency of mask production is controlled by\n+           ``mask_settings``.\n+        3. Integrated scattering intensity, I(Q) (as ``.chi``)\n+        4. I(tth) (as ``.chi``), note that this is the same as I(Q) on the tth\n+           grid.\n+        5. The PDF, G(r) (as ``.gr``)\n+        6. Calibration parameters (as ``.poni``, if the scan is an analysis\n+           scan)\n+        7. Scan metadata (as ``.yaml``)\n+\n+\n+    * The pipeline will visualize the:\n+\n+        1. Dark corrected image\n+        2. Mask\n+        3. I(Q)\n+        4. I(tth)\n+        5. F(Q)\n+        6. G(r)\n+\n+  4. To change the pipeline configuration stop the ``{{ start_analysis }}`` by\n+     typing ``Ctrl+C`` in the terminal. Then edit one of the configuration\n+     dictionaries which are loaded into ipython.","path":"docs/_templates/quickstart.rst","position":60,"original_position":60,"commit_id":"62cc30d1f2ae3b476bd70ba83a21ba08f6db8caa","original_commit_id":"62cc30d1f2ae3b476bd70ba83a21ba08f6db8caa","user":{"login":"CJ-Wright","id":6740689,"avatar_url":"https://avatars3.githubusercontent.com/u/6740689?v=4","gravatar_id":"","url":"https://api.github.com/users/CJ-Wright","html_url":"https://github.com/CJ-Wright","followers_url":"https://api.github.com/users/CJ-Wright/followers","following_url":"https://api.github.com/users/CJ-Wright/following{/other_user}","gists_url":"https://api.github.com/users/CJ-Wright/gists{/gist_id}","starred_url":"https://api.github.com/users/CJ-Wright/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CJ-Wright/subscriptions","organizations_url":"https://api.github.com/users/CJ-Wright/orgs","repos_url":"https://api.github.com/users/CJ-Wright/repos","events_url":"https://api.github.com/users/CJ-Wright/events{/privacy}","received_events_url":"https://api.github.com/users/CJ-Wright/received_events","type":"User","site_admin":false},"body":"They are loaded into ipython as variables, one could type ``print(mask_kwargs)`` and get them.","created_at":"2018-05-29T11:49:36Z","updated_at":"2018-05-29T11:49:36Z","html_url":"https://github.com/xpdAcq/xpdAn/pull/201#discussion_r191394491","pull_request_url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201","author_association":"MEMBER","_links":{"self":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/comments/191394491"},"html":{"href":"https://github.com/xpdAcq/xpdAn/pull/201#discussion_r191394491"},"pull_request":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201"}},"in_reply_to_id":191262358},"pull_request":{"url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201","id":186070150,"html_url":"https://github.com/xpdAcq/xpdAn/pull/201","diff_url":"https://github.com/xpdAcq/xpdAn/pull/201.diff","patch_url":"https://github.com/xpdAcq/xpdAn/pull/201.patch","issue_url":"https://api.github.com/repos/xpdAcq/xpdAn/issues/201","number":201,"state":"open","locked":false,"title":"DOC: quickstart docs","user":{"login":"CJ-Wright","id":6740689,"avatar_url":"https://avatars3.githubusercontent.com/u/6740689?v=4","gravatar_id":"","url":"https://api.github.com/users/CJ-Wright","html_url":"https://github.com/CJ-Wright","followers_url":"https://api.github.com/users/CJ-Wright/followers","following_url":"https://api.github.com/users/CJ-Wright/following{/other_user}","gists_url":"https://api.github.com/users/CJ-Wright/gists{/gist_id}","starred_url":"https://api.github.com/users/CJ-Wright/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CJ-Wright/subscriptions","organizations_url":"https://api.github.com/users/CJ-Wright/orgs","repos_url":"https://api.github.com/users/CJ-Wright/repos","events_url":"https://api.github.com/users/CJ-Wright/events{/privacy}","received_events_url":"https://api.github.com/users/CJ-Wright/received_events","type":"User","site_admin":false},"body":"Closes: https://github.com/xpdAcq/mission-control/issues/47\r\nCloses: https://github.com/xpdAcq/mission-control/issues/78\r\nCloses: https://github.com/xpdAcq/mission-control/issues/55","created_at":"2018-05-04T18:46:46Z","updated_at":"2018-05-29T11:49:36Z","closed_at":null,"merged_at":null,"merge_commit_sha":"f5da21ff5e9e3184ae7d6a29aac5191d7d1842f1","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201/commits","review_comments_url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201/comments","review_comment_url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/comments{/number}","comments_url":"https://api.github.com/repos/xpdAcq/xpdAn/issues/201/comments","statuses_url":"https://api.github.com/repos/xpdAcq/xpdAn/statuses/62cc30d1f2ae3b476bd70ba83a21ba08f6db8caa","head":{"label":"CJ-Wright:doc_pipeline","ref":"doc_pipeline","sha":"62cc30d1f2ae3b476bd70ba83a21ba08f6db8caa","user":{"login":"CJ-Wright","id":6740689,"avatar_url":"https://avatars3.githubusercontent.com/u/6740689?v=4","gravatar_id":"","url":"https://api.github.com/users/CJ-Wright","html_url":"https://github.com/CJ-Wright","followers_url":"https://api.github.com/users/CJ-Wright/followers","following_url":"https://api.github.com/users/CJ-Wright/following{/other_user}","gists_url":"https://api.github.com/users/CJ-Wright/gists{/gist_id}","starred_url":"https://api.github.com/users/CJ-Wright/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CJ-Wright/subscriptions","organizations_url":"https://api.github.com/users/CJ-Wright/orgs","repos_url":"https://api.github.com/users/CJ-Wright/repos","events_url":"https://api.github.com/users/CJ-Wright/events{/privacy}","received_events_url":"https://api.github.com/users/CJ-Wright/received_events","type":"User","site_admin":false},"repo":{"id":68024662,"name":"xpdAn","full_name":"CJ-Wright/xpdAn","owner":{"login":"CJ-Wright","id":6740689,"avatar_url":"https://avatars3.githubusercontent.com/u/6740689?v=4","gravatar_id":"","url":"https://api.github.com/users/CJ-Wright","html_url":"https://github.com/CJ-Wright","followers_url":"https://api.github.com/users/CJ-Wright/followers","following_url":"https://api.github.com/users/CJ-Wright/following{/other_user}","gists_url":"https://api.github.com/users/CJ-Wright/gists{/gist_id}","starred_url":"https://api.github.com/users/CJ-Wright/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CJ-Wright/subscriptions","organizations_url":"https://api.github.com/users/CJ-Wright/orgs","repos_url":"https://api.github.com/users/CJ-Wright/repos","events_url":"https://api.github.com/users/CJ-Wright/events{/privacy}","received_events_url":"https://api.github.com/users/CJ-Wright/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/CJ-Wright/xpdAn","description":null,"fork":true,"url":"https://api.github.com/repos/CJ-Wright/xpdAn","forks_url":"https://api.github.com/repos/CJ-Wright/xpdAn/forks","keys_url":"https://api.github.com/repos/CJ-Wright/xpdAn/keys{/key_id}","collaborators_url":"https://api.github.com/repos/CJ-Wright/xpdAn/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/CJ-Wright/xpdAn/teams","hooks_url":"https://api.github.com/repos/CJ-Wright/xpdAn/hooks","issue_events_url":"https://api.github.com/repos/CJ-Wright/xpdAn/issues/events{/number}","events_url":"https://api.github.com/repos/CJ-Wright/xpdAn/events","assignees_url":"https://api.github.com/repos/CJ-Wright/xpdAn/assignees{/user}","branches_url":"https://api.github.com/repos/CJ-Wright/xpdAn/branches{/branch}","tags_url":"https://api.github.com/repos/CJ-Wright/xpdAn/tags","blobs_url":"https://api.github.com/repos/CJ-Wright/xpdAn/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/CJ-Wright/xpdAn/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/CJ-Wright/xpdAn/git/refs{/sha}","trees_url":"https://api.github.com/repos/CJ-Wright/xpdAn/git/trees{/sha}","statuses_url":"https://api.github.com/repos/CJ-Wright/xpdAn/statuses/{sha}","languages_url":"https://api.github.com/repos/CJ-Wright/xpdAn/languages","stargazers_url":"https://api.github.com/repos/CJ-Wright/xpdAn/stargazers","contributors_url":"https://api.github.com/repos/CJ-Wright/xpdAn/contributors","subscribers_url":"https://api.github.com/repos/CJ-Wright/xpdAn/subscribers","subscription_url":"https://api.github.com/repos/CJ-Wright/xpdAn/subscription","commits_url":"https://api.github.com/repos/CJ-Wright/xpdAn/commits{/sha}","git_commits_url":"https://api.github.com/repos/CJ-Wright/xpdAn/git/commits{/sha}","comments_url":"https://api.github.com/repos/CJ-Wright/xpdAn/comments{/number}","issue_comment_url":"https://api.github.com/repos/CJ-Wright/xpdAn/issues/comments{/number}","contents_url":"https://api.github.com/repos/CJ-Wright/xpdAn/contents/{+path}","compare_url":"https://api.github.com/repos/CJ-Wright/xpdAn/compare/{base}...{head}","merges_url":"https://api.github.com/repos/CJ-Wright/xpdAn/merges","archive_url":"https://api.github.com/repos/CJ-Wright/xpdAn/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/CJ-Wright/xpdAn/downloads","issues_url":"https://api.github.com/repos/CJ-Wright/xpdAn/issues{/number}","pulls_url":"https://api.github.com/repos/CJ-Wright/xpdAn/pulls{/number}","milestones_url":"https://api.github.com/repos/CJ-Wright/xpdAn/milestones{/number}","notifications_url":"https://api.github.com/repos/CJ-Wright/xpdAn/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/CJ-Wright/xpdAn/labels{/name}","releases_url":"https://api.github.com/repos/CJ-Wright/xpdAn/releases{/id}","deployments_url":"https://api.github.com/repos/CJ-Wright/xpdAn/deployments","created_at":"2016-09-12T16:03:23Z","updated_at":"2016-09-14T21:41:55Z","pushed_at":"2018-05-29T00:01:53Z","git_url":"git://github.com/CJ-Wright/xpdAn.git","ssh_url":"git@github.com:CJ-Wright/xpdAn.git","clone_url":"https://github.com/CJ-Wright/xpdAn.git","svn_url":"https://github.com/CJ-Wright/xpdAn","homepage":null,"size":39443,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":null,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"xpdAcq:master","ref":"master","sha":"3072da48be2662e0844e853d5d0e8a8fcb4f0624","user":{"login":"xpdAcq","id":17029040,"avatar_url":"https://avatars3.githubusercontent.com/u/17029040?v=4","gravatar_id":"","url":"https://api.github.com/users/xpdAcq","html_url":"https://github.com/xpdAcq","followers_url":"https://api.github.com/users/xpdAcq/followers","following_url":"https://api.github.com/users/xpdAcq/following{/other_user}","gists_url":"https://api.github.com/users/xpdAcq/gists{/gist_id}","starred_url":"https://api.github.com/users/xpdAcq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xpdAcq/subscriptions","organizations_url":"https://api.github.com/users/xpdAcq/orgs","repos_url":"https://api.github.com/users/xpdAcq/repos","events_url":"https://api.github.com/users/xpdAcq/events{/privacy}","received_events_url":"https://api.github.com/users/xpdAcq/received_events","type":"Organization","site_admin":false},"repo":{"id":61145961,"name":"xpdAn","full_name":"xpdAcq/xpdAn","owner":{"login":"xpdAcq","id":17029040,"avatar_url":"https://avatars3.githubusercontent.com/u/17029040?v=4","gravatar_id":"","url":"https://api.github.com/users/xpdAcq","html_url":"https://github.com/xpdAcq","followers_url":"https://api.github.com/users/xpdAcq/followers","following_url":"https://api.github.com/users/xpdAcq/following{/other_user}","gists_url":"https://api.github.com/users/xpdAcq/gists{/gist_id}","starred_url":"https://api.github.com/users/xpdAcq/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/xpdAcq/subscriptions","organizations_url":"https://api.github.com/users/xpdAcq/orgs","repos_url":"https://api.github.com/users/xpdAcq/repos","events_url":"https://api.github.com/users/xpdAcq/events{/privacy}","received_events_url":"https://api.github.com/users/xpdAcq/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/xpdAcq/xpdAn","description":"Analysis Pipelines and Tools for XPD","fork":false,"url":"https://api.github.com/repos/xpdAcq/xpdAn","forks_url":"https://api.github.com/repos/xpdAcq/xpdAn/forks","keys_url":"https://api.github.com/repos/xpdAcq/xpdAn/keys{/key_id}","collaborators_url":"https://api.github.com/repos/xpdAcq/xpdAn/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/xpdAcq/xpdAn/teams","hooks_url":"https://api.github.com/repos/xpdAcq/xpdAn/hooks","issue_events_url":"https://api.github.com/repos/xpdAcq/xpdAn/issues/events{/number}","events_url":"https://api.github.com/repos/xpdAcq/xpdAn/events","assignees_url":"https://api.github.com/repos/xpdAcq/xpdAn/assignees{/user}","branches_url":"https://api.github.com/repos/xpdAcq/xpdAn/branches{/branch}","tags_url":"https://api.github.com/repos/xpdAcq/xpdAn/tags","blobs_url":"https://api.github.com/repos/xpdAcq/xpdAn/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/xpdAcq/xpdAn/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/xpdAcq/xpdAn/git/refs{/sha}","trees_url":"https://api.github.com/repos/xpdAcq/xpdAn/git/trees{/sha}","statuses_url":"https://api.github.com/repos/xpdAcq/xpdAn/statuses/{sha}","languages_url":"https://api.github.com/repos/xpdAcq/xpdAn/languages","stargazers_url":"https://api.github.com/repos/xpdAcq/xpdAn/stargazers","contributors_url":"https://api.github.com/repos/xpdAcq/xpdAn/contributors","subscribers_url":"https://api.github.com/repos/xpdAcq/xpdAn/subscribers","subscription_url":"https://api.github.com/repos/xpdAcq/xpdAn/subscription","commits_url":"https://api.github.com/repos/xpdAcq/xpdAn/commits{/sha}","git_commits_url":"https://api.github.com/repos/xpdAcq/xpdAn/git/commits{/sha}","comments_url":"https://api.github.com/repos/xpdAcq/xpdAn/comments{/number}","issue_comment_url":"https://api.github.com/repos/xpdAcq/xpdAn/issues/comments{/number}","contents_url":"https://api.github.com/repos/xpdAcq/xpdAn/contents/{+path}","compare_url":"https://api.github.com/repos/xpdAcq/xpdAn/compare/{base}...{head}","merges_url":"https://api.github.com/repos/xpdAcq/xpdAn/merges","archive_url":"https://api.github.com/repos/xpdAcq/xpdAn/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/xpdAcq/xpdAn/downloads","issues_url":"https://api.github.com/repos/xpdAcq/xpdAn/issues{/number}","pulls_url":"https://api.github.com/repos/xpdAcq/xpdAn/pulls{/number}","milestones_url":"https://api.github.com/repos/xpdAcq/xpdAn/milestones{/number}","notifications_url":"https://api.github.com/repos/xpdAcq/xpdAn/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/xpdAcq/xpdAn/labels{/name}","releases_url":"https://api.github.com/repos/xpdAcq/xpdAn/releases{/id}","deployments_url":"https://api.github.com/repos/xpdAcq/xpdAn/deployments","created_at":"2016-06-14T18:21:57Z","updated_at":"2018-05-29T00:57:21Z","pushed_at":"2018-05-29T00:57:23Z","git_url":"git://github.com/xpdAcq/xpdAn.git","ssh_url":"git@github.com:xpdAcq/xpdAn.git","clone_url":"https://github.com/xpdAcq/xpdAn.git","svn_url":"https://github.com/xpdAcq/xpdAn","homepage":"http://xpdacq.github.io/xpdAn/","size":7861,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":6,"mirror_url":null,"archived":false,"open_issues_count":25,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":6,"open_issues":25,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201"},"html":{"href":"https://github.com/xpdAcq/xpdAn/pull/201"},"issue":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/issues/201"},"comments":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/issues/201/comments"},"review_comments":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201/comments"},"review_comment":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/pulls/201/commits"},"statuses":{"href":"https://api.github.com/repos/xpdAcq/xpdAn/statuses/62cc30d1f2ae3b476bd70ba83a21ba08f6db8caa"}},"author_association":"MEMBER"}}
{"actor":{"display_login":"CJ-Wright"}}