Changes between Version 3 and Version 4 of ModelConvInst

Timestamp:

Nov 1, 2015 5:48:58 PM (9 years ago)

Author:

ajj

Comment:

—

ModelConvInst

@@ -6 +6 @@
 - As a python wrapper with separate C code : Example - barbell.py
 
-The documentation for the sasmodels package can be found at http://www.sasview.org/sasmodels/ 
+The documentation for the sasmodels package can be found at http://www.sasview.org/sasmodels/ (not very pretty at the moment)
+
+Before following the conversion instructions below, it is worth reading the documentation at http://www.sasview.org/sasmodels/api/generate.html#module-sasmodels.generate which describes the structure of a model.
 
 '''CREATE NEW MODEL FILES'''.
@@ -52 +54 @@
 '''TEST YOUR NEWLY CONVERTED MODEL'''
 
-Test your new model by runing compare.py to verify that the converted model is giving the same results as it did in SasView prior to conversion
+Test your new model by runing compare.py to verify that the converted model is giving the same results as it did in SasView prior to conversion. In order to do this, you need either a version of sasview installed in your python path, or a built sasview in a checked out directory at the same level as the checked out sasmodels repository.
+
+If the latter, you need to add the sasview build directory to your PYTHONPATH or use compare.sh which will do so for you.
+
+The first thing to test is that you are getting the same answer as SasView for the 1D version of the model. This is done with:
+
+'''
+./compare.sh -1d modelname 
+'''
+
+This will result in some comparison metrics between the openCL implementation (if installed - should revert to using ctypes if no OpenCL is installed) and a plot of the two calculations and a comparison plot.
+
+If the model has 2D orientational calculation, then you should additionally test with:
+
+'''
+./compare.sh -2d modelname
+'''
+
+Brief help for the comparison script can be obtained by just running '''./compare.sh'''
+
 
 '''FINISHING'''