Changeset afb93df in sasview

Timestamp:

Oct 10, 2016 12:08:58 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:

b61bd57

Parents:

fd62331

Message:

Update fitting_help.rst with changes to Fitting > Edit Custom Model

Location:

src/sas/sasgui/perspectives

Files:

• calculator/media/python_shell_help.rst (modified) (1 diff)
• fitting/media/fitting_help.rst (modified) (3 diffs)

src/sas/sasgui/perspectives/calculator/media/python_shell_help.rst

@@ -5 +5 @@
 .. Text revised during Code Camp V in Oct 2016.
 
-Python ShellEditor Tool
-=======================
+.. _Python_shell:
+
+Python Shell-Editor Tool
+========================
 
 Description 

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

@@ -145 +145 @@
 and then one of the options
 
-*  *New* - to create a new custom model template
-*  *Sum|Multi(p1,p2)* - to create a new model by summing/multiplying existing models in the model library
-*  *Advanced* - to edit a new custom model
+*  *New* - to create a custom model template with a help dialog
+*  *Sum|Multi(p1,p2)* - to create a custom model by summing/multiplying *existing models* in the model library
+*  *Advanced* - to create/edit a custom model in a Python shell
 *  *Delete* - to delete a custom model
+*  *Load* - to (re-)load custom models
 
 New
@@ -184 +185 @@
 ^^^^^^^^
 
-Selecting this option shows all the custom models in the plugin model folder
-
-  *C:\\Users\\[username]\\.sasview\\plugin_models* - (on Windows)
+Selecting this option shows all the custom models in the plugin model folder, on Windows this is
+
+  *C:\\Users\\{username}\\.sasview\\plugin_models*
 
 You can edit, modify, and save the Python code in any of these models using the
-*Advanced Custom Model Editor*.
-
-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
-*Info* box will appear with the results of the compilation and model unit tests. The
-model will only be usable if the tests 'pass'.
+*Advanced Custom Model Editor*. Note that this is actually the same tool as the :ref:`Python_shell` .
+
+For details of the SasView plugin model format see :ref:`Writing_a_Plugin` .
+
+.. note:: Model files generated with the Sum/Multi option 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* > *Check Model* from the *Advanced Custom Model Editor* menu bar. An *Info* box will appear with the results of the compilation and model unit tests. The model will only be usable if the tests 'pass'.
 
 To use the model, go to the relevant *Fit Page*, select the *Customized Models*
 category and then select the model from the drop-down menu.
 
-*NB: Any changes to a custom model generated in this way only become effective after*
-*it is re-selected from the model drop-down menu on the Fit Page.*
+Any changes to a custom model generated in this way only become effective *after* it is re-selected from the model drop-down menu on the FitPage.
 
 Delete
@@ -213 +209 @@
 
 *NB: Custom models shipped with SasView cannot be removed in this way.*
+
+Load
+^^^^
+
+This option loads (or re-loads) all models present in the plugin model folder.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ