Changeset 5d4777d in sasmodels for sasmodels/models/README.rst

Timestamp:

Sep 2, 2014 1:24:38 AM (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:

f4cf580

Parents:

ff7119b

Message:

reorganize, check and update models

File:

• sasmodels/models/README.rst (modified) (2 diffs)

sasmodels/models/README.rst

@@ -7 +7 @@
 model.
 
-cylindermodel_onefile.py is cylinder.c+cylinder.py merged into one file.
-This doesn't actually run yet since sasmodels.gen has not been updated
-to support it.  It exists as a proposal.  Note that the function declaration
-has been removed since there is enough information in the parameter
-definitions to generate it automatically.  Note also that "source" which
-used to be all the source has been renamed "includes".
-
-One-file models could coexist with the py+c file models by checking for the
-existence of c_blah and creating the appropriate function wrappers.  These
-would be appended after any include files.  You shouldn't mix the two forms
-within a single model since form_volume needs to be defined before
-Iq/Iqxy but after the libraries.
+lamellar.py is an example of a single file model with embedded C code.
 
 Note: may want to rename form_volume to calc_volume and Iq/Iqxy to
-calc_Iq/calc_Iqxy in both the c+py and the one file forms so that the
-names are more predictable.  Similarly ER/VR go to calc_ER/calc_VR.
+calc_Iq/calc_Iqxy. Similarly ER/VR go to calc_ER/calc_VR.
 
 Note: It is possible to translate python code automatically to opencl, using
-something like numba, clyther, shedskin or pypy.
+something like numba, clyther, shedskin or pypy, so maybe the kernel functions
+could be implemented without any C syntax.
 
 Magnetism hasn't been implemented yet.  We may want a separate Imagnetic
@@ -35 +24 @@
 
 Need to write code to generate the polydispersity loops in python for
-kernels that are only implemented in python.
+kernels that are only implemented in python.  Also, need to implement
+an example kernel directly in python.