Changeset eb69cce in sasmodels for sasmodels/models/broad_peak.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/broad_peak.py (modified) (3 diffs)

sasmodels/models/broad_peak.py

@@ -10 +10 @@
 spherical morphologies, or for bicontinuous structures).
 
-The returned value is scaled to units of |cm^-1|, absolute scale.
-
 Definition
 ----------
 
-The scattering intensity *I(q)* is calculated as
+The scattering intensity $I(q)$ is calculated as
 
-.. math:
+.. math::
 
-    I(q) = \frac{A}{Q^n} + \frac{C}{1 + (Q\xi}^m} + B
+    I(q) = \frac{A}{q^n} + \frac{C}{1 + (q\xi)^m} + B
 
-Here the peak position is related to the d-spacing as *Q0* = 2|pi| / *d0*.
+Here the peak position is related to the d-spacing as $q_o = 2\pi / d_o$.
 
-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:
+.. math::
 
     q = \sqrt{q_x^2 + q_y^2}
@@ -35 +33 @@
     1D plot using the default values (w/200 data point).
 
-REFERENCE
----------
+References
+----------
 
 None.
@@ -75 +73 @@
              / (1.0 + (abs(q - peak_pos) * lorentz_length) ** lorentz_exp))
     return inten
-Iq.vectorized = True  # Iq accepts an array of Q values
+Iq.vectorized = True  # Iq accepts an array of q values
 
 def Iqxy(qx, qy, *args):
     return Iq(sqrt(qx ** 2 + qy ** 2), *args)
-Iqxy.vectorized = True # Iqxy accepts an array of Qx, Qy values
+Iqxy.vectorized = True # Iqxy accepts an array of qx, qy values