Changes in sasmodels/generate.py [cd3dba0:4eac427] in sasmodels

File:

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

sasmodels/generate.py

@@ -99 +99 @@
 The kernel module must set variables defining the kernel meta data:
 
-    *id* is an implicit variable formed from the filename.  It will be
-    a valid python identifier, and will be used as the reference into
-    the html documentation, with '_' replaced by '-'.
-
-    *name* is the model name as displayed to the user.  If it is missing,
-    it will be constructed from the id.
+    *name* is the model name
 
     *title* is a short description of the model, suitable for a tool tip,
@@ -119 +114 @@
     the kernel functions.
 
-    *category* is the default category for the model.  Models in the
-    *structure-factor* category do not have *scale* and *background*
-    added.
-
     *source* is the list of C-99 source files that must be joined to
     create the OpenCL kernel functions.  The files defining the functions
@@ -143 +134 @@
     this step is significant.
 
+An *info* dictionary is constructed from the kernel meta data and
+returned to the caller.
+
+Additional fields can be defined in the kernel definition file that
+are not needed for sas modelling.
+
     *demo* is a dictionary of parameter=value defining a set of
-    parameters to use by default when *compare* is called.  Any
-    parameter not set in *demo* gets the initial value from the
-    parameter list.  *demo* is mostly needed to set the default
-    polydispersity values for tests.
+    parameters to use by default when *compare* is called.
 
     *oldname* is the name of the model in sasview before sasmodels
@@ -155 +149 @@
     of the new model against the values of the old model before
     you are ready to add the new model to sasmodels.
-
-
-An *info* dictionary is constructed from the kernel meta data and
-returned to the caller.
 
 The model evaluator, function call sequence consists of q inputs and the return vector,
@@ -200 +190 @@
 
 import sys
-from os.path import abspath, dirname, join as joinpath, exists, basename
+from os.path import abspath, dirname, join as joinpath, exists
 import re
 
@@ -243 +233 @@
 # description and its parameter table.  The remainder of the doc comes
 # from the module docstring.
-DOC_HEADER = """.. _%(id)s:
-
-%(name)s
+DOC_HEADER = """.. _%(name)s:
+
+%(label)s
 =======================================================
 
@@ -264 +254 @@
     Generate the parameter table to include in the sphinx documentation.
     """
+    pars = COMMON_PARAMETERS + pars
     column_widths = [
         max(len(p[0]) for p in pars),
@@ -532 +523 @@
         }
 
-def make_info(kernel_module):
-    """
-    Interpret the model definition file, categorizing the parameters.
-    """
+def make(kernel_module):
+    """
+    Build an OpenCL/ctypes function from the definition in *kernel_module*.
+
+    The module can be loaded with a normal python import statement if you
+    know which module you need, or with __import__('sasmodels.model.'+name)
+    if the name is in a string.
+    """
+    # TODO: allow Iq and Iqxy to be defined in python
     #print kernelfile
-    category = getattr(kernel_module, 'category', None)
-    parameters = COMMON_PARAMETERS + kernel_module.parameters
-    # Default the demo parameters to the starting values for the individual
-    # parameters if an explicit demo parameter set has not been specified.
-    demo_parameters = getattr(kernel_module, 'demo', None)
-    if demo_parameters is None:
-        demo_parameters = dict((p[0],p[2]) for p in parameters)
-    filename = abspath(kernel_module.__file__)
-    kernel_id = basename(filename)[:-3]
-    name = getattr(kernel_module, 'name', None)
-    if name is None:
-        name = " ".join(w.capitalize() for w in kernel_id.split('_'))
     info = dict(
-        id = kernel_id,  # string used to load the kernel
         filename=abspath(kernel_module.__file__),
-        name=name,
+        name=kernel_module.name,
         title=kernel_module.title,
         description=kernel_module.description,
-        category=category,
-        parameters=parameters,
-        demo=demo_parameters,
+        parameters=COMMON_PARAMETERS + kernel_module.parameters,
         source=getattr(kernel_module, 'source', []),
         oldname=kernel_module.oldname,
@@ -569 +550 @@
     info['partype'] = categorize_parameters(info['parameters'])
     info['defaults'] = dict((p[0], p[2]) for p in info['parameters'])
-    return info
-
-def make(kernel_module):
-    """
-    Build an OpenCL/ctypes function from the definition in *kernel_module*.
-
-    The module can be loaded with a normal python import statement if you
-    know which module you need, or with __import__('sasmodels.model.'+name)
-    if the name is in a string.
-    """
-    info = make_info(kernel_module)
+
     # Assume if one part of the kernel is python then all parts are.
     source = make_model(info) if not callable(info['Iq']) else None
@@ -588 +559 @@
     Return the documentation for the model.
     """
-    info = make_info(kernel_module)
-    subst = dict(id=info['id'].replace('_', '-'),
-                 name=info['name'],
-                 title=info['title'],
-                 parameters=make_partable(info['parameters']),
+    subst = dict(name=kernel_module.name.replace('_', '-'),
+                 label=" ".join(kernel_module.name.split('_')).capitalize(),
+                 title=kernel_module.title,
+                 parameters=make_partable(kernel_module.parameters),
                  docs=kernel_module.__doc__)
     return DOC_HEADER % subst