Changes between Version 48 and Version 49 of ModelConvInst

Timestamp:

Mar 17, 2016 1:03:26 PM (8 years ago)

Author:

smk78

Comment:

—

ModelConvInst

@@ -40 +40 @@
  - **parameters = [["name", "units", default, [min,max], "type", "tooltip"],...].** This is where the parameters get defined. The syntax should be obvious from the default. Copy the parameters from the model header file [https://github.com/SasView/sasview/tree/master/src/sas/models/include src/sas/models/include].
  - ''the order of the parameters in the definition will be the order of the parameters in the user interface and the order of the parameters in Iq(), Iqxy() and form_volume().''
- - VERY IMPORTANT: We are trying to make the model parameters more consistent between models. So solvent_sld, for example, should have exactly the same name in every model. ''The current list of new parameters is:''
-  - ''radius''      = radius
-  - ''sld''         = scattering length density of particle
-  - ''solvent_sld'' = scattering length density of matrix
-  - ''regiona_sld'' = scattering length density of region a for a multi component model with several slds
-  - ''cor_length''  = correlation length
-  - ''exp''         = exponent (example: porod_exp)
-  - ''peak_pos''    = q_peak or q0 etc
-  - ''theta''       = axis_theta, phi = axis_phi
-  - ''vol_frac''    = volume fraction of particle (example: lg_vol_frac)
-  - add more as you generate them!
+ - VERY IMPORTANT: We are trying to make the model parameters more consistent between models. So sld_solvent, for example, should have exactly the same name in every model. 
   - **''NOTE: There is no need to specify 'scale' or 'background', these are implicit to all models.''**
   - to see the list of parameters currently used across all models, use
@@ -56 +46 @@
 python -m sasmodels.list_pars
 }}}
+ - **the parameter default values are used to auto-generate a plot of the model function in the documentation**.
  - lower and upper limits can be any number, or -inf or inf.
   - add limits where required the (old) sasview models don't usually define them.
@@ -146 +137 @@
 Also remember, if using a locally-built !SasView, that if you have done a ''pull'' from the repo you will need to re-build before continuing!
 
-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:
+The first thing to test is that you are getting the same answer as !SasView for the 1D version of the model. **These tests use the ''demo='' values in your model file.** To run the tests use:
 
 {{{
@@ -199 +190 @@
 Dispersion parameters n, sigma and type will be unchanged from demo so that run times are predictable.
 
-Now run the unit tests that you have added:
+Now run the unit tests that you have added. **These tests use the ''test='' values in your model file**. To run the unit tests use:
 
 {{{
@@ -260 +251 @@
 Once compare and the unit test(s) pass properly and everything is done, commit your new model to the repo and then edit the models table at [http://trac.sasview.org/wiki/ListofModels] to indicate that the conversion is complete.
 
+Also complete the documentation check table [http://trac.sasview.org/wiki/Documentation Checks].
+
 
 '''OPENCL ISSUES'''