Skip to content

Commit 7663bfa

Browse files
author
Andrew Yang
committed
Some rewording
1 parent 051f368 commit 7663bfa

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

doc/source/mod_pdfmorph_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
diffpy.pdfmorph.pdfmorph_api
2-
#####################
2+
############################
33

44
.. automodule:: diffpy.pdfmorph.pdfmorph_api
55
:members:

doc/source/quickstart.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,12 @@ We can use PDFmorph to morph a bulk material PDF to simulate these shape effects
194194
Currently, the supported nanoparticle shapes include: spheres and spheroids.
195195

196196
* Within the ``additionalData`` directory, ``cd`` into the ``morphshape`` subdirectory.
197-
* Inside, you will find a sample Ni bulk material PDF ``Ni_bulk.gr``.
197+
Inside, you will find a sample Ni bulk material PDF ``Ni_bulk.gr``.
198198
This PDF is from `"Atomic Pair Distribution Function Analysis: A primer" <https://github.com/Billingegroup/pdfttp_data/>`_.
199-
* There are also multiple ``.cgr`` files with calculated Ni nanoparticles of various shapes..
199+
There are also multiple ``.cgr`` files with calculated Ni nanoparticle PDFs.
200+
201+
* Let us apply various shape effect morphs on the bulk material to reproduce these calculated PDFs.
202+
200203
* Spherical Shape
201204
1. The ``Ni_nano_sphere.cgr`` file contains a generated spherical nanoparticle with unknown radius.
202205
First, let us plot ``Ni_blk.gr`` against ``Ni_nano_sphere.cgr`` ::
@@ -219,7 +222,7 @@ Currently, the supported nanoparticle shapes include: spheres and spheroids.
219222

220223
pdfmorph Ni_bulk.gr Ni_nano_sphere.cgr --radius=11.2 -a
221224

222-
5. We can see that the Rw value has decreased from before. Run without the ``-a`` tag to refine ::
225+
5. We can see that the Rw value has significantly decreased from before. Run without the ``-a`` tag to refine ::
223226

224227
pdfmorph Ni_bulk.gr Ni_nano_sphere.cgr --radius=11.2
225228

0 commit comments

Comments
 (0)