-                      r26c8be3
+                      r5295cf5
 *  in *Single* fit mode - individual data sets are fitted independently one-by-one
+*  in *Simultaneous* fit mode - multiple data sets are fitted simultaneously to the *same* model with/without constrained parameters (this might be useful, for example, if you have measured the same sample at different contrasts)
+*  in *Simultaneous* fit mode - multiple data sets are fitted simultaneously to
+   the *same* model with/without constrained parameters (this might be useful,
+   for example, if you have measured the same sample at different contrasts)
 *  in *Batch* fit mode - multiple data sets are fitted sequentially to the *same* model (this might be useful, for example, if you have performed a kinetic or time-resolved experiment and have *lots* of data sets!)
 …
 -----------------
+By default, the models in SasView are grouped into five categories
+*  *Shapes* - models describing 'objects' (spheres, cylinders, etc)
+The models in SasView are grouped into categories. By default these consist of:
+*  *Cylinder* - cylindrical shapes (disc, right cylinder, cylinder with endcaps
+   etc)
+*  *Ellipsoid* - ellipsoidal shapes (oblate,prolate, core shell, etc)
+*  *Parellelepiped* - as the name implies
+*  *Sphere* - sheroidal shapes (sphere, core multishell, vesicle, etc)
+*  *Lamellae* - lamellar shapes (lamellar, core shell lamellar, stacked
+   lamellar, etc)
 *  *Shape-Independent* - models describing structure in terms of density correlation functions, fractals, peaks, power laws, etc
+*  *Customized Models* - SasView- or User-created (non-library) Python models
+*  *Uncategorised* - other models (for reflectivity, etc)
+*  *Paracrystal* - semi ordered structures (bcc, fcc, etc)
 *  *Structure Factor* - S(Q) models
+*  *Plugin Models* - User-created (custom/non-library) Python models
 Use the *Category* drop-down menu to chose a category of model, then select
 …
 .. image:: cat_fig0.bmp
 The categorization of all models except the customized models can be reassigned,
+added to, and removed using *Category Manager*. Models can also be hidden from view
 in the drop-down menus.
+The categorization of all models except the user supplied Plugin Models can be
+reassigned, added to, and removed using *Category Manager*. Models can also be
+hidden from view in the drop-down menus.
 .. image:: cat_fig1.bmp
 …
 ^^^^^^^^^^^^^^^^^
 To change category, highlight a model in the list by left-clicking on its entry and
+then click the *Modify* button. Use the *Change Category* panel that appears to make
 the required changes.
+To change category, highlight a model in the list by left-clicking on its entry
+and then click the *Modify* button. Use the *Change Category* panel that appears
+to make the required changes.
 .. image:: cat_fig2.bmp
 …
 ^^^^^^^^^^^^^^^^^^^^^
 Use the *Enable All / Disable All* buttons and the check boxes beside each model to
+select the models to show/hide. To apply the selection, click *Ok*. Otherwise click
 *Cancel*.
+Use the *Enable All / Disable All* buttons and the check boxes beside each model
+to select the models to show/hide. To apply the selection, click *Ok*. Otherwise
+click *Cancel*.
 *NB: It may be necessary to change to a different category and then back again*
 …
 ---------------
+For a complete list of all the library models available in SasView, see the `Model Documentation <../../../index.html>`_ .
+For a complete list of all the library models available in SasView, see
+the `Model Documentation <../../../index.html>`_ .
 It is also possible to add your own models.
 …
 There are essentially three ways to generate new fitting models for SasView:
+* Using the SasView :ref:`New_Plugin_Model` helper dialog (best for beginners and/or relatively simple models)
+* By copying/editing an existing model (this can include models generated by the *New Plugin Model* dialog) in the :ref:`Python_shell` or :ref:`Advanced_Plugin_Editor` (suitable for all use cases)
+* By writing a model from scratch outside of SasView (only recommended for code monkeys!)
+*  Using the SasView :ref:`New_Plugin_Model` helper dialog (best for beginners
+   and/or relatively simple models)
+*  By copying/editing an existing model (this can include models generated by
+   the New Plugin Model* dialog) in the :ref:`Python_shell` or
+   :ref:`Advanced_Plugin_Editor` (suitable for all use cases)
+*  By writing a model from scratch outside of SasView (only recommended for code
+   monkeys!)
 Please read the guidance on :ref:`Writing_a_Plugin` before proceeding.
 …
 ^^^^^^^^^^^^^^^^
 Relatively straightforward models can be programmed directly from the SasView GUI
 using the *New Plugin Model Function*.
+Relatively straightforward models can be programmed directly from the SasView
+GUI using the *New Plugin Model Function*.
 .. image:: new_model.bmp
 …
 *checked*\ .
 Also note that the 'Fit Parameters' have been split into two sections: those which
+can be polydisperse (shape and orientation parameters) and those which are not
 (eg, scattering length densities).
+Also note that the 'Fit Parameters' have been split into two sections: those
+which can be polydisperse (shape and orientation parameters) and those which are
+not (eg, scattering length densities).
 A model file generated by this option can be viewed and further modified using
 …
 .. image:: sum_model.bmp
 This option creates a custom model of the form::
      Custom Model = scale_factor \* {(scale_1 \* model_1) \+ (scale_2 \* model_2)} \+ background
+This option creates a custom Plugin Model of the form::
+     Plugin Model = scale_factor * {(scale_1 * model_1) +/- (scale_2 * model_2)} + background
 or::
      Custom Model = scale_factor \* model_1 \* model_2 \+ background
+     Plugin Model = scale_factor * model_1 /* model_2 + background
 In the *Easy Sum/Multi Editor* give the new model a function name and brief
 …
 Simply highlight the plugin model to be removed. The operation is final!!!
 *NB: Plugin models shipped with SasView cannot be removed in this way.*
+*NB: Models shipped with SasView cannot be removed in this way.*
 Load Plugin Models
 ^^^^^^^^^^^^^^^^^^
+This option loads (or re-loads) all models present in the *~\\.sasview\\plugin_models* folder.
+This option loads (or re-loads) all models present in the
+*~\\.sasview\\plugin_models* folder.
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 …
 :ref:`Assessing_Fit_Quality`.
 *NB: If you need to use a customized model, you must ensure that model is available*
 *first (see* :ref:`Adding_your_own_models` *).*
+*NB: If you need to use a custom Plugin Model, you must ensure that model is
+available first (see* :ref:`Adding_your_own_models` *).*
 Method
 …
 If multiple data sets are in one file, load just that file. *Unselect All Data*, then
 select a single initial data set to be fitted. Fit that selected data set as described
 above under :ref:`Single_Fit_Mode` .
 *NB: If you need to use a customized model, you must ensure that model is available*
 *first (see* :ref:`Adding_your_own_models` *).*
+above under :ref:`Single_Fit_Mode`.
+*NB: If you need to use a custom Plugin Model, you must ensure that model is
+available first (see* :ref:`Adding_your_own_models` *).*
 Method

src/sas/sasgui/perspectives/fitting/media/plugin.rst

rca6cbc1c	r5295cf5
27	27
28	28	the next time SasView is started it will compile the plugin and add
29		it to the list of ~~Customized~~ Models in a FitPage.
	29	it to the list of Plugin Models in a FitPage.
30	30
31	31	SasView models can be of three types:

Note: See TracChangeset for help on using the changeset viewer.

SasView

Changeset 5295cf5 in sasview

Legend:

src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

src/sas/sasgui/perspectives/fitting/media/plugin.rst

Download in other formats: