.. _install:

=====================================
Installation, testing and development
=====================================

Dependencies
------------

pyts requires:

- Python (>= 3.8)
- NumPy (>= 1.22.4)
- SciPy (>= 1.8.1)
- Scikit-Learn (>= 1.2.0)
- Joblib (>= 1.1.1)
- Numba (>= 0.55.2)

To run the examples, Matplotlib (>= 2.0.0) is required.


User installation
-----------------

If you already have a working installation of numpy, scipy, scikit-learn,
joblib and numba, you can easily install pyts using ``pip``::

    pip install pyts

or ``conda`` via the ``conda-forge`` channel::

    conda install -c conda-forge pyts

You can also get the latest version of pyts by cloning the repository::

    git clone https://github.com/johannfaouzi/pyts.git
    cd pyts
    pip install .


Testing
-------

After installation, you can launch the test suite from outside the source
directory using ``pytest``::

    pytest pyts


Development
-----------

The development of this package is in line with the one of the scikit-learn
community. Fore more information about our contributing guidelines, please
refer to the :ref:`contribute`.