Changeset 3e1c9e5 in sasview for src/sas/sasgui/perspectives/fitting/media/plugin.rst

Timestamp:

Oct 10, 2016 5:52:25 PM (8 years ago)

Author:

smk78

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

d472e86, 49e000b

Parents:

f2261c2

Message:

Disinfected menu_bar.rst, fitting_help.rst and plugin.rst of 'custom
model' in favour of 'plugin model' and re-wrote sections of the
documentation to match it to the functionality of the program with
particular emphasis on creating/testing plugin models.

File:

• src/sas/sasgui/perspectives/fitting/media/plugin.rst (modified) (4 diffs)

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

@@ -9 +9 @@
 ^^^^^^^^^^^^
 
-There are currently two ways to add your own models to SasView:
-
-* Using the :ref:`Custom_Model_Editor`
-* By Writing a Plugin Model
-
-The Custom Model Editor lets you combine *existing* SasView library models. For anything more 
-complex, or if you want to apply polydispersity to parameters, you will need to write a Plugin Model.  
+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` as described below (suitable for all use cases)
+* By writing a model from scratch outside of SasView (only recommended for code monkeys!)
 
 Overview
@@ -22 +20 @@
 If you write your own model and save it to the the SasView *plugin_models* folder
 
-  *C:\\Users\\[username]\\.sasview\\plugin_models* (on Windows)
+  *C:\\Users\\{username}\\.sasview\\plugin_models* (on Windows)
 
 the next time SasView is started it will compile the plugin and add
-it to the list of *Customized Models* in a FitPage.
-
-SasView has three ways of writing models:
-
-- As a pure python model : Example -
+it to the list of *Plugin Models* in a FitPage.
+
+SasView models can be of three types:
+
+- A pure python model : Example -
   `broadpeak.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/broad_peak.py>`_
-- As a python model with embedded C : Example -
+- A python model with embedded C : Example -
   `sphere.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/sphere.py>`_
-- As a python wrapper with separate C code : Example -
+- A python wrapper with separate C code : Example -
   `cylinder.py <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/cylinder.py>`_,
   `cylinder.c <https://github.com/SasView/sasmodels/blob/master/sasmodels/models/cylinder.c>`_
@@ -671 +669 @@
 ^^^^^^^^^^^^^^^^^^^
 
-Installed SasView
-.................
-
-If you are editing your model from the SasView GUI, you can test it
-by selecting *Run > Check Model* from the *Model Editor* menu bar. An
-*Info* box will appear with the results of the compilation and a
-check that the model runs.
-
-
-Built SasView
-.............
+Minimal Testing
+...............
+
+Either open the :ref:`Python_shell` (*Tools* > *Python Shell/Editor*) or the :ref:`Advanced_Plugin_Editor` (*Fitting* > *Plugin Model Operations* > *Advanced 
+Plugin Editor*), load your model, and then select *Run > Check Model* from the 
+menu bar.
+
+An *Info* box will appear with the results of the compilation and a check that 
+the model runs.
+
+Recommended Testing
+...................
 
 If the model compiles and runs, you can next run the unit tests that
@@ -802 +801 @@
 consider adding your model to the
 `Model Marketplace <http://marketplace.sasview.org/>`_ so that others may use it!
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+.. note::  This help document was last changed by Steve King, 10Oct2016