installation.rst

Installation

DrEvalPy can be installed on all three major platforms (Linux, MacOS, Windows). If something goes wrong, feel free to open an issue on GitHub.

With Conda

DrEvalPy requires python >=3.11. Best practice is to use a clean (mamba) or conda environment (Miniconda). Mamba is automatically installed when downloading (Miniforge) and is generally faster and better at resolving dependencies. Follow the installation guide for your operating system, then create a new environment using

mamba create -y -n drevalpy python=3.13

DrEvalPy is listed on the Python Package Index (PyPI) and can be installed with pip. Activate your conda environment (or skip this if you use a system wide python installation) and install the package using

mamba activate drevalpy
pip install drevalpy

With venv

DrEvalPy can also be installed using the built-in venv module. First, create a new environment and activate it:

python -m venv drevalpy-env
source drevalpy-env/bin/activate

Then, install the package using pip:

pip install drevalpy

With Docker

DrEvalPy is available as a Docker image.

Pull the image:

docker pull ghcr.io/daisybio/drevalpy:latest

Run the image:

docker run -it ghcr.io/daisybio/drevalpy:latest

From Source

To install DrEvalPy from source, clone the repository and install the package using Poetry (ensure that Poetry is >=1.2.0 because otherwise, the group dependencies will not work, e.g., 2.1.3 works):

git clone https://github.com/daisybio/drevalpy.git
cd drevalpy
mamba create -y -n drevalpy python==3.13 poetry==2.1.3
poetry --version
pip install poetry-plugin-export
poetry install

Now, you can test the functionality quickly via drevalpy --help. Or take a look at the Quickstart documentation.