| Version 3 (modified by smk78, 9 years ago) (diff) |
|---|
Model Documentation Checks
All models added to SasView need to be properly documented. This means there should be (in order):
a model name:
- this is the name string in the .py file
- titles should be:
- all in lower case
- without spaces (use underscores to separate words instead)
- without any capitalization or CamelCase
- without incorporating the word 'model'
- examples: barbell not BarBell; broad_peak not BroadPeak; barbell not BarBellModel
a short description:
- this is the title string in the .py file
- the .py file also contains a description string: this becomes a tooltip in the GUI
a model parameter table:
- this will be auto-generated from the parameters in the .py file
- model parameter names should be consistent between different models, so solvent_sld, for example, should have exactly the same name in every model
- scale and background are implicit to all models, they do not need to be added separately
- new parameter names:
- radius = radius
- sld = scattering length density of particle
- solvent_sld = scattering length density of matrix
- regiona_sld = scattering length density of region a for a multi component model with several slds
- cor_length = correlation length
- exp = an exponent
- peak_pos = q_peak or q0, etc
- theta = axis_theta
- phi = axis_phi
- vol_frac = volume fraction of particle
- etc
- every parameter should have units (or the word None)
- units should be properly formatted; ie, using sub-/super-scripts and using negative exponents rather than / operators
- fancy units markup are contained in the variable RST_UNITS in sasmodels/generate.py
- if necessary, add new units to RST_UNITS, use the macros defined in doc/rst_prolog, or add your own
- every parameter must have a default value
a long description:
- this is the RST text enclosed between the r""" and """ delimiters in the .py file
a definition of the model:
- as part of the long description
a formula defining the function the model calculates:
- as part of the long description
- images of math functions should be replaced with Latex equivalents:
- use the live demo Mathjax page ( http://www.mathjax.org/) to make sure the equation looks as expected
- or copy the Latex code from Paul Kienzle's document ( http://sasview.org/attachment/wiki/SasModels%20Work%20Package/Equations.docx.pdf)
an explanation of the parameters:
- as part of the long description
- explaining how the symbols in the formula map to the model parameters
a plot of the function
- using the default parameters
a figure caption:
- as part of the long description
- the figure number is auto-generated
at least one reference:
- as part of the long description
- specifying where the reader can obtain more information about the model
the name of the author
- as part of the long description
- the .py file should also contain a comment identifying who converted/created the model file
| SasView name | sasmodels name | P(Q) | S(Q) | Multiply | Multiplicity | Magnetic | SESANS | Assigned | Converted | UTest | double err | |||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| HayterMSAStructure | HayterMSAsq | . | . | . | . | . | 1 | RKH | . | . | . | . | . | - |
| BarBellModel | barbell | . | . | . | . | . | 3 | AJJ | . | - | . | . | . | . |
| BCCrystalModel | bcc | . | . | . | . | . | 3 | AJJ | . | - | . | . | 9e-14 | 2e-2 |
| BEPolyelectrolyte | be_polyelectrolyte | . | . | . | . | . | 3 | PR | . | . | . | . | . | - |
| BroadPeakModel | broad_peak | . | . | . | . | . | 4 | PDB | . | - | . | . | . | - |
| CappedCylinderModel | capped_cylinder | . | . | . | . | . | 3 | HP | . | - | . | . | 2e-11 | 3e-3 |
| CoreShellBicelleModel | core_shell_bicelle | . | . | . | . | . | 2 | PR | . | . | . | . | 1e-12 | 1e-4 |
| CoreShellCylinderModel | core_shell_cylinder | . | . | . | . | . | 3 | HP | . | - | . | . | 9e-14 | 4e-4 |
| CoreShellEllipsoidModel | core_shell_ellipsoid | . | . | . | . | . | 3 | PR | . | . | . | 1e-4 | . | 1e-3 |
| CoreShellEllipsoidXTModel | core_shell_ellipsoid_xt | . | . | . | . | . | 3 | PR | . | . | . | 1e-4 | . | 1e-3 |
| CoreShellModel | core_shell_sphere | . | . | . | . | . | 2 | MD | . | . | . | . | . | - |
| CorrLength | correlation_length | . | . | . | . | . | 3 | JRK | . | . | . | . | . | - |
| CSParallelepipedModel | core_shell_parallelepiped | . | . | . | . | . | 3 | MAG | . | . | . | . | 5e-13 | 8e-4 |
| CylinderModel | cylinder | . | . | . | . | . | 1 | HP | . | - | . | . | 2e-13 | 1e-4 |
| DABModel | dab | . | . | . | . | . | 1 | DM | . | - | . | . | . | - |
| EllipsoidModel | ellipsoid | . | . | . | . | . | 1 | HP | . | - | good* | . | 3e-14 | 1e-4 |
| EllipticalCylinderModel | elliptical_cylinder | . | . | . | . | . | 3 | MD | . | . | . | . | . | - |
| FCCrystalModel | fcc | . | . | . | . | . | 3 | AJJ | . | - | . | . | . | . |
| FlexibleCylinderModel | flexible_cylinder | . | . | . | . | . | 2 | PR | . | . | . | . | . | - |
| FlexCylEllipXModel | flexible_cylinder_ex | . | . | . | . | . | 3 | PR | . | . | . | . | . | - |
| FractalCoreShell | fractal_core_shell | . | . | . | . | . | 3 | PR | . | . | . | . | . | - |
| FuzzySphereModel | fuzzy_sphere | . | . | . | . | . | 2 | TRN | . | . | good* | . | - | - |
| PeakGaussModel | gaussian_peak | . | . | . | . | . | 4 | AJJ | . | - | . | 1e-3 | . | - |
| GaussLorentzGel | gauss_lorentz_gel | . | . | . | . | . | 2 | PR | . | . | . | . | . | - |
| GelFitModel | gel_fit | . | . | . | . | . | 1 | PR | . | . | . | . | . | - |
| Guinier | guinier | . | . | . | . | . | 1 | JRK | . | . | . | . | . | - |
| GuinierPorod | guinier_porod | . | . | . | . | . | 2 | MD | . | . | . | . | . | - |
| HardsphereStructure | hardsphere | . | . | . | . | . | 1 | RKH | . | . | . | . | . | - |
| HollowCylinderModel | hollow_cylinder | . | . | . | . | . | 2 | JRK | . | . | . | . | 4e-13 | 2e-3 |
| LamellarModel | lamellar | . | . | . | . | . | 2 | PAK | . | - | . | . | . | - |
| LamellarPSModel | lamellarCaille | . | . | . | . | . | 3 | RKH | . | . | . | 5e-2 | . | - |
| LamellarPSHGModel | lamellarCailleHG | . | . | . | . | . | 3 | RKH | . | . | 3e-12 | 5e-3 | . | - |
| LamellarFFHGModel | lamellarFFHG | . | . | . | . | . | 3 | RKH | . | . | . | . | . | - |
| LamellarPCrystallModel | lamellarPC | . | . | . | . | . | 3 | RKH | . | . | . | . | . | - |
| LineModel | line | . | . | . | . | . | 4 | WP | . | . | . | . | . | - |
| LinearPearlsModel | linear_pearls | . | . | . | . | . | 3 | PR | . | N | . | . | . | - |
| Lorentz | lorentz | . | . | . | . | . | 1 | JRK | . | . | . | . | . | - |
| MassFractalModel | mass_fractal | . | . | . | . | . | 1 | PR | . | . | . | 5e-5 | . | - |
| MassSurfaceFractal | mass_surface_fractal | . | . | . | . | . | 1 | PR | . | . | . | . | . | - |
| MicelleSphCore | micelle_sphere_core | . | . | . | . | . | PR | . | - | 1e-09 | . | . | - | |
| MultiShellModel | multi_shell | . | . | . | . | . | 3 | PR | . | . | 2e-09 | 1e-3 | . | - |
| ParallelepipedModel | parallelepiped | . | . | . | . | . | 2 | MAG | . | . | . | . | 5e-13 | 2e-4 |
| PeakLorentzModel | peak_lorentz | . | . | . | . | . | 4 | AJJ | . | . | . | . | . | - |
| PearlNecklaceModel | pearl_necklace | . | . | . | . | . | 3 | JRK | . | . | 6e-14 | . | . | - |
| PolyExclVolume | polymer_excl_volume | . | . | . | . | . | 3 | PR | . | . | . | . | . | - |
| PorodModel | porod | . | . | . | . | . | 3 | MD | . | . | . | . | . | - |
| !AbsolutePower_Law | power_law | . | . | . | . | . | 3 | SMK | . | . | . | . | . | - |
| RectangularPrismModel | rectangular_prism | . | . | . | . | . | 2 | MAG | . | . | . | . | . | - |
| RectangularHollowPrismModel | hollow_rectangular_prism | . | . | . | . | . | 3 | MAG | . | . | . | . | . | - |
| RectangularHollowPrismInfThinWallsModel | hollow_rectangular_prism_infinitely_thin_walls | . | . | . | . | . | 3 | MAG | . | . | . | . | . | - |
| SCCrystalModel | sc_crystal | . | . | . | . | . | 3 | PR | . | . | . | . | . | 1e-3 |
| SphereModel | sphere | . | . | . | . | . | 1 | HP | . | - | good* | . | . | - |
| StackedDisksModel | stacked_disk | . | . | . | . | . | 2 | PR | . | . | . | 1e-5 | . | 1e-5 |
| StarPolymer | star_polymer | . | . | . | . | . | 2 | PR | . | . | . | . | . | - |
| StickyHSStructure | stickyhardsphere | . | . | . | . | . | 1 | PAK | . | . | . | . | . | - |
| SurfaceFractalModel | surface_fractal | . | . | . | . | . | 1 | PR | . | . | . | 5e-5 | . | - |
| TeubnerStrey | teubner_strey | . | . | . | . | . | 1 | PAK | . | - | good* | . | . | - |
| TriaxialEllipsoidModel | triaxial_ellipsoid | . | . | . | . | . | 3 | HP | . | - | good* | . | . | . |
| TwoLorentzian | two_lorentzian | . | . | . | . | . | 4 | PR | . | . | . | . | . | - |
| TwoPowerLaw | two_power_law | . | . | . | . | . | 4 | WP | . | . | . | . | . | - |
| VesicleModel | vesicle | . | . | . | . | . | 2 | PDB | . | . | 3e-3 | 2e-5 | . | - |
| BinaryHSModel | binary_hard_sphere | . | . | . | . | . | 1 | PDB | . | - | - | - | - | - |
| Core2ndMomentModel | . | . | . | . | . | 3 | SMK | . | - | - | - | - | - | |
| CoreMultiShellModel | . | . | . | . | . | 3 | . | - | - | - | - | - | ||
| Debye | . | . | . | . | . | 1 | SMK | . | - | - | - | - | - | |
| FractalModel | . | . | . | . | . | 1 | PDB | . | - | - | - | - | - | |
| MultiplicationModel | . | . | . | . | . | PAK | . | - | - | - | - | - | ||
| OnionExpShellModel | . | . | . | . | . | 3 | PAK | . | - | - | - | - | - | |
| Poly_GaussCoil | . | . | . | . | . | 2 | SMK | . | - | - | - | - | - | |
| PringleModel | . | . | . | . | . | 3 | WP | . | - | - | - | - | - | |
| RaspBerryModel | . | . | . | . | . | 2 | AJJ | . | - | - | - | - | - | |
| ReflectivityModel | . | . | . | . | . | 4 | . | - | - | - | - | - | ||
| ReflectivityIIModel | . | . | . | . | . | 4 | . | - | - | - | - | - | ||
| RPA10Model | . | . | . | . | . | 3 | PAK | . | - | - | - | - | - | |
| SphericalSLDModel | . | . | . | . | . | 3 | WP | . | - | - | - | - | - | |
| SquareWellStructure | squarewell | . | . | . | . | . | 1 | RKH | . | - | - | - | - | - |
| UnifiedPowerRg | . | . | . | . | . | 4 | . | - | - | - | - | - | ||
| sum_p1_p2 | . | . | . | . | . | 3 | PAK | . | - | - | - | - | - | |
| sum_Ap1_1_Ap2 | . | . | . | . | . | 3 | . | - | - | - | - | - | ||
| polynomial5 | . | . | . | . | . | 3 | . | - | - | - | - | - | ||
| sph_bessel_jn | . | . | . | . | . | 3 | . | - | - | - | - | - | ||
| testmodel | . | . | . | . | . | 3 | . | - | - | - | - | - | ||
| testmodel_2 | . | . | . | . | . | 3 | . | - | - | - | - | - |
