Changes between Version 37 and Version 38 of ModelConvInst

Timestamp:

Jan 28, 2016 6:03:36 PM (8 years ago)

Author:

pkienzle

Comment:

—

ModelConvInst

@@ -51 +51 @@
   - add more as you generate them!
   - **''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
+{{{
+python -m sasmodels.list_pars
+}}}
  - 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.
@@ -199 +203 @@
 }}}
 
+'''CLEAN LINT'''
+
+Run the lint check with:
+
+{{{
+python -m pylint --rcfile=extra/pylint.rc sasmodels/models/modelname.py
+}}}
+
+
+You can tell pylint to ignore things.  For example, to align you parameters in blocks:
+
+{{{#!python
+
+# pylint: disable=bad-whitespace,line-too-long
+#   ["name",                  "units", default, [lower, upper], "type", "description"],
+parameters = [
+    ["contrast_factor",       "barns",    10.0,  [-inf, inf], "", "Contrast factor of the polymer"],
+    ["bjerrum_length",        "Ang",       7.1,  [0, inf],    "", "Bjerrum length"],
+    ["virial_param",          "1/Ang^2",  12.0,  [-inf, inf], "", "Virial parameter"],
+    ["monomer_length",        "Ang",      10.0,  [0, inf],    "", "Monomer length"],
+    ["salt_concentration",    "mol/L",     0.0,  [-inf, inf], "", "Concentration of monovalent salt"],
+    ["ionization_degree",     "",          0.05, [0, inf],    "", "Degree of ionization"],
+    ["polymer_concentration", "mol/L",     0.7,  [0, inf],    "", "Polymer molar concentration"],
+    ]
+# pylint: enable=bad-whitespace,line-too-long
+}}}
+
+We are not aiming for zero lint just yet, only keeping it to a minimum.  For now, don't worry about invalid-name or missing-docstring on Iq/Iqxy. If you really want a variable name Rg for example because Rg is the right name for the model parameter, then ignore the lint errors.  We will have delinting sessions at the code camp, where we can decide on standards for model files, parameter names, etc.
+
+
 '''CHECK THE DOCS'''