.. Osprai documentation file `mainapi.rst`
   Last modified 110203 (yymmdd) CGL


The Application Program Interface
=================================

The Osprai API is the set of public functions and classes contained in the ``osprai_one`` module.
The API provides an interface to the software from a python command line, such as `IPython <http://ipython.scipy.org/moin/>`_.
In the future, web or desktop graphical user interfaces could be written using this API to assist SPR users with common data anaylsis procedures.

To use Osprai, set your Python path environment variable to the location where it is installed.
This can be done from the shell (bash example)::

  $ export PYTHONPATH=/home/user/osprai/trunk
  $ ipython
  
Alternatively, the path can be set from inside the Python interpreter (IPython example)::

  >>> import sys
  >>> sys.path.append('/home/user/osprai/trunk')
  >>> import osprai_one as osp
  >>> help osp


The Python Source Code
======================

.. automodule:: ba_class
   :members:
   
.. automodule:: vu_module
   :members:
   
.. automodule:: cal_module
   :members:

.. automodule:: io_module
   :members:
   
.. automodule:: mdl_module
   :members:

.. automodule:: fit_module
   :members: