.. _installationguide:

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

scPhylo-tools requires Python 3.11 or later.

Using PyPI
^^^^^^^^^^

To install scphylo-tools from PyPI_, run::

    pip install scphylo-tools

If you encounter a ``Permission denied`` error, use
``pip install scphylo-tools --user`` instead.


Development Version
^^^^^^^^^^^^^^^^^^^

To work with the latest development version, install directly from GitHub_::

    git clone https://github.com/faridrashidi/scphylo-tools
    cd scphylo-tools
    make install-dev

Your contributions to improve scPhylo-tools are highly appreciated! Please
refer to our `contributing guide`_.

If you encounter any issues, please feel free to open a `GitHub issue`_.

.. _PyPI: https://pypi.org/project/scphylo-tools
.. _Github: https://github.com/faridrashidi/scphylo-tools
.. _Github issue: https://github.com/faridrashidi/scphylo-tools/issues/new/choose
.. _contributing guide: https://github.com/faridrashidi/scphylo-tools/blob/master/CONTRIBUTING.rst