Skip to content

Commit 6bd7d9e

Browse files
fix related docs, add news
1 parent 6e0e447 commit 6bd7d9e

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

doc/source/examples/labpdfprocapp_example.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,20 +59,16 @@ We will now continue using ``zro2_mo.xy`` as the example input throughout the re
5959
labpdfproc zro2_mo.xy --mud 2.5
6060
# Option 2: From a z-scan file
6161
labpdfproc zro2_mo.xy -z zscan.xy
62-
# Option 3: Using sample mass density
63-
labpdfproc zro2_mo.xy -d ZrO2,17.45,1.2
64-
# Option 4: Using packing fraction
65-
labpdfproc zro2_mo.xy -p ZrO2,17.45,0.2
62+
# Option 3: Theoretical estimation
63+
labpdfproc zro2_mo.xy -t ZrO2,17.45,1.2,1.0
6664
6765
Note that you can only use one method at a time. The following examples are not allowed:
6866

6967
.. code-block:: python
7068
7169
labpdfproc zro2_mo.xy --mud 2.5 -z zscan.xy
72-
labpdfproc zro2_mo.xy --mud 2.5 -d ZrO2,17.45,1.2
70+
labpdfproc zro2_mo.xy --mud 2.5 -t ZrO2,17.45,1.2,1.0
7371
74-
If the packing fraction option is not supported at the moment, you can approximate the sample mass density as:
75-
``mass density = packing fraction * material density``, where the material density can be looked up manually.
7672
7773
7874
5. You can specify the wavelength in two ways:

doc/source/examples/tools_example.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ You can do this in one of the following four ways:
1919
args = Namespace(mud=2)
2020
# Option 2: From a z-scan file
2121
args = Namespace(z_scan_file="zscan.xy")
22-
# Option 3: Using sample mass density
23-
args = Namespace(theoretical_from_density="ZrO2,17.45,1.2")
24-
# Option 4: Using packing fraction
25-
args = Namespace(theoretical_from_packing="ZrO2,17.45,0.3")
22+
# Option 3: Theoretical estimation
23+
args = Namespace(theoretical_estimation="ZrO2,17.45,1.2,1.0")
2624
# Set and view the computed mu*D value
2725
args = set_mud(args)
2826
print(args.mud)

news/remove-packing-fraction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
**Added:**
22

3-
* <news item>
3+
* no news added - corrected mu vs muD usage, removed packing fraction option for estimating muD, updated docs
44

55
**Changed:**
66

0 commit comments

Comments
 (0)