Changeset 455aaa1 in sasmodels for sasmodels/models/hollow_rectangular_prism.py

Timestamp:

Sep 7, 2018 9:27:02 AM (6 years ago)

Author:

butler

Branches:

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

Children:

6e7d7b6

Parents:

15a7577

Message:

update hollow_rectangular_prism docs

Add statement about vol fraction being for shell only. Also fix typos,
clean up/normalize ref and authorship sections and fix/normalize
hollow_cylinder refs and authorship

File:

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

sasmodels/models/hollow_rectangular_prism.py

@@ -2 +2 @@
 # Note: model title and parameter table are inserted automatically
 r"""
-
-This model provides the form factor, $P(q)$, for a hollow rectangular
-parallelepiped with a wall of thickness $\Delta$.
-
-
 Definition
 ----------
 
-The 1D scattering intensity for this model is calculated by forming
-the difference of the amplitudes of two massive parallelepipeds
-differing in their outermost dimensions in each direction by the
-same length increment $2\Delta$ (Nayuk, 2012).
+This model provides the form factor, $P(q)$, for a hollow rectangular
+parallelepiped with a wall of thickness $\Delta$. The 1D scattering intensity
+for this model is calculated by forming the difference of the amplitudes of two
+massive parallelepipeds differing in their outermost dimensions in each
+direction by the same length increment $2\Delta$ (\ [#Nayuk2012]_ Nayuk, 2012).
 
 As in the case of the massive parallelepiped model (:ref:`rectangular-prism`),
@@ -61 +57 @@
   \rho_\text{solvent})^2 \times P(q) + \text{background}
 
-where $\rho_\text{p}$ is the scattering length of the parallelepiped,
-$\rho_\text{solvent}$ is the scattering length of the solvent,
+where $\rho_\text{p}$ is the scattering length density of the parallelepiped,
+$\rho_\text{solvent}$ is the scattering length density of the solvent,
 and (if the data are in absolute units) *scale* represents the volume fraction
-(which is unitless).
+(which is unitless) of the rectangular shell of material (i.e. not including
+the volume of the solvent filled core).
 
 For 2d data the orientation of the particle is required, described using
@@ -73 +70 @@
 
 For 2d, constraints must be applied during fitting to ensure that the inequality
-$A < B < C$ is not violated, and hence the correct definition of angles is preserved. The calculation will not report an error,
-but the results may be not correct.
+$A < B < C$ is not violated, and hence the correct definition of angles is
+preserved. The calculation will not report an error if the inequality is *not*
+preserved, but the results may be not correct.
 
 .. figure:: img/parallelepiped_angle_definition.png
@@ -99 +97 @@
 ----------
 
-R Nayuk and K Huber, *Z. Phys. Chem.*, 226 (2012) 837-854
+.. [#Nayuk2012] R Nayuk and K Huber, *Z. Phys. Chem.*, 226 (2012) 837-854
+
+
+Authorship and Verification
+----------------------------
+
+* **Author:** Miguel Gonzales **Date:** February 26, 2016
+* **Last Modified by:** Paul Kienzle **Date:** December 14, 2017
+* **Last Reviewed by:** Paul Butler **Date:** September 06, 2018
 """