Skip to content

Commit 43911a4

Browse files
add back example in README.rst
1 parent 06adaf6 commit 43911a4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,27 @@ and run the following ::
104104

105105
pip install .
106106

107+
Example
108+
-------
109+
110+
Navigate to the directory that contains 1D diffraction patterns that you would like to process.
111+
Activate the conda environment (`conda activate diffpy.labpdfproc_env`) that contains the package and run the following command ::
112+
113+
labpdfproc <muD> <path/to/inputfile.txt>
114+
115+
Here replace <muD> with the value of muD for your sample
116+
and <path/to/inputfile.txt> with the path and filename of your input file.
117+
For example, if the uncorrected data case is called zro2_mo.xy and is in the current directory
118+
and it has a muD of 2.5 then the command would be ::
119+
120+
labpdfproc 2.5 zro2_mo.xy
121+
122+
Please type ::
123+
124+
labpdfproc --help
125+
126+
for more information on the available options.
127+
107128
Getting Started
108129
---------------
109130

0 commit comments

Comments
 (0)