Skip to content

Final edits to documentation website pre-manual #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This program is part of the DiffPy open-source project at Columbia
University and is available subject to the conditions and terms laid out below.

Copyright © 2009-2019, Trustees of Columbia University in the City of New York,
Copyright © 2009-2024, Trustees of Columbia University in the City of New York,
all rights reserved.

For more information please visit the diffpy web-page at http://diffpy.org or
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

project = "PDFmorph"
project_full = "diffpy.pdfmorph"
copyright = "2009-2019, Trustees of Columbia University in the City of New York, all rights reserved."
copyright = "2009-2024, Trustees of Columbia University in the City of New York, all rights reserved"
author = "Chris Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao (Timothy) Liu, S. Matthew Román, Simon J.L. Billinge"

# The full version, including alpha/beta/rc tags
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/source/license.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This program is part of the DiffPy open-source project at Columbia
University and is available subject to the conditions and terms laid out
below.

Copyright © 2009-2019, Trustees of Columbia University in the City of
Copyright © 2009-2024, Trustees of Columbia University in the City of
New York, all rights reserved.

For more information please visit the diffpy web-page at
Expand Down
9 changes: 5 additions & 4 deletions doc/manual/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,15 +211,16 @@ selected directory and plot resulting :math:`R_w` values from each morph.
3. After running this, we get chart of Rw values for each target file. However, this chart can
be a bit confusing to interpret. To get a more understandable plot, run ::

pdfmorph SrFe2As2_150K.gr . --multiple --temperature
pdfmorph SrFe2As2_150K.gr . --multiple --sort-by=temperature

The temperature option can be used when our files end in ``_#K.gr`` or ``_#K.cgr`` where ``#``
is a temperature (float value). When enabled, PDFmorph will plot Rw values against the temperatures.
This plots the Rw against the temperature parameter value provided at the top of each file.
Parameters are entries of the form ``<parameter_name> = <parameter_value>`` and are located
above the ``r`` versus ``gr`` table in each PDF file.
4. Between 192K and 198K, the Rw has a sharp increase, indicating that we may have a phase change.
To confirm, let us now apply morphs onto ``SrFe2As2_150K.gr`` with all other files in ``morphMultiple``
as targets ::

pdfmorph --scale=1 --stretch=0 SrFe2As2_150K.gr . --multiple --temperature
pdfmorph --scale=1 --stretch=0 SrFe2As2_150K.gr . --multiple --sort-by=temperature

Note that we are not applying a smear since it takes a long time to apply and does not significantly
change the Rw values in this example.
Expand Down
8 changes: 8 additions & 0 deletions doc/manual/source/tutorialfiles.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Download Tutorial Files Here
############################

Quick start tutorial data:
:download:`tutorialData.zip <../../../tutorial/tutorialData.zip>`

Extra tutorial data:
:download:`additionalData.zip <../../../tutorial/additionalData.zip>`
Binary file modified tutorial/additionalData.zip
Binary file not shown.