Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 07f11c3

Browse files
committedApr 22, 2025·
docs: add docs for tools, update readme for --mud
1 parent 591241b commit 07f11c3

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed
 

‎README.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ Example
110110
Navigate to the directory that contains 1D diffraction patterns that you would like to process.
111111
Activate the conda environment (`conda activate diffpy.labpdfproc_env`) that contains the package and run the following command ::
112112

113-
labpdfproc <muD> <path/to/inputfile.txt>
113+
labpdfproc <path/to/inputfile.txt> --mud <muD>
114114

115115
Here replace <muD> with the value of muD for your sample
116116
and <path/to/inputfile.txt> with the path and filename of your input file.
117117
For example, if the uncorrected data case is called zro2_mo.xy and is in the current directory
118118
and it has a muD of 2.5 then the command would be ::
119119

120-
labpdfproc 2.5 zro2_mo.xy
120+
labpdfproc zro2_mo.xy --mud 2.5
121121

122122
Please type ::
123123

‎news/tools-doc.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
**Added:**
22

3-
* <news item>
3+
* Utility and example documentation for ``tools`` module.
44

55
**Changed:**
66

7-
* <news item>
7+
* Readme: muD now requires the ``--mud`` flag instead of a required argument.
88

99
**Deprecated:**
1010

‎src/diffpy/labpdfproc/tools.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -457,13 +457,13 @@ def preprocessing_args(args):
457457
The updated argparse Namespace with arguments preprocessed.
458458
"""
459459
args = set_mud(args)
460-
args = load_package_info(args)
461-
args = load_user_info(args)
462460
args = set_input_lists(args)
463461
args = set_output_directory(args)
464462
args = set_wavelength(args)
465463
args = set_xtype(args)
466464
args = load_user_metadata(args)
465+
args = load_user_info(args)
466+
args = load_package_info(args)
467467
return args
468468

469469

0 commit comments

Comments
 (0)
Please sign in to comment.