Add missing doc files
[jabaws.git] / binaries / src / ViennaRNA / doc / latex / index.tex
1 \par
2
3
4
5
6 \subsection*{A Library for folding and comparing R\-N\-A secondary structures}
7
8
9
10 \par
11
12
13 \begin{DoxyDate}{Date}
14 1994-\/2012 
15 \end{DoxyDate}
16 \begin{DoxyAuthor}{Authors}
17 Ivo Hofacker, Peter Stadler, Ronny Lorenz and many more
18 \end{DoxyAuthor}
19 \subsubsection*{Table of Contents}
20
21
22
23
24
25 \begin{DoxyItemize}
26 \item \hyperlink{index_mp_intro}{Introduction} \item \hyperlink{group__folding__routines}{R\-N\-A Secondary Structure Folding} \item \hyperlink{mp_parse}{Parsing and Comparing -\/ Functions to Manipulate Structures} \item \hyperlink{mp_utils}{Utilities -\/ Odds and Ends} \item \hyperlink{mp_example}{Example -\/ A Small Example Program} \item mp\-\_\-ref\end{DoxyItemize}
27
28
29 \hypertarget{index_mp_intro}{}\section{Introduction}\label{index_mp_intro}
30 The core of the Vienna R\-N\-A Package (\cite{lorenz:2011},\cite{hofacker:1994}) is formed by a collection of routines for the prediction and comparison of R\-N\-A secondary structures. These routines can be accessed through stand-\/alone programs, such as R\-N\-Afold, R\-N\-Adistance etc., which should be sufficient for most users. For those who wish to develop their own programs we provide a library which can be linked to your own code.
31
32 This document describes the library and will be primarily useful to programmers. However, it also contains details about the implementation that may be of interest to advanced users. The stand-\/alone programs are described in separate man pages. The latest version of the package including source code and html versions of the documentation can be found at \par
33 \par
34  \href{http://www.tbi.univie.ac.at/~ivo/RNA/}{\tt http\-://www.\-tbi.\-univie.\-ac.\-at/$\sim$ivo/\-R\-N\-A/}