Changeset a5b8477 in sasmodels for sasmodels/generate.py

Timestamp:

Apr 13, 2016 6:17:10 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:

0ce5710

Parents:

60f03de

Message:

update docs to work with the new ModelInfo/ParameterTable? classes

File:

• sasmodels/generate.py (modified) (4 diffs)

sasmodels/generate.py

@@ -123 +123 @@
     polydispersity values for tests.
 
-An *model_info* dictionary is constructed from the kernel meta data and
-returned to the caller.
+A :class:`modelinfo.ModelInfo` structure is constructed from the kernel meta
+data and returned to the caller.
 
 The doc string at the start of the kernel module will be used to
@@ -132 +132 @@
 file systems are case-sensitive, so only use lower case characters for
 file names and extensions.
-
-
-The function :func:`make` loads the metadata from the module and returns
-the kernel source.  The function :func:`make_doc` extracts the doc string
-and adds the parameter table to the top.  The function :func:`model_sources`
-returns a list of files required by the model.
 
 Code follows the C99 standard with the following extensions and conditions::
@@ -149 +143 @@
     all double declarations may be converted to half, float, or long double
     FLOAT_SIZE is the number of bytes in the converted variables
+
+:func:`load_kernel_module` loads the model definition file and
+:modelinfo:`make_model_info` parses it. :func:`make_source`
+converts C-based model definitions to C source code, including the
+polydispersity integral.  :func:`model_sources` returns the list of
+source files the model depends on, and :func:`timestamp` returns
+the latest time stamp amongst the source files (so you can check if
+the model needs to be rebuilt).
+
+The function :func:`make_doc` extracts the doc string and adds the
+parameter table to the top.  *make_figure* in *sasmodels/doc/genmodel*
+creates the default figure for the model.  [These two sets of code
+should mignrate into docs.py so docs can be updated in one place].
 """
 from __future__ import print_function
@@ -585 +592 @@
     Sq_units = "The returned value is a dimensionless structure factor, $S(q)$."
     docs = convert_section_titles_to_boldface(model_info.docs)
+    pars = make_partable(model_info.parameters.COMMON
+                         + model_info.parameters.kernel_parameters)
     subst = dict(id=model_info.id.replace('_', '-'),
                  name=model_info.name,
                  title=model_info.title,
-                 parameters=make_partable(model_info.parameters.kernel_parameters),
+                 parameters=pars,
                  returns=Sq_units if model_info.structure_factor else Iq_units,
                  docs=docs)