Changeset eb69cce in sasmodels for sasmodels/models/guinier.py

Timestamp:

Nov 30, 2015 9:18:41 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

d18f8a8

Parents:

d138d43

Message:

make model docs more consistent; build pdf docs

File:

• sasmodels/models/guinier.py (modified) (2 diffs)

sasmodels/models/guinier.py

@@ -1 +1 @@
 r"""
-Guinier (Model)
-
 Definition
 ----------
@@ -7 +5 @@
 This model fits the Guinier function
 
-.. math:: Q_1=\frac{1}{R_g}\sqrt{\frac{(m-s)(3-s)}{2}}
+.. math:: q_1=\frac{1}{R_g}\sqrt{\frac{(m-s)(3-s)}{2}}
 
-to the data directly without any need for linearisation (*cf*. Ln *I(q)* vs *q*\ :sup:`2`).
+to the data directly without any need for linearisation
+(*cf*. $\ln I(q)$ vs $q^2$\ ).
 
-For 2D data: The 2D scattering intensity is calculated in the same way as 1D, where the *q* vector is defined as
+For 2D data the scattering intensity is calculated in the same way as 1D,
+where the $q$ vector is defined as
 
 .. math:: q=\sqrt{q_x^2 + q_y^2}
 
-REFERENCE
+References
+----------
 
-A Guinier and G Fournet, *Small-Angle Scattering of X-Rays*, John Wiley & Sons, New York (1955)
+A Guinier and G Fournet, *Small-Angle Scattering of X-Rays*,
+John Wiley & Sons, New York (1955)
 """