1 |
.. Osprai documentation master file `index.rst` |
2 |
created by Christopher Lausted in February 2011. |
3 |
Last modified 110203 (yymmdd) CGL. |
4 |
Use reStructuredText (reST) and the `.rst` extension. |
5 |
See <http://sphinx.pocoo.org/rest.html>. |
6 |
To assist viewing differences during version control, try placing a carriage return after every sentence. |
7 |
Python source code docstrings also use reST and should be compatible with Epydoc as well. |
8 |
This file should at least contain the root `toctree` directive. |
9 |
|
10 |
#################################### |
11 |
Welcome to the OSPRAI documentation! |
12 |
#################################### |
13 |
|
14 |
OSPRAI is Open-source SPR Analysis and Integration software. |
15 |
Its aim is to provide a set of command-line tools for processing high-throughput biosensor data. |
16 |
With OSPRAI, you can import and export common formats, annotate sensorgrams, and perform calibration, background subtraction, and curve-fitting. |
17 |
|
18 |
OSPRAI is written in Python so as to run on all popular platforms, including Linux, Windows, and Macintosh. |
19 |
Install Python 2.4 (or newer) and the following libraries: python-tk, matplotlib, and scipy. |
20 |
Additionally, it is useful to install IPython, the interaction Python shell, as well as a good python-aware text editor, such as Scite or gedit. |
21 |
OSPRAI is hosted by Bioinformatics.org and managed using the Subversion version control system. |
22 |
It can be obtained from the website or by using a Subversion client such as |
23 |
`Svn <http://subversion.apache.org>`_, `RapidSVN <http://rapidsvn.tigris.org>`_, or `TortoiseSVN <http://tortoisesvn.tigris.org>`_. |
24 |
Windows users can install all of the necessary prerequisites by installing |
25 |
`PythonXY <http://www.pythonxy.com>`_, while Ubuntu Linux users can find everything they need in the Ubuntu repositories. |
26 |
An example for Ubuntu users follows:: |
27 |
|
28 |
$ sudo aptitude install python-tk python-matplotlib python-scipy ipython scite |
29 |
$ svn checkout svn://bioinformatics.org/svnroot/osprai |
30 |
|
31 |
|
32 |
Contents: |
33 |
|
34 |
.. toctree:: |
35 |
:maxdepth: 2 |
36 |
|
37 |
tutorial01.rst |
38 |
mainapi.rst |
39 |
|
40 |
|
41 |
Indices and tables |
42 |
================== |
43 |
|
44 |
* :ref:`genindex` |
45 |
* :ref:`modindex` |
46 |
* :ref:`search` |