Changes between Version 12 and Version 13 of ModelConvInst

Timestamp:

Nov 19, 2015 11:00:31 AM (9 years ago)

Author:

smk78

Comment:

—

ModelConvInst

@@ -31 +31 @@
 - name = "mymodel".  This is the name of the model that is shown to the user.  Use the name of the file as described above in 1. There will be less confusion if the model name matches the file name, but they could be different.
 - title = "short description".  This is a new value to be used for tooltip for example.  It can probably be pulled directly from the model_functions.rst file.
-- description = """doc string""".  Cut and paste the self.description string from the !SasView model header in [https://github.com/SasView/sasview/tree/master/src/sas/models/include srs/sas/models/include].  This gives a brief description of the equation and the parameters without the need to read the entire model documentation.  Make sure the parameter names match the current model definition.
-- 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 srs/sas/models/include]
+- description = """doc string""".  Cut and paste the self.description string from the !SasView model header in [https://github.com/SasView/sasview/tree/master/src/sas/models/include src/sas/models/include].  This gives a brief description of the equation and the parameters without the need to read the entire model documentation.  Make sure the parameter names match the current model definition.
+- 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]
  - PARAMETER 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:
   - bkgd = background