***********************************
Welcome to NGCloud's documentation!
***********************************

.. only:: html

    .. image:: https://pypip.in/py_versions/ngcloud/badge.svg?style=flat
        :target: https://pypi.python.org/pypi/ngcloud
        :width: 103px
        :alt: python 3.3+

    .. image:: https://pypip.in/wheel/ngcloud/badge.svg?style=flat
        :target: https://pypi.python.org/pypi/ngcloud
        :width: 73px
        :alt: wheel supported

    .. image:: https://pypip.in/license/ngcloud/badge.svg?style=flat
        :target: https://pypi.python.org/pypi/ngcloud
        :width: 79px
        :alt: MIT

    |

    **Version**: |version|

    **Last update**: |today|


Introduction
============

**NGCloud** is a Python package to automatically generate readable reports from some common NGS analysis pipeline such as Tuxedo or GATK, and make me not fuck up anything.

.. note:: If you are looking for the manual for result pages generated by NGCloud, you have come to the *wrong* place. Result manual for each pipeline is at different repository respectively.

    Manual usually ships with the result. If not, please contact the developers to get the right link.


Contents
========

.. toctree::
    :maxdepth: 2

    install
    tutorial/index.rst
    module_api/ngcloud
    develop
    contributing
    changelog