Skip to content

Commit

Permalink
Update example notebook 1
Browse files Browse the repository at this point in the history
Add links to LightForm Wiki
Add brief description of pyFAI
  • Loading branch information
christopher-daniel committed Aug 14, 2020
1 parent be9897a commit f1b28a3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tutorial notebooks/1 - Basic analysis workflow.ipynb
Expand Up @@ -17,7 +17,7 @@
"\n",
"## 0.2. Data format\n",
"\n",
"These scripts read data from text files. The format of the file is the standard format output by DAWN (https://dawnsci.org/about/). DAWN is a data analysis and processing program commonly used for processing synchrotron data. \n",
"These scripts read data from text files. The format of the file is the standard format output by [DAWN](https://dawnsci.org/about/). DAWN is a data analysis and processing program commonly used for processing synchrotron data. An explanation of how to **cake** diffraction pattern images using DAWN is provided on our Research Group's Wiki page - [LightForm Wiki - DAWN Tutorial](https://lightform-group.github.io/wiki/tutorials/sxrd-caking). The text files can also be produced using a python script and the python package [pyFAI](https://pyfai.readthedocs.io/en/latest/). An explanation of how to cake the data using pyFAI is also provided on our Wiki page - [LightForm Wiki - pyFAI Tutorial](https://lightform-group.github.io/wiki/tutorials/sxrd-caking-dioptas) and the scripts we use to do this are available on GitHub - [pyFAI caking script](https://github.com/LightForm-group/pyFAI-integration-caking).\n",
"\n",
"The data file does not have any column headings or title line. The first column of the data file is the two theta diffraction angle. Each subsequent column corresponds to a cake of intensity data from the diffraction pattern, starting with the first cake.\n",
"\n",
Expand All @@ -27,7 +27,7 @@
"\n",
"<img src=\"images/cake_numbering.svg\" alt=\"Illustration of cake numbering\" title=\"Illustration of cake numbering\" width=\"300\" />\n",
" \n",
"By convention the **cakes** in the input data files are ordered clockwise starting with the first cake, but no information is provided about the orientation of the first cake relative to \"up\" or North on a 2D projection. This means the angle of the first cake must be provided as part of the analysis.\n",
"By convention the **cakes** in the input data files are ordered clockwise starting with the first cake, although `xrdfit` can also handle data ordered anti-clockwise. However, no information is provided about the orientation of the first cake relative to \"up\" or North on a 2D projection. This means the angle of the first cake must be provided as part of the analysis.\n",
"\n",
"\n",
"## 0.3. Peak model fit\n",
Expand Down Expand Up @@ -688,7 +688,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.2"
"version": "3.6.8"
},
"pycharm": {
"stem_cell": {
Expand Down

0 comments on commit f1b28a3

Please sign in to comment.