Changeset 3048ec6 in sasmodels for doc/guide/plugin.rst

Timestamp:

Sep 28, 2017 7:58:47 AM (7 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

59485a4

Parents:

3b32f8d

Message:

doc updates: note that model/parameter names can't start with numbers

File:

• doc/guide/plugin.rst (modified) (8 diffs)

doc/guide/plugin.rst

@@ -78 +78 @@
      at the start of the model documentation and as a tooltip in the SasView GUI
 
-- a **short discription**:
+- a **short description**:
    - this is the **description** string in the *.py* file
    - this is a medium length description which appears when you click
@@ -233 +233 @@
 
 **name = "mymodel"** defines the name of the model that is shown to the user.
-If it is not provided, it will use the name of the model file, with '_'
-replaced by spaces and the parts capitalized.  So *adsorbed_layer.py* will
-become *Adsorbed Layer*.  The predefined models all use the name of the
-model file as the name of the model, so the default may be changed.
+If it is not provided it will use the name of the model file. The name must
+be a valid variable name, starting with a letter and contains only letters,
+numbers or underscore.  Spaces, dashes, and other symbols are not permitted.
 
 **title = "short description"** is short description of the model which
@@ -298 +297 @@
 - **"name"** is the name of the parameter shown on the FitPage.
 
+  - the name must be a valid variable name, starting with a letter and
+    containing only letters, numbers and underscore.
+
   - parameter names should follow the mathematical convention; e.g.,
     *radius_core* not *core_radius*, or *sld_solvent* not *solvent_sld*.
@@ -366 +368 @@
     dispersion.
 
-
-Integer Parameters
-..................
-
 Some models will have integer parameters, such as number of pearls in the
 pearl necklace model, or number of shells in the multi-layer vesicle model.
@@ -390 +388 @@
         ...
 
-Derivatibve based optimizers such as Levenberg-Marquardt will not work
+Derivative based optimizers such as Levenberg-Marquardt will not work
 for integer parameters since the partial derivative is always zero, but
 the remaining optimizers (DREAM, differential evolution, Nelder-Mead simplex)
@@ -419 +417 @@
      \approx \frac{\sum_{i=1}^n G(x_i) I(q,x_i)}{\sum_{i=1}^n G(x_i) V(x_i)}
 
-That is, the indivdual models do not need to include polydispersity
+That is, the individual models do not need to include polydispersity
 calculations, but instead rely on numerical integration to compute the
 appropriately smeared pattern.   Angular dispersion values over polar angle
@@ -439 +437 @@
 The parameters *par1, par2, ...* are the list of non-orientation parameters
 to the model in the order that they appear in the parameter table.
-**Note that the autogenerated model file uses** *x* **rather than** *q*.
+**Note that the auto-generated model file uses** *x* **rather than** *q*.
 
 The *.py* file should import trigonometric and exponential functions from
@@ -963 +961 @@
 across multiple parameters can be very slow).
 
-If your model has 2D orientational calculation, then you should also
+If your model has 2D orientation calculation, then you should also
 test with::