..
    SPDX-FileCopyrightText: 2022 Tanguy Fardet
    SPDX-License-Identifier: CC-BY-SA-4.0
    docs/user/install.rst

============
Installation
============

Dependencies
============

Regardless of your needs, the following libraries are required:

* `numpy <https://www.numpy.org>`_
* `scipy <https://www.scipy.org>`_
* `pandas <https://pandas.pydata.org>`_
* `pint <https://pint.readthedocs.io>`_ >= 0.19
* `seaborn <https://seaborn.pydata.org>`_

These can be installed directly via `pip`.
If you downloaded the code, you can just go to the folder and do: ::

    pip install -r requirements.txt


Installing the library on your system
=====================================

Once the library is more stable, I will move it to PyPi; in the meantime, you
can use: ::

    pip install git+https://git.sr.ht/~tfardet/OrgMatt

If you want to tinker with the code, you can also download it and use an
editable install via: ::

    git clone https://git.sr.ht/~tfardet/OrgMatt
    cd OrgMatt
    pip install -e .