Skip to content

Commit 26fabef

Browse files
committed
docs: fix typos, viewer list, and news
1 parent 1c8db6e commit 26fabef

File tree

3 files changed

+43
-11
lines changed

3 files changed

+43
-11
lines changed

doc/source/extras.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,11 @@ PDFgui can visualize 3D structures by displaying them with an external visualiza
5555
format in the “Edit → Preferences” menu in PDFgui. The structure plotting feature has
5656
been tested with the following programs:
5757

58-
============================================ ===============================
59-
AtomEyeAtomEye structure viewer, XCFG format http://li.mit.edu/A/Graphics/A/
60-
============================================ ===============================
61-
PyMOLPyMOL structure viewer, PDB format https://www.pymol.org
62-
============================================ ===============================
58+
=================================== ===============================
59+
VESTA structure viewer https://jp-minerals.org/vesta/
60+
=================================== ===============================
61+
PyMOL structure viewer, PDB format https://www.pymol.org
62+
=================================== ===============================
6363

6464
**A note for AtomEye users:**
6565

doc/source/tutorial.rst

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Oxford University Press, 2024. URL: https://global.oup.com/academic/product/atom
2424
PDFgui layout
2525
=============
2626

27-
First, Open ``pdfgui``. Instructions for doing this depend on your system, but an example would be to open a terminal, activate your pdfgui conda environment, and type ``pdfgui`` at the prompt, or to double-click a project file on windows.
27+
First, open ``pdfgui``. Instructions for doing this depend on your system, but an example would be to open a terminal, activate your pdfgui conda environment, and type ``pdfgui`` at the prompt, or to double-click a project file on windows.
2828

2929
Once PDFgui is invoked, a PDFgui window comes up. Its layout consists of a
3030
``Menu Bar``, a ``Tool Bar``, and a set of four panes. The menu bar contains
@@ -284,7 +284,7 @@ Procedure:
284284
The project can be saved at any stage in its present configuration through choice of Save Project as or Save Project as appropriate from the ``File`` drop-down menu. The PDFgui project file has “ddp” extension. In addition to saving a project, various parts of the project, both structure related and data related, can be exported to external files by making an appropriate selection from the ``Phases`` and ``Data`` drop-down menus. The phases (starting or converged) can be saved in one of many formats. The model PDF profile can be exported through ``Data`` menu and will be saved as a five-column “.fgr” file. The first four columns are :math:`r, G(r), dr, \text{and }dG(r)`, and the fifth column is the difference curve between the data and the model. Note that the model PDF and the difference are only calculated within the user-specified fitting range.
285285

286286
======================================================
287-
Lesson 2: Build structure model using crystal symmetry
287+
Lesson 2: Building structure model using crystal symmetry
288288
======================================================
289289

290290
In the previous example the initial structure was defined by an existing file. However, PDFgui makes it very easy to build a structure model from scratch and constrain it with arbitrary crystal symmetry.
@@ -327,8 +327,40 @@ In the previous example the initial structure was defined by an existing file. H
327327

328328
5. Continue the fit as in Lesson 1.
329329

330+
331+
==========================================
332+
Lesson 3: Calculating PDF from a structure
333+
==========================================
334+
335+
There is often a need for obtaining a calculated PDF profile for a given structure instead
336+
of performing a fit. Suppose that we have a Ni structure populating a fit tree, and that we would like to
337+
calculate Ni PDF using neutron radiation.
338+
339+
1. Highlight the Ni structure on fit tree.
340+
2. Either right-click and select Insert Calculation or select New Calculation from “Calculation” menu.
341+
3. select "Neutron scatterer type", choose 0.01 for the r-grid size, and use 0.08 and 25.0 for resolution and maximum momentum transfer parameters respectively.
342+
343+
344+
345+
.. figure:: images/fig3-03.png
346+
:align: center
347+
:figwidth: 100%
348+
349+
Figure 3.2: An example of the calculation configuration panel.
350+
351+
Conditions to be specified include radiation type, calculation
352+
range and corresponding r-grid size, as well as instrument resolution and maximum momentum transfer parameters. For the later two, the default values of parameters could be
353+
used, or values could be specified that closely mimic the experimental conditions on some
354+
particular instrument of interest.
355+
356+
4. Press "gear" icon |gear| in the tool bar. Alternatively select Run Selected Calculation from the “Calculations” menu.
357+
358+
5. Click the "plot" icon |plot| in the toolbar.
359+
360+
6. To export the calculated PDF, use the Export Selected Calculation choice on the “Calculations” menu.
361+
330362
=============================
331-
Lesson 3: Multi-stage fitting
363+
Lesson 4: Multi-stage fitting
332364
=============================
333365

334366
Learn how to string together fits.
@@ -358,7 +390,7 @@ Learn how to string together fits.
358390
:align: center
359391
:figwidth: 100%
360392

361-
Figure 3.4: An example of linked fits.
393+
Figure 3.3: An example of linked fits.
362394

363395
5. Add more fit parameters:
364396
1. Select the "Constraints" tab of the `Ni.stru` phase below "Fit 1_copy".

news/rm_texinfo.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
**Added:**
22

3-
* <news item>
3+
* manual information is added into online docs.
44

55
**Changed:**
66

@@ -12,7 +12,7 @@
1212

1313
**Removed:**
1414

15-
* <news item>
15+
* manual.
1616

1717
**Fixed:**
1818

0 commit comments

Comments
 (0)