Changes between Version 2 and Version 3 of ModelConvInst

Timestamp:

Nov 1, 2015 5:22:45 PM (8 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/ 
 
 '''CREATE NEW MODEL FILES'''.
 
-In sasmodels/models/ copy barbell.py and barbell.c to mymodel.py and mymodel.c for models with c code or broadpeak.py to mymodel.py where “mymodel’ is the NEW name for the model to be moved. Please follow new naming rules: 
+In sasmodels/models/ copy the appropriate files using the examples above to mymodel.py and mymodel.c as required where “mymodel’ is the NEW name for the model to be moved. Please follow new naming rules: 
 - No capitalization and thus no !CamelCase.  If necessary use underscore to separate (i.e. barbell not !BarBell or broad_peak not !BroadPeak)
 - Remove “model” from the name (i.e. barbell not !BarBellModel)
@@ -24 +25 @@
 - title is a short tool tip description of the model.  This is a new value to be used for tooltip for example. Make-up something appropriate but short (one line).
 - description doc string.  Cut and paste the self.description string from the !SasView model.  This gives a brief description of the equation and the parameters without the need to read the entire model documentation.
-- category is a GUI item that should be a default category that the model will be assigned to in the GUI if it is not overwritten by the user.  This can be a comma separated list if the model should default to several categories
 - parameters. This is where the parameters get defined.  The syntax should be obvious from the default. NAMES:  VERY IMPORTANT.  We are trying to make the model parameter more consistent between models.  So solvent sld for example should have exactly the same name in every model.  Current list of new parameters is:
  - radius = radius