source: sasview/src/sas/qtgui/Calculators/media/python_shell_help.rst @ 417c03f

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalc
Last change on this file since 417c03f was 417c03f, checked in by Piotr Rozyczko <rozyczko@…>, 4 years ago

Moved RST files around and modified sphinx config to use them. SASVIEW-927

  • Property mode set to 100755
File size: 1.5 KB
RevLine 
[920928f]1.. python_shell_help.rst
[379b87a]2
[78f02c3]3.. This is a port of the original SasView html help file to ReSTructured text
4.. by S King, ISIS, during SasView CodeCamp-III in Feb 2015.
[8a63137]5.. Text revised during Code Camp V in Oct 2016.
[78f02c3]6
[afb93df]7.. _Python_shell:
8
9Python Shell-Editor Tool
10========================
[379b87a]11
[78f02c3]12Description
13-----------
14
[8a63137]15This is a Python shell/editor provided with WxPython.
[78f02c3]16
[8a63137]17For the help about Python, visit the website http://docs.python.org/tutorial/
[78f02c3]18
[8a63137]19.. note:: This shell/editor has its own help, but the Help() and Credits() calls do not work on Macs.
[78f02c3]20
[8a63137]21The 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.
[78f02c3]22
[8a63137]23.. image:: new_pycrust_example.png
24   :align: center
[78f02c3]25
[8a63137]26When 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.
[78f02c3]27
[8a63137]28.. image:: new_pycrust_example_2.png
29   :align: center
[78f02c3]30
[8a63137]31If 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.
[78f02c3]32
[8a63137]33To 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.
[77a9ddc]34
35.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
36
[8a63137]37.. note::  This help document was last changed by Steve King, 10Oct2015
Note: See TracBrowser for help on using the repository browser.