Changeset da7b26b in sasmodels for sasmodels/models/sc_paracrystal.py

Timestamp:

Sep 28, 2018 7:33:46 AM (6 years ago)

Author:

smk78

Branches:

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

Children:

a5bcd61

Parents:

dd16e07

Message:

Added warning to bcc, fcc and sc model doc strings

File:

• sasmodels/models/sc_paracrystal.py (modified) (4 diffs)

sasmodels/models/sc_paracrystal.py

@@ -1 +1 @@
 r"""
+.. warning:: This model and this model description are under review following 
+             concerns raised by SasView users. If you need to use this model, 
+             please email help@sasview.org for the latest situation. *The 
+             SasView Developers. September 2018.*
+             
+Definition
+----------
+
 Calculates the scattering from a **simple cubic lattice** with
 paracrystalline distortion. Thermal vibrations are considered to be
@@ -5 +13 @@
 Paracrystalline distortion is assumed to be isotropic and characterized
 by a Gaussian distribution.
-
-Definition
-----------
 
 The scattering intensity $I(q)$ is calculated as
@@ -20 +25 @@
 $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 +97 @@
 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 29, 2016
+* **Last Reviewed by:** Richard Heenan **Date:** March 21, 2016
 """