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

sasmodels/models/hollow_cylinder.py

@@ -6 +6 @@
 .. math::
 
-    P(q) = \text{scale} \langle F^2 \rangle/V_\text{shell} + \text{background}
+    P(q) = \text{scale} \left<F^2\right>/V_\text{shell} + \text{background}
 
-where the averaging $\langle \rangle$ is applied only for the 1D calculation.
+where the averaging $\left<\ldots\right>$ is applied only for the 1D calculation.
 
 The inside and outside of the hollow cylinder are assumed have the same SLD.
@@ -19 +19 @@
 .. math::
 
-    \begin{eqnarray}
-    P(q)           &=& (\text{scale})V_\text{shell}\Delta\rho^2
+    %\begin{align*} % isn't working with pdflatex
+    \begin{array}{rl}
+    P(q)           &= (\text{scale})V_\text{shell}\Delta\rho^2
             \int_0^{1}\Psi^2
             \left[q_z, R_\text{shell}(1-x^2)^{1/2},
                        R_\text{core}(1-x^2)^{1/2}\right]
             \left[\frac{\sin(qHx)}{qHx}\right]^2 dx \\
-    \Psi[q,y,z]    &=& \frac{1}{1-\gamma^2}
+    \Psi[q,y,z]    &= \frac{1}{1-\gamma^2}
             \left[ \Lambda(qy) - \gamma^2\Lambda(qz) \right] \\
-    \Lambda(a)     &=& 2 J_1(a) / a \\
-    \gamma         &=& R_\text{core} / R_\text{shell} \\
-    V_\text{shell} &=& \pi \left(R_\text{shell}^2 - R_\text{core}^2 \right)L \\
-    J_1(x)         &=& \frac{(\sin(x)-x\cdot \cos(x))}{x^2} \\
-    \end{eqnarray}
+    \Lambda(a)     &= 2 J_1(a) / a \\
+    \gamma         &= R_\text{core} / R_\text{shell} \\
+    V_\text{shell} &= \pi \left(R_\text{shell}^2 - R_\text{core}^2 \right)L \\
+    J_1(x)         &= (\sin(x)-x\cdot \cos(x)) / x^2 \\
+    \end{array}
 
 where *scale* is a scale factor and $J_1$ is the 1st order
@@ -42 +43 @@
 **NB**: The 2nd virial coefficient of the cylinder is calculated
 based on the radius and 2 length values, and used as the effective radius
-for $S(Q)$ when $P(Q) * S(Q)$ is applied.
+for $S(q)$ when $P(q) \cdot S(q)$ is applied.
 
 In the parameters, the contrast represents SLD :sub:`shell` - SLD :sub:`solvent`
@@ -59 +60 @@
     Examples of the angles for oriented pp against the detector plane.
 
-Reference
----------
+References
+----------
 
 L A Feigin and D I Svergun, *Structure Analysis by Small-Angle X-Ray and
@@ -88 +89 @@
               ["sld", "1/Ang^2", 6.3, [-inf, inf], "", "Cylinder sld"],
               ["solvent_sld", "1/Ang^2", 1, [-inf, inf], "", "Solvent sld"],
-              ["theta", "[deg]", 90, [-360, 360], "orientation", "Theta angle"],
-              ["phi", "[deg]", 0, [-360, 360], "orientation", "Phi angle"],
+              ["theta", "degrees", 90, [-360, 360], "orientation", "Theta angle"],
+              ["phi", "degrees", 0, [-360, 360], "orientation", "Phi angle"],
               ]