Changeset 2e66ef5 in sasmodels for sasmodels/core.py

Timestamp:

May 8, 2017 2:16:09 AM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

a03fad8

Parents:

990d8df

Message:

add a short scripting guide; start in on developer docs

File:

• sasmodels/core.py (modified) (3 diffs)

sasmodels/core.py

@@ -117 +117 @@
     Load model info and build model.
 
-    *model_name* is the name of the model as used by :func:`load_model_info`.
-    Additional keyword arguments are passed directly to :func:`build_model`.
+    *model_name* is the name of the model, or perhaps a model expression
+    such as sphere*hardsphere or sphere+cylinder.
+
+    *dtype* and *platform* are given by :func:`build_model`.
     """
     return build_model(load_model_info(model_name),
@@ -128 +130 @@
     """
     Load a model definition given the model name.
+
+    *model_name* is the name of the model, or perhaps a model expression
+    such as sphere*hardsphere or sphere+cylinder.
 
     This returns a handle to the module defining the model.  This can be
@@ -227 +232 @@
 
     Possible types include 'half', 'single', 'double' and 'quad'.  If the
-    type is 'fast', then this is equivalent to dtype 'single' with the
-    fast flag set to True.
+    type is 'fast', then this is equivalent to dtype 'single' but using
+    fast native functions rather than those with the precision level guaranteed
+    by the OpenCL standard.
+
+    Platform preference can be specfied ("ocl" vs "dll"), with the default
+    being OpenCL if it is availabe.  If the dtype name ends with '!' then
+    platform is forced to be DLL rather than OpenCL.
+
+    This routine ignores the preferences within the model definition.  This
+    is by design.  It allows us to test models in single precision even when
+    we have flagged them as requiring double precision so we can easily check
+    the performance on different platforms without having to change the model
+    definition.
     """
     # Assign default platform, overriding ocl with dll if OpenCL is unavailable