Changeset b0c4271 in sasmodels for sasmodels/models/bcc_paracrystal.py

Timestamp:

Oct 5, 2016 7:40:41 PM (8 years ago)

Author:

butler

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

63e9cd8

Parents:

bb2d187

Message:

model documentation final format through core_shell_bicelle re: #646

File:

• sasmodels/models/bcc_paracrystal.py (modified) (5 diffs)

sasmodels/models/bcc_paracrystal.py

@@ -1 @@
-#bcc paracrystal model
-#note model title and parameter table are automatically inserted
-#note - calculation requires double precision
 r"""
+Definition
+----------
+
 Calculates the scattering from a **body-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
-----------
 
 The scattering intensity $I(q)$ is calculated as
@@ -23 +20 @@
 is the paracrystalline structure factor for a body-centered cubic structure.
 
-Equation (1) of the 1990 reference is used to calculate $Z(q)$, using
-equations (29)-(31) from the 1987 paper for $Z1$, $Z2$, and $Z3$.
+Equation (1) of the 1990 reference\ [#CIT1990]_ is used to calculate $Z(q)$,
+using equations (29)-(31) from the 1987 paper\ [#CIT1987]_ for $Z1$, $Z2$, and
+$Z3$.
 
 The lattice correction (the occupied volume of the lattice) for a
@@ -79 +77 @@
 The 2D (Anisotropic model) is based on the reference below where $I(q)$ is
 approximated for 1d scattering. Thus the scattering pattern for 2D may not
-be accurate. Note that we are not responsible for any incorrectness of the 2D
-model computation.
+be accurate.
 
 .. figure:: img/bcc_angle_definition.png
@@ -89 +86 @@
 ----------
 
-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 29, 2016
+* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016
 """
 
@@ -109 +112 @@
 category = "shape:paracrystal"
 
+#note - calculation requires double precision
 single = False