Changeset 3048ec6 in sasmodels


Ignore:
Timestamp:
Sep 28, 2017 7:58:47 AM (5 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:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/guide/plugin.rst

    r9844c3a r3048ec6  
    7878     at the start of the model documentation and as a tooltip in the SasView GUI 
    7979 
    80 - a **short discription**: 
     80- a **short description**: 
    8181   - this is the **description** string in the *.py* file 
    8282   - this is a medium length description which appears when you click 
     
    233233 
    234234**name = "mymodel"** defines the name of the model that is shown to the user. 
    235 If it is not provided, it will use the name of the model file, with '_' 
    236 replaced by spaces and the parts capitalized.  So *adsorbed_layer.py* will 
    237 become *Adsorbed Layer*.  The predefined models all use the name of the 
    238 model file as the name of the model, so the default may be changed. 
     235If it is not provided it will use the name of the model file. The name must 
     236be a valid variable name, starting with a letter and contains only letters, 
     237numbers or underscore.  Spaces, dashes, and other symbols are not permitted. 
    239238 
    240239**title = "short description"** is short description of the model which 
     
    298297- **"name"** is the name of the parameter shown on the FitPage. 
    299298 
     299  - the name must be a valid variable name, starting with a letter and 
     300    containing only letters, numbers and underscore. 
     301 
    300302  - parameter names should follow the mathematical convention; e.g., 
    301303    *radius_core* not *core_radius*, or *sld_solvent* not *solvent_sld*. 
     
    366368    dispersion. 
    367369 
    368  
    369 Integer Parameters 
    370 .................. 
    371  
    372370Some models will have integer parameters, such as number of pearls in the 
    373371pearl necklace model, or number of shells in the multi-layer vesicle model. 
     
    390388        ... 
    391389 
    392 Derivatibve based optimizers such as Levenberg-Marquardt will not work 
     390Derivative based optimizers such as Levenberg-Marquardt will not work 
    393391for integer parameters since the partial derivative is always zero, but 
    394392the remaining optimizers (DREAM, differential evolution, Nelder-Mead simplex) 
     
    419417     \approx \frac{\sum_{i=1}^n G(x_i) I(q,x_i)}{\sum_{i=1}^n G(x_i) V(x_i)} 
    420418 
    421 That is, the indivdual models do not need to include polydispersity 
     419That is, the individual models do not need to include polydispersity 
    422420calculations, but instead rely on numerical integration to compute the 
    423421appropriately smeared pattern.   Angular dispersion values over polar angle 
     
    439437The parameters *par1, par2, ...* are the list of non-orientation parameters 
    440438to the model in the order that they appear in the parameter table. 
    441 **Note that the autogenerated model file uses** *x* **rather than** *q*. 
     439**Note that the auto-generated model file uses** *x* **rather than** *q*. 
    442440 
    443441The *.py* file should import trigonometric and exponential functions from 
     
    963961across multiple parameters can be very slow). 
    964962 
    965 If your model has 2D orientational calculation, then you should also 
     963If your model has 2D orientation calculation, then you should also 
    966964test with:: 
    967965 
Note: See TracChangeset for help on using the changeset viewer.