Changeset f237c05 in sasview

Timestamp:

Sep 15, 2016 6:33:57 AM (8 years ago)

Author:

Piotr Rozyczko <rozyczko@…>

Branches:

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

Children:

d13386c

Parents:

4c930a2

git-author:

Paul Kienzle <pkienzle@…> (09/11/16 22:52:22)

git-committer:

Piotr Rozyczko <rozyczko@…> (09/15/16 06:33:57)

Message:

document sasmodels plugin format

Location:

src/sas/sasgui/perspectives/fitting/media

Files:

• fitting.rst (modified) (1 diff)
• fitting_help.rst (modified) (4 diffs)
• plugin.rst (added)

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

@@ -18 +18 @@
 
    Information on the SasView Optimisers <optimizer.rst>
-   
+
+   Writing a Plugin <plugin.rst>

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

@@ -132 +132 @@
 * By :ref:`Writing_a_Plugin`
 
-*NB: Because of the way these options are implemented, it is not possible for them*
-*to use the polydispersity algorithms in SasView. Only models in the model library*
-*can do this. At the time of writing (Release 3.1.0) work is in hand to make it*
-*easier to add new models to the model library.*
-
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
@@ -163 +158 @@
 the :ref:`Advanced` option.
 
+*NB: "Fit Parameters" has been split into two sections, those which can be
+polydisperse (shape and orientation parameters) and those which are not
+(scattering length densities, for example).*
+
 Sum|Multi(p1,p2)
 ^^^^^^^^^^^^^^^^
@@ -192 +191 @@
 *Advanced Custom Model Editor*.
 
-*NB: Unless you are confident about what you are doing, it is recommended that you*
-*only modify lines denoted with the ## <----- comments!*
+See :ref:`Writing_a_Plugin` for details on the plugin format.
+
+*NB: Sum/Product models are still using the SasView 3.x model format.  Unless
+you are confident about what you are doing, it is recommended that you
+only modify lines denoted with the ## <----- comments!*
 
 When editing is complete, select *Run -> Compile* from the *Model Editor* menu bar. An
@@ -214 +216 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. _Writing_a_Plugin:
-
-Writing a Plugin
-----------------
-
-Advanced users can write their own model in Python and save it to the the SasView
-*plugin_models* folder
-
-  *C:\\Users\\[username]\\.sasview\\plugin_models* - (on Windows)
-
-in .py format. The next time SasView is started it will compile the plugin and add
-it to the list of *Customized Models*.
-
-It is recommended that existing plugin models be used as templates.
+  .. _Writing_a_Plugin:
+
+  Writing a Plugin
+  ----------------
+
+  Advanced users can write their own model in Python and save it to the the SasView
+  *plugin_models* folder
+
+    *C:\\Users\\[username]\\.sasview\\plugin_models* - (on Windows)
+
+  in .py format. The next time SasView is started it will compile the plugin and add
+  it to the list of *Customized Models*.
+
+  It is recommended that existing plugin models be used as templates.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ