ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/index.rst
Revision: 52
Committed: Fri Feb 11 22:11:13 2011 UTC (8 years, 6 months ago) by clausted
File size: 2666 byte(s)
Log Message:
Add some hyperlinks to the documentation.
Line File contents
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,
17 and perform calibration, background subtraction, and curve-fitting.
18
19 OSPRAI is written in Python_ so as to run on all popular platforms, including Linux, Windows, and Macintosh.
20 Install Python 2.4 (or newer) and the following libraries: python-tk_, matplotlib_, and scipy_.
21 Additionally, it is useful to install IPython_, the interaction Python shell,
22 as well as a good python-aware text editor, such as Editra_, Scite_, or gedit_.
23
24 OSPRAI is hosted by Bioinformatics.org_ and managed using the Subversion version control system.
25 It can be obtained from the website_ or by using a Subversion client such as Svn_,
26 RabbitVCS_, or TortoiseSVN_.
27 Windows users can install all of the necessary prerequisites by installing PythonXY_,
28 while Ubuntu Linux users can find everything they need in the Ubuntu repositories.
29 An example for Ubuntu users follows::
30
31 $ sudo aptitude install python-matplotlib python-scipy python-tk ipython editra
32 $ svn checkout svn://bioinformatics.org/svnroot/osprai
33
34
35 Contents:
36
37 .. toctree::
38 :maxdepth: 2
39
40 tutorial01.rst
41 mainapi.rst
42
43
44 Indices and tables
45 ==================
46
47 * :ref:`genindex`
48 * :ref:`modindex`
49 * :ref:`search`
50
51
52 .. _Python: http://www.python.org
53 .. _python-tk: http://wiki.python.org/moin/TkInter
54 .. _matplotlib: http://matplotlib.sourceforge.net/
55 .. _scipy: http://www.scipy.org
56 .. _IPython: http://ipython.scipy.org/moin/
57 .. _Editra: http://editra.org/
58 .. _Scite: http://www.scintilla.org/SciTE.html
59 .. _gedit: http://projects.gnome.org/gedit/
60 .. _Bioinformatics.org: http://www.bioinformatics.org
61 .. _website: http://www.bioinformatics.org/websvn/listing.php?repname=osprai&path=%2F&sc=0
62 .. _Svn: http://subversion.apache.org
63 .. _RabbitVCS: http://www.rabbitvcs.org/
64 .. _TortoiseSVN: http://tortoisesvn.tigris.org
65 .. _PythonXY: http://www.pythonxy.com