Changeset e7e9231 in sasmodels for sasmodels/models/sc_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/sc_paracrystal.py (modified) (4 diffs)

sasmodels/models/sc_paracrystal.py

@@ -1 +1 @@
 r"""
-Calculates the scattering from a **simple cubic lattice** with
+Definition
+----------
+
+TCalculates the scattering from a **simple cubic lattice** with
 paracrystalline distortion. Thermal vibrations are considered to be
 negligible, and the size of the paracrystal is infinitely large.
@@ -6 +9 @@
 by a Gaussian distribution.
 
-Definition
-----------
-
-The scattering intensity $I(q)$ is calculated as
+he scattering intensity $I(q)$ is calculated as
 
 .. math::
@@ -20 +20 @@
 $Z(q)$ is the paracrystalline structure factor for a simple cubic structure.
 
-Equation (16) of the 1987 reference is used to calculate $Z(q)$, using
-equations (13)-(15) from the 1987 paper for Z1, Z2, and Z3.
+Equation (16) of the 1987 reference\ [#CIT1987]_ is used to calculate $Z(q)$,
+using equations (13)-(15) from the 1987 paper\ [#CIT1987]_ for Z1, Z2, and Z3.
 
 The lattice correction (the occupied volume of the lattice) for a simple cubic
@@ -91 +91 @@
 Reference
 ---------
-Hideki Matsuoka et. al. *Physical Review B,* 36 (1987) 1754-1765
-(Original Paper)
 
-Hideki Matsuoka et. al. *Physical Review B,* 41 (1990) 3854 -3856
-(Corrections to FCC and BCC lattice structure calculation)
+.. [#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)
+
+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
 """