You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: products/pdfmorph.rst
+58-51Lines changed: 58 additions & 51 deletions
Original file line number
Diff line number
Diff line change
@@ -8,28 +8,30 @@ Overview
8
8
========
9
9
10
10
.. note::
11
-
The PDFmorph application has a Command Line Interface. If you are
12
-
unfamiliar with the terminal or windows command prompt, it is recommended
13
-
that you consult online resources and become somewhat familiar before
14
-
using PDFmorph.
15
-
16
-
PDFmorph is a Python software package designed to increase the insight researchers
17
-
can obtain from measured atomic pair distribution functions (PDFs) in a model
18
-
independent way. The program was designed to help a researcher answer the question:
19
-
"has my material undergone a phase transition between these two measurements?"
20
-
21
-
PDFmorph makes use of several data manipulation techniques to correct for benign
22
-
effects such as thermal expansion and increased thermal motion before computing and
23
-
plotting a difference curve between two PDFs. One PDF is identified as the "target"
24
-
PDF and the second is "morphed" by "stretching", "smearing", and "scaling". PDFmorph
25
-
will vary amplitude of morphing transformations to obtain the best fit between
26
-
morphed and target PDFs, then plot them along with the difference curve plotted
11
+
The PDFmorph application has a Command Line Interface. If you
12
+
are unfamiliar with the terminal or windows command prompt, it
13
+
is recommended that you consult online resources and become
14
+
somewhat familiar before using PDFmorph.
15
+
16
+
PDFmorph is a Python software package designed to increase the insight
17
+
researchers can obtain from measured atomic pair distribution functions
18
+
(PDFs) in a model-independent way. The program was designed to help a
19
+
researcher answer the question: Has my material undergone a phase
20
+
transition between these two measurements?
21
+
22
+
PDFmorph makes use of several data manipulation techniques to correct
23
+
for benign effects such as thermal expansion and increased thermal
24
+
motion before computing and plotting a difference curve between two PDFs.
25
+
One PDF is identified as the "target" PDF and the second is "morphed"
26
+
by "stretching", "smearing", and "scaling". PDFmorph will vary amplitude
27
+
of morphing transformations to obtain the best fit between morphed and
28
+
target PDFs, then plot them along with the difference curve plotted
27
29
below.
28
30
29
31
There are also a few other morphing transformations in the program.
30
32
31
-
Finally, we note that PDFmorph should work on other spectra that are not PDFs,
32
-
though it has not been extensively tested beyond the PDF.
33
+
Finally, we note that PDFmorph should work on other spectra that are
34
+
not PDFs, though it has not been extensively tested beyond the PDF.
33
35
34
36
.. PDFmorph will soon be included in :doc:`xPDFsuite <xPDFsuite>`, a powerful end-to-end software for X-ray PDF analysis. xPDFsuite is designed for flexible, high throughput PDF analyses and contains many features for interrogating, comparing, and modeling data as well as simply doing data reduction.
35
37
@@ -46,53 +48,60 @@ Installation
46
48
By downloading and using this software, you are agreeing to the conditions
47
49
specified in the :doc:`software license <pdfmorph_license>`.
48
50
49
-
PDFmorph is distributed as a software package for `Anaconda Python <https://www.continuum.io>`__.
50
-
PDFmorph is available for all operating systems supported by Anaconda, namely for
51
-
32 and 64-bit Linux, Mac OS X, and 32 and 64-bit Windows.
51
+
PDFmorph is distributed using conda. To install software using conda
52
+
you will first have to download and install ``Anaconda`` or ``mini-conda``
53
+
from `continuum <https://www.continuum.io>`__.
52
54
53
-
As a prerequisite for PDFmorph installation, download and install Anaconda
54
-
from |anaconda-download|.
55
+
PDFmorph is available for all operating systems supported by Anaconda,
56
+
namely for 32 and 64-bit Linux, Mac OS X, and 32 and 64-bit Windows.
55
57
56
58
.. note::
57
-
PDFmorph is a software which operates on any version of Python 3. Anaconda
58
-
should install the latest version of Python by default, but in case you
59
-
already use Anaconda for a prior release of Python, create a separate
60
-
Anaconda environment *py3x* which will provide your preferred version of
61
-
Python 3 (substitute x for your preferred release) instead of Python 2.7
62
-
or earlier. ::
59
+
We recommend that you run PDFmorph in a Python 3 conda virtual
60
+
environment. With Anaconda or mini-conda installed on your system,
61
+
first create the virtual environment by typing ::
62
+
63
+
conda create --name=py3 python=3
63
64
64
-
conda create --name=py3x python=3.x
65
-
conda activate py3x
65
+
You can give the environment any name you like but it should
66
+
have some Python version 3 installed. You only need to create
67
+
the environment once, but every time you want to use PDFmorph
68
+
you will have to activate the environment in which it is installed
69
+
by typing ::
70
+
71
+
source activate py3
66
72
67
-
On Windows use just ``activate py3x``. Make sure that *py3x* environment is
68
-
activated in your shell prior to running the "install" or "update" commands
69
-
below.
73
+
on Mac/Linux, or ::
70
74
71
-
PDFmorph is available from the "conda-forge" channel of Anaconda packages. Open a
72
-
*Terminal* window or *Anaconda Command Prompt* on Windows and install PDFmorph
73
-
using the :program:`conda` command ::
75
+
activate py3
76
+
77
+
on Windows.
78
+
79
+
PDFmorph is available from the "conda-forge" channel of Anaconda packages.
80
+
Open a *Terminal* window or *Anaconda Command Prompt* on Windows and
81
+
install PDFmorph using the :program:`conda` command ::
74
82
75
83
conda config --add channels conda-forge
76
84
conda install diffpy.pdfmorph
77
85
78
-
And it should be installed! To make sure that installation has completed correctly,
79
-
run the following command from your relevant conda environment ::
86
+
And it should be installed! To make sure that installation has completed
87
+
correctly, run the following command from your relevant conda environment ::
80
88
81
89
pdfmorph --version
82
90
83
-
If installed correctly, this command should return PDFmorph's current version number.
91
+
This command should return PDFmorph's current version number.
84
92
85
93
86
94
PDFmorph Updates
87
95
================
88
96
89
-
The Anaconda package sustem makes it easy to prepare and distribute software
90
-
packages and bugfixes. To update the lates version of PDFmorph use ::
97
+
The Anaconda package system makes it easy to prepare and distribute
98
+
software packages and bugfixes. To update the latest version of PDFmorph,
99
+
use ::
91
100
92
101
conda update diffpy.pdfmorph
93
102
94
-
With other Python distributions, the program can be updated to the latest version
95
-
as follows ::
103
+
With other Python distributions, the program can be updated to the
104
+
latest version with ::
96
105
97
106
easy_install --upgrade diffpy.pdfmorph
98
107
@@ -106,14 +115,12 @@ Documentation/Help
106
115
0.0.1 - latest
107
116
----------------------
108
117
109
-
* User manual (available in HTML and PDF) to be made available soon
110
-
* Installation instructions to come
111
-
* Tutorial files will be made available soon
118
+
* User manual (available in HTML and PDF)
119
+
* Installation instructions
120
+
* `Sample PDF files <https://github.com/diffpy/diffpy.pdfmorph/tree/master/tests/testdata>`__
121
+
* Tutorial
112
122
* Please, join the :doc:`community forum <../community>` for tips,
0 commit comments