Ignore:
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:
2 added
1 edited
1 moved

Legend:

Unmodified
Added
Removed
  • src/sas/sasgui/perspectives/calculator/media/python_shell_help.rst

    rd85c194 r8a63137  
    33.. This is a port of the original SasView html help file to ReSTructured text 
    44.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015. 
     5.. Text revised during Code Camp V in Oct 2016. 
    56 
    6 Python Shell Tool 
    7 ================= 
     7Python ShellEditor Tool 
     8======================= 
    89 
    910Description  
    1011----------- 
    1112 
    12 This is a Python shell/editor (PyCrust) provided with WxPython. An editing  
    13 notebook will show up when a Python file is created/loaded with the *New* or  
    14 *Open* options on the menu.  
     13This is a Python shell/editor provided with WxPython. 
    1514 
    16 *Run* enables the editor to compile and run the Python code. 
     15For the help about Python, visit the website http://docs.python.org/tutorial/ 
    1716 
    18 For the details about the Python, visit the website http://docs.python.org/tutorial/ 
     17.. note:: This shell/editor has its own help, but the Help() and Credits() calls do not work on Macs. 
    1918 
    20 The NumPy, SciPy, and Matplotlib, etc, libraries are shipped with SasView.  
    21 However, some functionality may not work. 
     19The 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. 
    2220 
    23 PyCrust has its own Help. 
     21.. image:: new_pycrust_example.png 
     22   :align: center 
    2423 
    25 *NOTE! The Help() and Credits() calls do not work on Macs.* 
     24When 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. 
    2625 
    27 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
     26.. image:: new_pycrust_example_2.png 
     27   :align: center 
    2828 
    29 Example 
    30 ------- 
     29If 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. 
    3130 
    32 An example calling the Matplotlib plotting gallery: 
    33  
    34 .. image:: pycrust_example.png 
     31To 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. 
    3532 
    3633.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ 
    3734 
    38 .. note::  This help document was last changed by Steve King, 19Feb2015 
     35.. note::  This help document was last changed by Steve King, 10Oct2015 
Note: See TracChangeset for help on using the changeset viewer.