ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/mainapi.rst
Revision: 46
Committed: Fri Feb 4 00:29:01 2011 UTC (8 years ago) by clausted
File size: 692 byte(s)
Log Message:
Update the sphinx documentation.  Add a new file called mainapi.rst to join tutorial01.rst and index.rst.  
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 The Python Source Code
13 ======================
14
15 .. automodule:: vu_module
16 :members:
17
18 .. automodule:: io_module
19 :members:
20
21 .. automodule:: ba_class
22 :members: