Changeset eda8b30 in sasmodels for sasmodels/models/bcc_paracrystal.py

Timestamp:

Oct 28, 2017 4:42:15 AM (6 years ago)

Author:

richardh

Branches:

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

Children:

5f8b72b

Parents:

da5536f

Message:

further changes to model docs for orientation calcs

File:

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

sasmodels/models/bcc_paracrystal.py

@@ -65 +65 @@
     \end{array}
 
-**NB**: The calculation of $Z(q)$ is a double numerical integral that must
-be carried out with a high density of points to properly capture the sharp
-peaks of the paracrystalline scattering. So be warned that the calculation
-is SLOW. Go get some coffee. Fitting of any experimental data must be
-resolution smeared for any meaningful fit. This makes a triple integral.
-Very, very slow. Go get lunch!
+.. note::
 
+  The calculation of $Z(q)$ is a double numerical integral that
+  must be carried out with a high density of points to properly capture
+  the sharp peaks of the paracrystalline scattering.     
+  So be warned that the calculation is slow. Fitting of any experimental data 
+  must be resolution smeared for any meaningful fit. This makes a triple integral
+  which may be very slow.
+  
 This example dataset is produced using 200 data points,
 *qmin* = 0.001 |Ang^-1|, *qmax* = 0.1 |Ang^-1| and the above default values.
@@ -77 +79 @@
 The 2D (Anisotropic model) is based on the reference below where $I(q)$ is
 approximated for 1d scattering. Thus the scattering pattern for 2D may not
-be accurate.
+be accurate, particularly at low $q$. For general details of the calculation and angular 
+dispersions for oriented particles see :ref:`orientation` .
+Note that we are not responsible for any incorrectness of the 2D model computation.
 
 .. figure:: img/parallelepiped_angle_definition.png