Skip to content

Commit 429e44a

Browse files
committed
Reordering
1 parent 12189ce commit 429e44a

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

doc/manual/source/quickstart.rst

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,50 @@ Tutorials for these additional functionalities are included below. Additional
189189
files for these tutorials can be downloaded
190190
:download:`here <../../../tutorial/additionalData.zip>`.
191191

192+
Performing a Sequence of Morphs
193+
-------------------------------
194+
195+
It may be useful to morph a PDF against multiple targets:
196+
for example, you may want to morph a PDF against a sequence of PDFs measured
197+
at various temepratures to determine whether a phase change has occured.
198+
PDFmorph currently allows users to morph a PDF against all files in a
199+
selected directory and plot resulting :math:`R_w` values from each morph.
200+
201+
1. Within the ``additionalData`` directory, ``cd`` into the ``morphsequence`` directory.
202+
Inside, you will find multiple PDFs of :math:`SrFe_2As_2` measured at various temperatures.
203+
These PDFs are from `"Atomic Pair Distribution Function Analysis: A primer" <https://github.com/Billingegroup/pdfttp_data/>`_.
204+
2. Let us start by getting the Rw of ``SrFe2As2_150K.gr`` compared to all other files in the
205+
directory. Run ::
206+
207+
pdfmorph SrFe2As2_150K.gr . --sequence
208+
209+
The sequence tag indicates we are comparing PDF file (first input) against all PDFs in
210+
a directory (second input). Our choice of file was ``SeFe2As2_150K.gr``
211+
and directory was the cwd, which should be ``morphsequence``.
212+
3. After running this, we get chart of Rw values for each target file. However, this chart can
213+
be a bit confusing to interpret. To get a more understandable plot, run ::
214+
215+
pdfmorph SrFe2As2_150K.gr . --sequence --temperature
216+
217+
The temperature option can be used when our files end in ``_#K.gr`` or ``_#K.cgr`` where ``#``
218+
is a temperature (float value). When enabled, PDFmorph will plot Rw values against the temperatures.
219+
4. Between 192K and 198K, the Rw has a sharp increase, indicating that we may have a phase change.
220+
To confirm, let us now apply morphs onto ``SrFe2As2_150K.gr`` with all other files in ``morphsequence``
221+
as targets ::
222+
223+
pdfmorph --scale=1 --stretch=0 SrFe2As2_150K.gr . --sequence --temperature
224+
225+
Note that we are not applying a smear since it takes a long time to apply and does not significantly
226+
change the Rw values in this example.
227+
5. We should now see a sharper increase in Rw between 192K and 198K.
228+
6. Go back to the terminal to see optimized morphing parameters from each morph.
229+
7. On the morph with ``SrFe2As2_192K.gr`` as target, ``scale = 0.972085`` and ``stretch = 0.000508``
230+
and with ``SrFe2As2_198K.gr`` as target, ``scale = 0.970276`` and ``stretch = 0.000510``.
231+
These are very similar, meaning that thermal lattice expansion (accounted for by ``stretch``)
232+
is not occurring. This, coupled with the fact that the Rw significantly increases suggests
233+
a phase change in this temperature regime. (In fact, :math:`SrFe_2As_2` does transition from
234+
orthorhombic at lower temperature to tetragonal at higher temperature!)
235+
192236
Nanoparticle Shape Effects
193237
--------------------------
194238

@@ -247,50 +291,6 @@ Currently, the supported nanoparticle shapes include: spheres and spheroids.
247291
There is also support for morphing from a nanoparticle to a bulk. When applying the inverse morphs,
248292
it is recommended to set ``--rmax=psize`` where ``psize`` is the longest diameter of the nanoparticle.
249293

250-
Performing a Sequence of Morphs
251-
-------------------------------
252-
253-
It may be useful to morph a PDF against multiple targets:
254-
for example, you may want to morph a PDF against a sequence of PDFs measured
255-
at various temepratures to determine whether a phase change has occured.
256-
PDFmorph currently allows users to morph a PDF against all files in a
257-
selected directory and plot resulting :math:`R_w` values from each morph.
258-
259-
1. Within the ``additionalData`` directory, ``cd`` into the ``morphsequence`` directory.
260-
Inside, you will find multiple PDFs of :math:`SrFe_2As_2` measured at various temperatures.
261-
These PDFs are from `"Atomic Pair Distribution Function Analysis: A primer" <https://github.com/Billingegroup/pdfttp_data/>`_.
262-
2. Let us start by getting the Rw of ``SrFe2As2_150K.gr`` compared to all other files in the
263-
directory. Run ::
264-
265-
pdfmorph SrFe2As2_150K.gr . --sequence
266-
267-
The sequence tag indicates we are comparing PDF file (first input) against all PDFs in
268-
a directory (second input). Our choice of file was ``SeFe2As2_150K.gr``
269-
and directory was the cwd, which should be ``morphsequence``.
270-
3. After running this, we get chart of Rw values for each target file. However, this chart can
271-
be a bit confusing to interpret. To get a more understandable plot, run ::
272-
273-
pdfmorph SrFe2As2_150K.gr . --sequence --temperature
274-
275-
The temperature option can be used when our files end in ``_#K.gr`` or ``_#K.cgr`` where ``#``
276-
is a temperature (float value). When enabled, PDFmorph will plot Rw values against the temperatures.
277-
4. Between 192K and 198K, the Rw has a sharp increase, indicating that we may have a phase change.
278-
To confirm, let us now apply morphs onto ``SrFe2As2_150K.gr`` with all other files in ``morphsequence``
279-
as targets ::
280-
281-
pdfmorph --scale=1 --stretch=0 SrFe2As2_150K.gr . --sequence --temperature
282-
283-
Note that we are not applying a smear since it takes a long time to apply and does not significantly
284-
change the Rw values in this example.
285-
5. We should now see a sharper increase in Rw between 192K and 198K.
286-
6. Go back to the terminal to see optimized morphing parameters from each morph.
287-
7. On the morph with ``SrFe2As2_192K.gr`` as target, ``scale = 0.972085`` and ``stretch = 0.000508``
288-
and with ``SrFe2As2_198K.gr`` as target, ``scale = 0.970276`` and ``stretch = 0.000510``.
289-
These are very similar, meaning that thermal lattice expansion (accounted for by ``stretch``)
290-
is not occurring. This, coupled with the fact that the Rw significantly increases indicates we
291-
very likely have a phase change in this region. (In fact, :math:`SrFe_2As_2` does transition from
292-
orthorhombic at lower temperature to tetragonal at higher temperature!)
293-
294294
Bug Reports
295295
===========
296296

0 commit comments

Comments
 (0)