Changeset e7e9231 in sasmodels for sasmodels/models/fcc_paracrystal.py

Timestamp:

Sep 16, 2018 9:32:26 PM (6 years ago)

Author:

butler

Branches:

ticket_1156

Children:

0b906ea

Parents:

78f8308

Message:

Correct/update paracrystal docs

Correct BCC doc for lattice volume fraction and update all paracrystal
models docs reference and authorship sections.

File:

• sasmodels/models/fcc_paracrystal.py (modified) (3 diffs)

sasmodels/models/fcc_paracrystal.py

@@ -3 +3 @@
 #note - calculation requires double precision
 r"""
+Definition
+----------
+
 Calculates the scattering from a **face-centered cubic lattice** with
 paracrystalline distortion. Thermal vibrations are considered to be
 negligible, and the size of the paracrystal is infinitely large.
 Paracrystalline distortion is assumed to be isotropic and characterized by
-a Gaussian distribution.
-
-Definition
-----------
+a Gaussian distribution. 
 
 The scattering intensity $I(q)$ is calculated as
@@ -23 +23 @@
 is the paracrystalline structure factor for a face-centered cubic structure.
 
-Equation (1) of the 1990 reference is used to calculate $Z(q)$, using
-equations (23)-(25) from the 1987 paper for $Z1$, $Z2$, and $Z3$.
+Equation (1) of the 1990 reference\ [#CIT1990]_ is used to calculate $Z(q)$,
+using equations (23)-(25) from the 1987 paper\ [#CIT1987]_ for $Z1$, $Z2$, and
+$Z3$.
 
 The lattice correction (the occupied volume of the lattice) for a
@@ -88 +89 @@
 ----------
 
-Hideki Matsuoka et. al. *Physical Review B*, 36 (1987) 1754-1765
-(Original Paper)
+.. [#CIT1987] Hideki Matsuoka et. al. *Physical Review B*, 36 (1987) 1754-1765
+   (Original Paper)
+.. [#CIT1990] Hideki Matsuoka et. al. *Physical Review B*, 41 (1990) 3854 -3856
+   (Corrections to FCC and BCC lattice structure calculation)
 
-Hideki Matsuoka et. al. *Physical Review B*, 41 (1990) 3854 -3856
-(Corrections to FCC and BCC lattice structure calculation)
+Authorship and Verification
+----------------------------
+
+* **Author:** NIST IGOR/DANSE **Date:** pre 2010
+* **Last Modified by:** Paul Butler **Date:** September 16, 2018
+* **Last Reviewed by:** Paul Butler **Date:** September 16, 2018
 """