Changeset 87985ca in sasmodels for sasmodels/sasview_model.py

Timestamp:

Sep 2, 2014 2:35:23 PM (10 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:

19dcb933

Parents:

f4cf580

Message:

clean up source tree

File:

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

sasmodels/sasview_model.py

@@ +1 @@
+"""
+Sasview model constructor.
+
+Given a module defining an OpenCL kernel such as sasmodels.models.cylinder,
+create a sasview model class to run that kernel as follows::
+
+    from sasmodels.sasview_model import make_class
+    from sasmodels.models import cylinder
+    CylinderModel = make_class(cylinder, dtype='single')
+
+The model parameters for sasmodels are different from those in sasview.
+When reloading previously saved models, the parameters should be converted
+using :func:`sasmodels.convert.convert`.
+"""
+
+# TODO: add a sasview=>sasmodels parameter translation layer
+# this will allow us to use the new sasmodels as drop in replacements, and
+# delay renaming parameters until all models have been converted.
+
 import math
 from copy import deepcopy
@@ -16 +35 @@
     """
     Load the sasview model defined in *kernel_module*.
-    :param kernel_module:
-    :param dtype:
-    :return:
+
+    Returns a class that can be used directly as a sasview model.
     """
     model =  load_model(kernel_module, dtype=dtype)