ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/osprai/osprai/trunk/sphinx/_build/html/index.html
Revision: 54
Committed: Wed Feb 16 21:29:02 2011 UTC (8 years, 3 months ago) by clausted
File size: 8768 byte(s)
Log Message:
Added fit_module and mdl_module to sphinx documentation.
Line File contents
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4 <html xmlns="http://www.w3.org/1999/xhtml">
5 <head>
6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
7
8 <title>Welcome to the OSPRAI documentation! &mdash; osprai-doc v0.5-110215 documentation</title>
9 <link rel="stylesheet" href="_static/default.css" type="text/css" />
10 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
11 <script type="text/javascript">
12 var DOCUMENTATION_OPTIONS = {
13 URL_ROOT: '#',
14 VERSION: '0.5-110215',
15 COLLAPSE_MODINDEX: false,
16 FILE_SUFFIX: '.html',
17 HAS_SOURCE: true
18 };
19 </script>
20 <script type="text/javascript" src="_static/jquery.js"></script>
21 <script type="text/javascript" src="_static/doctools.js"></script>
22 <link rel="top" title="osprai-doc v0.5-110215 documentation" href="#" />
23 <link rel="next" title="OSPRAI Tutorial 1" href="tutorial01.html" />
24 </head>
25 <body>
26 <div class="related">
27 <h3>Navigation</h3>
28 <ul>
29 <li class="right" style="margin-right: 10px">
30 <a href="genindex.html" title="General Index"
31 accesskey="I">index</a></li>
32 <li class="right" >
33 <a href="modindex.html" title="Global Module Index"
34 accesskey="M">modules</a> |</li>
35 <li class="right" >
36 <a href="tutorial01.html" title="OSPRAI Tutorial 1"
37 accesskey="N">next</a> |</li>
38 <li><a href="#">osprai-doc v0.5-110215 documentation</a> &raquo;</li>
39 </ul>
40 </div>
41
42 <div class="document">
43 <div class="documentwrapper">
44 <div class="bodywrapper">
45 <div class="body">
46
47 <div class="section" id="welcome-to-the-osprai-documentation">
48 <h1>Welcome to the OSPRAI documentation!<a class="headerlink" href="#welcome-to-the-osprai-documentation" title="Permalink to this headline">¶</a></h1>
49 <p>OSPRAI is Open-source SPR Analysis and Integration software.
50 Its aim is to provide a set of command-line tools for processing high-throughput biosensor data.
51 With OSPRAI, you can import and export common formats, annotate sensorgrams,
52 and perform calibration, background subtraction, and curve-fitting.</p>
53 <p>OSPRAI is written in <a class="reference external" href="http://www.python.org">Python</a> so as to run on all popular platforms, including Linux, Windows, and Macintosh.
54 Install Python 2.4 (or newer) and the following libraries: <a class="reference external" href="http://wiki.python.org/moin/TkInter">python-tk</a>, <a class="reference external" href="http://matplotlib.sourceforge.net/">matplotlib</a>, and <a class="reference external" href="http://www.scipy.org">scipy</a>.
55 Additionally, it is useful to install <a class="reference external" href="http://ipython.scipy.org/moin/">IPython</a>, the interaction Python shell,
56 as well as a good python-aware text editor, such as <a class="reference external" href="http://editra.org/">Editra</a>, <a class="reference external" href="http://www.scintilla.org/SciTE.html">Scite</a>, or <a class="reference external" href="http://projects.gnome.org/gedit/">gedit</a>.</p>
57 <p>OSPRAI is hosted by <a class="reference external" href="http://www.bioinformatics.org">Bioinformatics.org</a> and managed using the Subversion version control system.
58 It can be obtained from the <a class="reference external" href="http://www.bioinformatics.org/websvn/listing.php?repname=osprai&amp;path=%2F&amp;sc=0">website</a> or by using a Subversion client such as <a class="reference external" href="http://subversion.apache.org">Svn</a>,
59 <a class="reference external" href="http://www.rabbitvcs.org/">RabbitVCS</a>, or <a class="reference external" href="http://tortoisesvn.tigris.org">TortoiseSVN</a>.
60 Windows users can install all of the necessary prerequisites by installing <a class="reference external" href="http://www.pythonxy.com">PythonXY</a>,
61 while Ubuntu Linux users can find everything they need in the Ubuntu repositories.
62 An example for Ubuntu users follows:</p>
63 <div class="highlight-python"><pre>$ sudo aptitude install python-matplotlib python-scipy python-tk ipython editra
64 $ svn checkout svn://bioinformatics.org/svnroot/osprai</pre>
65 </div>
66 <p>Contents:</p>
67 <ul>
68 <li class="toctree-l1"><a class="reference external" href="tutorial01.html">OSPRAI Tutorial 1</a><ul>
69 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#viewing-data-from-an-spr-file">Viewing data from an SPR file</a></li>
70 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#calibration-and-background-subtraction">Calibration and background subtraction</a></li>
71 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#data-simulation">Data simulation</a></li>
72 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#curve-fitting">Curve-fitting</a></li>
73 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#file-format-conversion">File format conversion</a></li>
74 <li class="toctree-l2"><a class="reference external" href="tutorial01.html#online-help">Online help</a></li>
75 </ul>
76 </li>
77 <li class="toctree-l1"><a class="reference external" href="mainapi.html">The Application Program Interface</a></li>
78 <li class="toctree-l1"><a class="reference external" href="mainapi.html#module-fit_module">The Python Source Code</a><ul>
79 <li class="toctree-l2"><a class="reference external" href="mainapi.html#ba-class">ba_class</a></li>
80 <li class="toctree-l2"><a class="reference external" href="mainapi.html#vu-module">vu_module</a></li>
81 <li class="toctree-l2"><a class="reference external" href="mainapi.html#cal-module">cal_module</a></li>
82 <li class="toctree-l2"><a class="reference external" href="mainapi.html#io-module">io_module</a></li>
83 <li class="toctree-l2"><a class="reference external" href="mainapi.html#mdl-module">mdl_module</a></li>
84 <li class="toctree-l2"><a class="reference external" href="mainapi.html#fit-module">fit_module</a></li>
85 </ul>
86 </li>
87 </ul>
88 <div class="section" id="indices-and-tables">
89 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
90 <ul class="simple">
91 <li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
92 <li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
93 <li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
94 </ul>
95 </div>
96 </div>
97
98
99 </div>
100 </div>
101 </div>
102 <div class="sphinxsidebar">
103 <div class="sphinxsidebarwrapper">
104 <h3><a href="#">Table Of Contents</a></h3>
105 <ul>
106 <li><a class="reference external" href="#">Welcome to the OSPRAI documentation!</a><ul>
107 <li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
108 </ul>
109 </li>
110 </ul>
111
112 <h4>Next topic</h4>
113 <p class="topless"><a href="tutorial01.html"
114 title="next chapter">OSPRAI Tutorial 1</a></p>
115 <h3>This Page</h3>
116 <ul class="this-page-menu">
117 <li><a href="_sources/index.txt"
118 rel="nofollow">Show Source</a></li>
119 </ul>
120 <div id="searchbox" style="display: none">
121 <h3>Quick search</h3>
122 <form class="search" action="search.html" method="get">
123 <input type="text" name="q" size="18" />
124 <input type="submit" value="Go" />
125 <input type="hidden" name="check_keywords" value="yes" />
126 <input type="hidden" name="area" value="default" />
127 </form>
128 <p class="searchtip" style="font-size: 90%">
129 Enter search terms or a module, class or function name.
130 </p>
131 </div>
132 <script type="text/javascript">$('#searchbox').show(0);</script>
133 </div>
134 </div>
135 <div class="clearer"></div>
136 </div>
137 <div class="related">
138 <h3>Navigation</h3>
139 <ul>
140 <li class="right" style="margin-right: 10px">
141 <a href="genindex.html" title="General Index"
142 >index</a></li>
143 <li class="right" >
144 <a href="modindex.html" title="Global Module Index"
145 >modules</a> |</li>
146 <li class="right" >
147 <a href="tutorial01.html" title="OSPRAI Tutorial 1"
148 >next</a> |</li>
149 <li><a href="#">osprai-doc v0.5-110215 documentation</a> &raquo;</li>
150 </ul>
151 </div>
152 <div class="footer">
153 &copy; Copyright 2011, Christopher Lausted.
154 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
155 </div>
156 </body>
157 </html>