Changeset 7e6bdf9 in sasview for src/sas/sasgui/perspectives/fitting

Timestamp:

Oct 9, 2016 9:59:04 AM (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:

9cc002d

Parents:

467202f

Message:

Tweaked text to explain difference between the Custom Model editor and
Plugin Models (keeping Richard happy again!)

File:

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

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

@@ -6 +6 @@
 .. note:: If some code blocks are not readable, expand the documentation window
 
+Introduction
+^^^^^^^^^^^^
+
+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.  
+
 Overview
 ^^^^^^^^
 
-You can write your own model and save it to the the SasView
-*plugin_models* folder
+If you write your own model and save it to the the SasView *plugin_models* folder
 
   *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.  It is recommended that an
-existing model be used as a template.
+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:
@@ -42 +51 @@
 
 In the *~\\.sasview\\plugin_models* directory, copy the appropriate files
-(using the examples above as templates) to mymodel.py (and mymodel.c, etc)
+(we recommend using the examples above as templates) to mymodel.py (and mymodel.c, etc)
 as required, where "mymodel" is the name for the model you are creating.