BanzaiDB
========

BanzaiDB is a tool for pairing Microbial Genomics Next Generation Sequencing 
(NGS) analysis with a NoSQL_ database. We use the RethinkDB_ NoSQL database.

BanzaiDB:
    * initalises the NoSQL database and associated tables,
    * populates the database with results of NGS experiments/analysis and,
    * provides a set of query functions to wrangle with the data stored within 
      the database.


BanzaiDB documentation contents
-------------------------------

User documentation
~~~~~~~~~~~~~~~~~~

Learn how to initalise a database, populate the database and query it!

.. toctree::
   :maxdepth: 1

   installation.rst 
   init.rst
   getting-metadata-into-banzaiDB.rst


API documentation
~~~~~~~~~~~~~~~~~

Explore the available methods within BanzaiDB.

.. toctree::
   :maxdepth: 1

   modules.rst


Developer documentation
~~~~~~~~~~~~~~~~~~~~~~~

Learn how to contribute to the development of BanzaiDB.

.. toctree::
   :maxdepth: 1

   developer.rst


Indices and tables
------------------

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



.. _RethinkDB: http://www.rethinkdb.com
.. _NoSQL: http://nosql-database.org
