ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/_build/html/_sources/mainapi.txt
(Generate patch)
# Line 9 | Line 9
9   The API provides an interface to the software from a python command line, such as `IPython <http://ipython.scipy.org/moin/>`_.
10   In the future, web or desktop graphical user interfaces could be written using this API to assist SPR users with common data anaylsis procedures.
11  
12 + To use Osprai, set your Python path environment variable to the location where it is installed.
13 + This can be done from the shell (bash example)::
14 +
15 +  $ export PYTHONPATH=/home/user/osprai/trunk
16 +  $ ipython
17 +  
18 + Alternatively, the path can be set from inside the Python interpreter (IPython example)::
19 +
20 +  >>> import sys
21 +  >>> sys.path.append('/home/user/osprai/trunk')
22 +  >>> import osprai_one as osp
23 +  >>> help osp
24 +
25 +
26   The Python Source Code
27   ======================
28  
# Line 27 | Line 41
41   .. automodule:: mdl_module
42     :members:
43  
44 + .. automodule:: fit_module
45 +   :members:
46 +

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines