ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/mainapi.rst
Revision: 54
Committed: Wed Feb 16 21:29:02 2011 UTC (8 years, 4 months ago) by clausted
File size: 1233 byte(s)
Log Message:
Added fit_module and mdl_module to sphinx documentation.
Line File contents
1 .. Osprai documentation file `mainapi.rst`
2 Last modified 110203 (yymmdd) CGL
3
4
5 The Application Program Interface
6 =================================
7
8 The Osprai API is the set of public functions and classes contained in the ``osprai_one`` module.
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
29 .. automodule:: ba_class
30 :members:
31
32 .. automodule:: vu_module
33 :members:
34
35 .. automodule:: cal_module
36 :members:
37
38 .. automodule:: io_module
39 :members:
40
41 .. automodule:: mdl_module
42 :members:
43
44 .. automodule:: fit_module
45 :members: