Skip to content

Commit 6fdf05c

Browse files
committed
Indication to print
1 parent dccfd1a commit 6fdf05c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/source/morphpy.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Python Morphing Functions
2727

2828
3. Finally, we run the ``morph`` function ::
2929

30-
morph_info, morph_table = morph("darkSub_rh20_C_01.gr", "darkSub_rh20_C_44.gr", scale=0.8, smear=-0.08, stretch=0.5, rmin=1.5, rmax=30)
30+
morph_info, morph_table = morph("darkSub_rh20_C_01.gr", "darkSub_rh20_C_44.gr", scale=0.8, smear=-0.08, stretch=0.005, rmin=1.5, rmax=30)
3131

3232
* The ``morph`` function takes in two file names (or paths). You can also provide various parameters
3333
for morphing (see the Full Parameter List below).
@@ -38,7 +38,8 @@ Python Morphing Functions
3838

3939
* ``morph_info`` contains all morphs as keys (e.g. ``"scale"``, ``"stretch"``, ``"smear"``) with
4040
the optimized morphing parameters found by ``diffpy.morph`` as values. ``morph_info`` also contains
41-
the Rw and Pearson correlation coefficients found post-morphing.
41+
the Rw and Pearson correlation coefficients found post-morphing. Try printing ``print(morph_info)``
42+
and compare the values stored in this dictionary to those given by the CLI output!
4243
* ``morph_table`` is a two-column array of the morphed function interpolated onto the grid of the
4344
target function (e.g. in our example, it returns the contents of `darkSub_rh20_C_01.gr` after
4445
the morphs are applied interpolated onto the grid of `darkSub_rh20_C_44.gr`).
@@ -61,7 +62,7 @@ Python Morphing Functions
6162
9. Notice that the two-column format of the input to ``morph_arrays`` is the same as the
6263
output of ``morph`` and ``morph_arrays``. It is VERY IMPORTANT that the data is in two-column format
6364
rather than the traditional two-row format. This is to reflect the file formats conventionally
64-
used to store PDFs.
65+
used to store PDFs. Again, try printing ``print(morph_info)`` and compare!
6566
10. For a full list of parameters used by (both) ``morph`` and ``morph_arrays``, see the Full Parameter List
6667
section below.
6768

0 commit comments

Comments
 (0)