Changeset 7edce22 in sasmodels

Timestamp:

Apr 8, 2016 5:39:28 PM (9 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:

0d99a6a

Parents:

a86f6c0

Message:

doc strings for modelinfo

File:

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

sasmodels/modelinfo.py

@@ -22 +22 @@
     TestCondition = Tuple[ParameterSetUser, TestInput, TestValue]
 
-MAX_PD = 4
-
-COMMON_PARAMETERS = [
-    ["scale", "", 1, [0, np.inf], "", "Source intensity"],
-    ["background", "1/cm", 1e-3, [0, np.inf], "", "Source background"],
-]
-assert (len(COMMON_PARAMETERS) == 2
-        and COMMON_PARAMETERS[0][0]=="scale"
-        and COMMON_PARAMETERS[1][0]=="background"), "don't change common parameters"
+MAX_PD = 4 #: Maximum number of simultaneously polydisperse parameters
+
 # assumptions about common parameters exist throughout the code, such as:
 # (1) kernel functions Iq, Iqxy, form_volume, ... don't see them
@@ -40 +33 @@
 # Note that scale and background cannot be coordinated parameters whose value
 # depends on the some polydisperse parameter with the current implementation
+COMMON_PARAMETERS = [
+    ["scale", "", 1, [0, np.inf], "", "Source intensity"],
+    ["background", "1/cm", 1e-3, [0, np.inf], "", "Source background"],
+]
+assert (len(COMMON_PARAMETERS) == 2
+        and COMMON_PARAMETERS[0][0]=="scale"
+        and COMMON_PARAMETERS[1][0]=="background"), "don't change common parameters"
 
 
 def make_parameter_table(pars):
     # type: (List[ParameterDefinition) -> ParameterTable
+    """
+    Construct a parameter table from a list of parameter definitions.
+
+    This is used by the module processor to convert the parameter block into
+    the parameter table seen in the :class:`ModelInfo` for the module.
+    """
     processed = []
     for p in pars:
@@ -55 +61 @@
 def parse_parameter(name, units='', default=np.NaN,
                     limits=(-np.inf, np.inf), ptype='', description=''):
+    """
+    Parse an individual parameter from the parameter definition block.
+
+    This does type and value checking on the definition, leading
+    to early failure in the model loading process and easier debugging.
+    """
     # type: (str, str, float, LimitsOrChoice, str, str) -> Parameter
     # Parameter is a user facing class.  Do robust type checking.
@@ -577 +589 @@
         return result
 
-
-
 def isstr(x):
     # type: (Any) -> bool
+    """
+    Return True if the object is a string.
+    """
     # TODO: 2-3 compatible tests for str, including unicode strings
     return isinstance(x, str)
 
 def make_model_info(kernel_module):
+    # type: (module) -> ModelInfo
+    """
+    Extract the model definition from the loaded kernel module.
+
+    Fill in default values for parts of the module that are not provided.
+
+    Note: vectorized Iq and Iqxy functions will be created for python
+    models when the model is first called, not when the model is loaded.
+    """
     info = ModelInfo()
     #print("make parameter table", kernel_module.parameters)
@@ -662 +684 @@
       *model_info* blocks for the composition objects.  This allows us to
       build complete product and mixture models from just the info.
+
+    The structure should be mostly static, other than the delayed definition
+    of *Iq* and *Iqxy* if they need to be defined.
     """
     id = None               # type: str