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

ESS_GUIESS_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 fe76fba was fe76fba, checked in by Piotr Rozyczko <rozyczko@…>, 6 years ago

Minor change to the python shell docs.
Fixed doc call from main menu

  • 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
[fe76fba]15This is a Jupyter Python QtConsole shell.
[78f02c3]16
[8a63137]17For the help about Python, visit the website http://docs.python.org/tutorial/
[78f02c3]18
[fe76fba]19For the help about QtConsole, visit the website https://ipython.org/ipython-doc/3/interactive/qtconsole.html
[78f02c3]20
[fe76fba]21The NumPy, SciPy, and Matplotlib, etc, libraries are shipped with SasView and so functions from these can be imported into the shell, however, some functionality may not work.
[78f02c3]22
[8a63137]23.. image:: new_pycrust_example.png
24   :align: center
[78f02c3]25
[fe76fba]26..
27    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.
[78f02c3]28
[fe76fba]29    .. image:: new_pycrust_example_2.png
30    :align: center
[78f02c3]31
[fe76fba]32    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.
[78f02c3]33
[fe76fba]34    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.
[77a9ddc]35
36.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
37
[fe76fba]38.. note::  This help document was last changed by Piotr Rozyczko, 22 May 2018
Note: See TracBrowser for help on using the repository browser.