ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/_build/html/_sources/mainapi.txt
Revision: 53
Committed: Wed Feb 16 01:56:39 2011 UTC (9 years, 8 months ago) by clausted
File size: 780 byte(s)
Log Message:
Add mdl_module documentation.  Also add sphinx html output to svn repository.
Line User Rev File contents
1 clausted 53 .. 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:: ba_class
16     :members:
17    
18     .. automodule:: vu_module
19     :members:
20    
21     .. automodule:: cal_module
22     :members:
23    
24     .. automodule:: io_module
25     :members:
26    
27     .. automodule:: mdl_module
28     :members: