===========
Install ntt
===========

Work in a virtual environment
=============================

It is highly recommended to work inside a `virtual environment`_.

Quick install from GitHub
=========================

.. tab-set::

    .. tab-item:: pip

        You can install ``ntt`` using :program:`pip` :

        .. code-block:: bash

            $ pip install git+https://github.com/centralelyon/ntt.git@maininstall ntt

    .. tab-item:: conda

        You can install ``ntt`` using :program:`conda` if / when it will be
        packaged for this tool.

Editable install for development
================================

To develop "ntt" library, make an editable install inside your Python `virtual
environment`_ using pip with ``-e`` `editable flag`_.

1. create a virtual environment and activate it
2. clone this ntt repository
3. install ntt and its "development" dependencies

.. _PyPI: https://pypi.org/project/ntt
.. _virtual environment: https://docs.python.org/3.9/library/venv.html
.. _editable flag: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs