ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/index.rst
Revision: 45
Committed: Thu Feb 3 02:52:40 2011 UTC (8 years, 3 months ago) by clausted
File size: 1975 byte(s)
Log Message:
Create a reST version of the tutorial, called tutorial01.rst, based on a html version.  Add a reference to it in index.rst. 
Line File contents
1 .. osprai-doc documentation master file, created by
2 sphinx-quickstart on Mon Jan 31 23:07:52 2011.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6 Welcome to the OSPRAI documentation!
7 ====================================
8
9 Contents:
10
11 .. toctree::
12 :maxdepth: 2
13
14 tutorial01.rst
15
16
17 Overview
18 ========
19
20 OSPRAI is Open-source SPR Analysis and Integration software.
21 Its aim is to provide a set of command-line tools for processing high-throughput biosensor data.
22 With OSPRAI, you can import and export common formats, annotate sensorgrams, and perform calibration, background subtraction, and curvefitting.
23
24
25 Software installation
26 =====================
27
28 OSPRAI is written in Python so as to run on all popular platforms, including Linux, Windows, and Macintosh.
29 Install Python 2.4 (or newer) and the following libraries: python-tk, matplotlib, and scipy.
30 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.
31 OSPRAI is hosted by Bioinformatics.org and managed using the Subversion version control system.
32 It can be obtained from the website or by using a Subversion client such as `Svn <http://subversion.apache.org>`_, `RapidSVN <http://rapidsvn.tigris.org>`_, or `TortoiseSVN <http://tortoisesvn.tigris.org>`_.
33 Windows users can install all of the necessary prerequisites by installing `PythonXY <http://www.pythonxy.com>`_, while Ubuntu Linux users can find everything they need in the Ubuntu repositories.
34 An example for Ubuntu users follows::
35
36 $ sudo aptitude install python-tk python-matplotlib python-scipy ipython scite
37 $ svn checkout svn://bioinformatics.org/svnroot/osprai
38
39
40 API
41 ===
42
43 .. automodule:: vu_module
44 :members:
45
46 .. automodule:: io_module
47 :members:
48
49 .. automodule:: ba_class
50 :members:
51
52 Indices and tables
53 ==================
54
55 * :ref:`genindex`
56 * :ref:`modindex`
57 * :ref:`search`