.. SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
..
.. SPDX-License-Identifier: GPL-3.0-or-later

.. _ptbench.install:

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

.. todo:: fine-tune installation instructions for ptbench here


We support two installation modes, through pip_, or mamba_ (conda).


With pip
--------

.. code-block:: sh

   # stable, from PyPI:
   $ pip install ptbench

   # latest beta, from GitLab package registry:
   $ pip install --pre --index-url https://gitlab.idiap.ch/api/v4/groups/biosignal/software/-/packages/pypi/simple --extra-index-url https://pypi.org/simple ptbench

.. tip::

   To avoid long command-lines you may configure pip to define the indexes and
   package search priorities as you like.


With conda
----------

.. code-block:: sh

   # stable:
   $ mamba install -c https://www.idiap.ch/software/biosignal/software/conda -c conda-forge ptbench

   # latest beta:
   $ mamba install -c https://www.idiap.ch/software/biosignal/software/conda/label/beta -c conda-forge ptbench


.. include:: links.rst