.. Tentacle documentation master file, created by
   sphinx-quickstart on Tue Feb 11 11:08:25 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================================
Tentacle |version|  documentation
=================================

:Authors: Fredrik Boulund, Anders Sjögren, Erik Kristiansson
:Contact: fredrik.boulund@chalmers.se
:License: GPL

Welcome! This is the documentation for Tentacle |release|, last updated |today|.

The documentation is available online at

http://bioinformatics.math.chalmers.se/tentacle/.

Tentacle is published as open-source under the GNU Public License (v3) and you
are welcome to look at, improve, or come with suggestions for improvement to
the code at the project's Bitbucket_ page.

.. _Bitbucket: https://bitbucket.org/chalmersmathbioinformatics/tentacle/.

.. _`citing`:

Citing Tentacle
***************
If you find Tentacle useful and use it in your research, please cite us!.
The framework is described in the following paper:

Boulund, F., Sjögren, A., Kristiansson, E. (2014). 
*Tentacle: distributed gene quantification in metagenomes*.
**(submitted)**

Documentation:
**************

.. toctree::
   :maxdepth: 2

   introduction
   download
   installation
   tutorial
   running
   output
   parsers
   coverage
   mappers
   choosing_mapper
   performance

..   modules
   

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`