.. _welcome:

Welcome to velocyto.py!
=======================

Velocyto is a library for the analysis of RNA velocity.

Velocyto includes a :ref:`command line tool <cli>` and an :ref:`analysis pipeline <analysis>`

.. warning::
    **CLI** API has been improved and differs from previous versions. Please refer to the updated :ref:`CLI tutorial <cli>` and :ref:`API session <cliapi>` to know more about the changes.

.. warning::
   velocyto-team is about to release velocyto.py v1.0 in the meanwhile API will be subject to minor changes until 1.0 release.

.. note::
   Please do not hesitate to report issues on our `Github page <https://github.com/velocyto-team/velocyto.py>`_.
   We try to respond within the few hours to all the users.

Contents
========


.. toctree::
   :hidden:

   self

.. toctree::

   install/index

.. toctree::

   tutorial/index

.. toctree::

   fullapi/index

.. toctree::

   notebooks/index

.. toctree::

   changelog

.. toctree::

   license/index

.. toctree::

   citing/index

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

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