Changeset eda8b30 in sasmodels for doc

Timestamp:

Oct 28, 2017 6:42:15 AM (7 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

Location:

doc

Files:

• developer/overview.rst (modified) (1 diff)
• guide/orientation/orientation.rst (modified) (2 diffs)
• guide/pd/polydispersity.rst (modified) (1 diff)

doc/developer/overview.rst

@@ -165 +165 @@
 Further details are provided in the next section,
 :ref:`Calculator_Interface`
+
+.. _orientation_developer:
 
 Orientation and Numerical Integration

doc/guide/orientation/orientation.rst

@@ -42 +42 @@
 cylinder cross section. (When $\theta = \phi = 0$ these are parallel to the $Y$ and $X$ axes of the instrument.)
 The third orientation distribution, in $\psi$, is about the $c$ axis of the particle. Some experimentation may be required to
-understand the 2d patterns fully. A number of different shapes of distribution are available, as described for polydispersity.
+understand the 2d patterns fully. A number of different shapes of distribution are available, as described for 
+polydispersity, see :ref:`polydispersityhelp` .
 
 Earlier versions of SasView had numerical integration issues in some circumstances when 
@@ -52 +53 @@
 values of Npts and Nsigs, the number of steps used in the integration and the range spanned in number of standard deviations.
 The standard deviation is entered in units of degrees. For a rectangular (uniform) distribution the full width 
-should be $\pm\sqrt(3)$ ~ 1.73 standard deviations.
+should be $\pm\sqrt(3)$ ~ 1.73 standard deviations (this may be changed soon).
 
 Where appropriate, for best numerical results, keep $a < b < c$ and the $\theta$ distribution narrower than the $\phi$ distribution.
 
-Some more detailed technical notes are provided in the Developer section of this manual.
+Some more detailed technical notes are provided in the developer section of this manual :ref:`orientation_developer` .
     
 *Document History*

doc/guide/pd/polydispersity.rst

@@ -6 +6 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
+.. _polydispersityhelp:
+
 Polydispersity Distributions
 ----------------------------
 
-With some models in sasmodels we can calculate the average form factor for a
+With some models in sasmodels we can calculate the average intensity for a
 population of particles that exhibit size and/or orientational
-polydispersity. The resultant form factor is normalized by the average
+polydispersity. The resultant intensity is normalized by the average
 particle volume such that