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

sasmodels/models/lamellarCaille.py

@@ -3 +3 @@
 This model provides the scattering intensity, $I(q) = P(q) S(q)$, for a
 lamellar phase where a random distribution in solution are assumed.
-Here a Caille $S(Q)$ is used for the lamellar stacks.
+Here a Caille $S(q)$ is used for the lamellar stacks.
+
+Definition
+----------
 
 The scattering intensity $I(q)$ is
 
-.. math:
+.. math::
 
     I(q) = 2\pi \frac{P(q)S(q)}{\delta q^2}
@@ -13 +16 @@
 The form factor is
 
-.. math:
+.. math::
 
     P(q) = \frac{2\Delta\rho^2}{q^2}\left(1-\cos q\delta \right)
@@ -19 +22 @@
 and the structure factor is
 
-.. math:
+.. math::
 
     S(q) = 1 + 2 \sum_1^{N-1}\left(1-\frac{n}{N}\right)
@@ -26 +29 @@
 where
 
-.. math:
+.. math::
 
-    \begin{eqnarray}
-    \alpha(n) &=& \frac{\eta_{cp}}{4\pi^2} \left(\ln(\pi n)+\gamma_E\right)  \\
-    \gamma_E &=& 0.5772156649 && \text{Euler's constant} \\
-    \eta_{cp} &=& \frac{q_o^2k_B T}{8\pi\sqrt{K\overline{B}}} && \text{Caille constant}
-    \end{eqnarray}
+    %\begin{align*} % isn't working with pdflatex
+    \begin{array}{rll}
+    \alpha(n) &= \frac{\eta_{cp}}{4\pi^2} \left(\ln(\pi n)+\gamma_E\right)
+              & \\
+    \gamma_E  &= 0.5772156649
+              & \text{Euler's constant} \\
+    \eta_{cp} &= \frac{q_o^2k_B T}{8\pi\sqrt{K\overline{B}}}
+              & \text{Caille constant} \\
+              &
+    \end{array}
 
 Here $d$ = (repeat) spacing, $\delta$ = bilayer thickness,
@@ -54 +62 @@
     q = \sqrt{q_x^2 + q_y^2}
 
-The returned value is in units of |cm^-1|, on absolute scale.
+.. figure:: img/lamellarCaille_1d.jpg
 
-.. image:: img/lamellarCaille_1d.jpg
+    1D plot using the default values (w/6000 data point).
 
-*Figure. 1D plot using the default values (w/6000 data point).*
-
-Our model uses the form factor calculations as implemented in a c library
-provided by the NIST Center for Neutron Research (Kline, 2006).
-
-REFERENCE
----------
+References
+----------
 
 F Nallet, R Laversanne, and D Roux, J. Phys. II France, 3, (1993) 487-502