:notoc:

.. pandas documentation master file, created by

.. module:: itpseq

********************
itpseq documentation
********************

**Date**: |today| **Version**: |release|

**Useful links**:
`Installation Repository <https://pypi.org/project/itpseq>`__ |
`Source Repository <https://github.com/t-renault/itpseq>`__ |
`Issues & Ideas <https://github.com/t-renault/itpseq/issues>`__ 

:mod:`itpseq` is an open source library written in Python to process iTP-Seq (inverse-toeprinting) data.

Quickstart:
 - :ref:`whatis_itpseq`
 - :ref:`Install<Installation>` from PyPi with ``pip install -U itpseq``
 - :ref:`Command line<command_line>` help: ``itpseq --help``
 - As a Python module: ``import itpseq``

.. grid:: 1 2 2 3
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card::  User guide & Tutorials
        :img-top: _static/icon_user_guide.svg
        :class-card: intro-card
        :shadow: md

        The user guide provides in-depth information on iTP-Seq and the `itpseq` library.

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the user guide

    .. grid-item-card::  API reference
        :img-top: _static/icon_api.svg
        :class-card: intro-card
        :shadow: md

        The reference guide contains a detailed description of
        the itpseq API. The reference describes how the methods work and which parameters can
        be used.

        +++

        .. button-ref:: api
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the reference guide


.. toctree::
    :maxdepth: 2
    :hidden:
    :titlesonly:

    user_guide/index
    api/index

