Changeset a503bfd in sasmodels for sasmodels/generate.py

Timestamp:

Feb 16, 2015 7:41:55 PM (9 years ago)

Author:

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:

a1542aae, 373d1b6

Parents:

d547f16

Message:

move sasview→sasmodels conversion info to model definition

File:

• sasmodels/generate.py (modified) (1 diff)

sasmodels/generate.py

@@ -128 +128 @@
     respectively.  These can also be defined in the last source file.
 
+    *Iq* and *Iqxy* also be instead be python functions defining the
+    kernel.  If they are marked as *Iq.vectorized = True* then the
+    kernel is passed the entire *q* vector at once, otherwise it is
+    passed values one *q* at a time.  The performance improvement of
+    this step is significant.
+
 An *info* dictionary is constructed from the kernel meta data and
-returned to the caller.  It includes the additional fields
-
+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.
+
+    *oldname* is the name of the model in sasview before sasmodels
+    was split into its own package, and *oldpars* is a dictionary
+    of *parameter: old_parameter* pairs defining the new names for
+    the parameters.  This is used by *compare* to check the values
+    of the new model against the values of the old model before
+    you are ready to add the new model to sasmodels.
 
 The model evaluator, function call sequence consists of q inputs and the return vector,