Changeset 8a63137 in sasview for src/sas/sasgui

Timestamp:

Oct 10, 2016 11:13:07 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:

82b0b05e

Parents:

e8447d8

Message:

Updated documentation and images for the Python shell/editor. Refs #754

Location:

src/sas/sasgui/perspectives/calculator/media

Files:

• new_pycrust_example.png (added)
• new_pycrust_example_2.png (added)
• old_pycrust_example.png (moved) (moved from src/sas/sasgui/perspectives/calculator/media/pycrust_example.png)
• python_shell_help.rst (modified) (1 diff)

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 ShellEditor 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