Changeset 6e7ff6d in sasmodels for sasmodels/modelinfo.py

Timestamp:

Apr 7, 2016 2:01:54 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:

3543141

Parents:

8bd7b77

Message:

reenable python models

File:

• sasmodels/modelinfo.py (modified) (2 diffs)

sasmodels/modelinfo.py

@@ -189 +189 @@
     can automatically be promoted to magnetic parameters, each of which
     will have a magnitude and a direction, which may be different from
-    other sld parameters.
+    other sld parameters. The volume parameters are used for calls
+    to form_volume within the kernel (required for volume normalization)
+    and for calls to ER and VR for effective radius and volume ratio
+    respectively.
 
     *description* is a short description of the parameter.  This will
@@ -197 +200 @@
     Additional values can be set after the parameter is created:
 
-    *length* is the length of the field if it is a vector field
-    *length_control* is the parameter which sets the vector length
-    *is_control* is True if the parameter is a control parameter for a vector
-    *polydisperse* is true if the parameter accepts a polydispersity
-    *relative_pd* is true if that polydispersity is relative
+    * *length* is the length of the field if it is a vector field
+
+    * *length_control* is the parameter which sets the vector length
+
+    * *is_control* is True if the parameter is a control parameter for a vector
+
+    * *polydisperse* is true if the parameter accepts a polydispersity
+
+    * *relative_pd* is true if that polydispersity is a portion of the
+    value (so a 10% length dipsersity would use a polydispersity value of 0.1)
+    rather than absolute dispersisity (such as an angle plus or minus
+    15 degrees).
 
     In the usual process these values are set by :func:`make_parameter_table`