Changeset 13f5656 in sasview for src/sas/sasgui/perspectives

Timestamp:

Oct 10, 2016 12:59:02 PM (8 years ago)

Author:

wojciech

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:

ec72ceb

Parents:

131d94b (diff), afb93df (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

wpotrzebowski <Wojciech.Potrzebowski@…> (10/10/16 12:58:46)

git-committer:

wpotrzebowski <Wojciech.Potrzebowski@…> (10/10/16 12:59:02)

Message:

Adding pyopencl requirement to check_packages and requirements txt

Location:

src/sas/sasgui/perspectives

Files:

• calculator/media/new_pycrust_example.png (added)
• calculator/media/new_pycrust_example_2.png (added)
• calculator/media/old_pycrust_example.png (moved) (moved from src/sas/sasgui/perspectives/calculator/media/pycrust_example.png)
• calculator/media/python_shell_help.rst (modified) (1 diff)
• fitting/media/edit_model_menu.bmp (deleted)
• fitting/media/edit_model_menu.png (added)
• fitting/media/fitting.rst (modified) (1 diff)
• fitting/media/fitting_help.rst (modified) (3 diffs)

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

@@ -3 +3 @@
 .. This is a port of the original SasView html help file to ReSTructured text
 .. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
+.. Text revised during Code Camp V in Oct 2016.
 
-Python Shell Tool
-=================
+.. _Python_shell:
+
+Python Shell-Editor Tool
+========================
 
 Description 
 -----------
 
-This is a Python shell/editor (PyCrust) provided with WxPython. An editing 
-notebook will show up when a Python file is created/loaded with the *New* or 
-*Open* options on the menu. 
+This is a Python shell/editor provided with WxPython.
 
-*Run* enables the editor to compile and run the Python code.
+For the help about Python, visit the website http://docs.python.org/tutorial/
 
-For the details about the Python, visit the website http://docs.python.org/tutorial/
+.. note:: This shell/editor has its own help, but the Help() and Credits() calls do not work on Macs.
 
-The NumPy, SciPy, and Matplotlib, etc, libraries are shipped with SasView. 
-However, some functionality may not work.
+The NumPy, SciPy, and Matplotlib, etc, libraries are shipped with SasView and so functions from these can be imported into the shell/editor, however, some functionality may not work.
 
-PyCrust has its own Help.
+.. image:: new_pycrust_example.png
+   :align: center
 
-*NOTE! The Help() and Credits() calls do not work on Macs.*
+When a Python file, for example a fitting model, is created or loaded with the *New* or *Open* options from the menu, a new tab opens with an editing notebook.
 
-.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+.. image:: new_pycrust_example_2.png
+   :align: center
 
-Example
--------
+If a Python (.py) model has a linked C (.c) subroutine *in the same folder* then the shell/editor will open both! However input focus is usually transferred to the tab with the .c file.
 
-An example calling the Matplotlib plotting gallery:
-
-.. image:: pycrust_example.png
+To compile a model, select *Run* > *Check Model* from the shell/editor menu. If the model contains a unit test (which it should!!!) then this will also run and a popup window will report the success/failure of the test.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-.. note::  This help document was last changed by Steve King, 19Feb2015
+.. note::  This help document was last changed by Steve King, 10Oct2015

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

@@ -3 +3 @@
 Fitting Documentation
 =====================
+
+.. note:: In Windows use [Alt]-[Cursor left] to return to the previous page
 
 .. toctree::

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

@@ -141 +141 @@
 From the *Fitting* option in the menu bar, select *Edit Custom Model*.
 
-.. image:: edit_model_menu.bmp
+.. image:: edit_model_menu.png
 
 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