Skip to content

Commit 92b5801

Browse files
[pre-commit.ci] auto fixes from pre-commit hooks
1 parent f0b08f1 commit 92b5801

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ REQUIREMENTS
7575
------------------------------------------------------------------------
7676

7777
PDFmorph is currently run from the command line, which requires opening
78-
and typing into a terminal window or Windows command prompt. It is
79-
recommended that you consult online resources and become somewhat
78+
and typing into a terminal window or Windows command prompt. It is
79+
recommended that you consult online resources and become somewhat
8080
familiar before using PDFmorph.
8181

8282
PDFmorph can be run with Python 3.10 or higher. It makes use of several third party
@@ -160,7 +160,7 @@ Support and Contribute
160160

161161
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.pdfmorph. Please join the diffpy.pdfmorph users community by joining the Google group. The diffpy.pdfmorph project welcomes your expertise and enthusiasm!
162162

163-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfmorph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfmorph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
163+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.pdfmorph/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.pdfmorph/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
164164

165165
Feel free to fork the project and contribute. To install diffpy.pdfmorph
166166
in a development mode, with its sources being directly used by Python

TUTORIAL.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,5 +183,5 @@ Enjoy the software!
183183
Bug Reports
184184
-----------
185185

186-
Please enjoy using our software! If you come accross any bugs in the
186+
Please enjoy using our software! If you come accross any bugs in the
187187
application, please report them to [email protected]

doc/source/index.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,33 @@ diffpy.pdfmorph - Tools for manipulating and comparing PDF profiles.
1010
Introduction
1111
++++++++++++
1212

13-
``PDFmorph`` is a Python package that increases the insight
14-
researchers can obtain from measured atomic pair distribution functions
15-
(PDFs) in a model-independent way. It was designed to help a
16-
researcher answer the question: "Has my material undergone a phase
13+
``PDFmorph`` is a Python package that increases the insight
14+
researchers can obtain from measured atomic pair distribution functions
15+
(PDFs) in a model-independent way. It was designed to help a
16+
researcher answer the question: "Has my material undergone a phase
1717
transition between these two measurements?"
1818

19-
One approach is to compare the two PDFs in a plot and view the
20-
difference curve underneath. However, significant signal can be seen in
21-
the difference curve from benign effects such as thermal expansion (peak
22-
shifts) and increased thermal motion (peak broadening) or a change in
23-
scale due to differences in incident flux, for example. ``PDFmorph`` will
24-
do its best to correct for these benign effects before computing and
25-
plotting the difference curve. One measured PDF (typically that
26-
collected under higher temperature) is identified as the target PDF and
19+
One approach is to compare the two PDFs in a plot and view the
20+
difference curve underneath. However, significant signal can be seen in
21+
the difference curve from benign effects such as thermal expansion (peak
22+
shifts) and increased thermal motion (peak broadening) or a change in
23+
scale due to differences in incident flux, for example. ``PDFmorph`` will
24+
do its best to correct for these benign effects before computing and
25+
plotting the difference curve. One measured PDF (typically that
26+
collected under higher temperature) is identified as the target PDF and
2727
the second PDF is then morphed by "stretching" (changing the r-axis to
28-
simulate a uniform lattice expansion), "smearing" (broadening peaks
29-
through a uniform convolution to simulate increased thermal motion), and
30-
"scaling" (self-explanatory). PDFmorph will vary the amplitude of the
31-
morphing transformations to obtain the best fit between the morphed and
32-
the target PDFs, then plot them on top of each other with the difference
28+
simulate a uniform lattice expansion), "smearing" (broadening peaks
29+
through a uniform convolution to simulate increased thermal motion), and
30+
"scaling" (self-explanatory). PDFmorph will vary the amplitude of the
31+
morphing transformations to obtain the best fit between the morphed and
32+
the target PDFs, then plot them on top of each other with the difference
3333
plotted below.
3434

3535
There are also a few other morphing transformations in the program.
3636
If no morphing transformation is specified, ``PDFmorph`` will return just
3737
the plotted PDFs.
3838

39-
Finally, we note that though ``PDFmorph`` should work on other spectra
39+
Finally, we note that though ``PDFmorph`` should work on other spectra
4040
that are not PDFs, it has not been extensively tested beyond the PDF.
4141

4242
To get started, please download our :download:`user manual <../manual/pdfmorph.pdf>`
@@ -46,8 +46,8 @@ or visit the :ref:`quick_start`.
4646
Authors
4747
=======
4848

49-
``PDFmorph`` is developed by members of the Billinge Group at
50-
Columbia University and Brookhaven National Laboratory including
49+
``PDFmorph`` is developed by members of the Billinge Group at
50+
Columbia University and Brookhaven National Laboratory including
5151
Christopher L. Farrow, Christopher J. Wright, Pavol Juhás, Chia-Hao
5252
(Timothy) Liu, Andrew Yang, and Simon J. L. Billinge.
5353

doc/source/license.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ OPEN SOURCE LICENSE AGREEMENT
99
=============================
1010
BSD 3-Clause License
1111

12-
Copyright (c) 2024, The Trustees of Columbia University in
12+
Copyright (c) 2024, The Trustees of Columbia University in
1313
the City of New York.
14-
All Rights Reserved.
14+
All Rights Reserved.
1515

1616
Redistribution and use in source and binary forms, with or without
1717
modification, are permitted provided that the following conditions are met:

requirements/README.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# This directory is where you should place your project dependencies.
44
# "pip.txt" should contain all required packages not available on conda.
5-
# All other files should contain only packages available to download from conda.
5+
# All other files should contain only packages available to download from conda.
66
# build.txt should contain all packages required to build (not run) the project.
77
# run.txt should contain all packages (including optional packages) required for a user to run the program.
88
# test.txt should contain all packages required for the testing suite and to ensure all tests pass.

0 commit comments

Comments
 (0)