Installation

Two setups are possible and described below: developer and user.

Common requirements

  • Python >= 3.9, < 3.12 ; recommended: 3.11

  • Pip

  • (Optional) Conda if the system’s Python version is not suitable

User setup

Use this setup if you do not plan on making modifications to one of Qualia’s component source code. You can still develop your own, independent plugin with this setup.

You can either install Qualia in an existing virtual environment with Pip, or create a new environment managed by PDM.

Existing Python environment with Pip

Any component of Qualia can be installed with pip in an existing environment.

You can also create a virtual environment for Qualia yourself.

Optional dependency groups must be specified in brackets after the package name, e.g., qualia-core[pytorch].

The public open-source release is hosted on the official PyPI index. The private development release is hosted on our private PyPI server and requires specifying its URL.

For example, to install Qualia-Core with PyTorch and ClearML support:

pip install -U qualia-core[pytorch,clearml]

A Qualia component will automatically pull any other required Qualia components.

Dedicated environment with PDM

Additional requirements

  • PDM

    • On Ubuntu >= 22.10: sudo apt install python3-pdm

    • Or with Pip: pip install pdm

Dowload and extract the base Qualia project

Download: https://github.com/LEAT-EDGE/qualia/archive/refs/heads/master.tar.gz

Extract it:

tar -xvf qualia-master.tar.gz
cd qualia-master

Create a new dedicated in-project virtual environment

If host’s Python version is not 3.11, it is recommended to create a Conda environment with Python 3.11:

pdm venv create -w conda 3.11
pdm use "$(pwd)/.venv/bin/python"

Otherwise you can use a simple virtualenv:

pdm venv create -w virtualenv
pdm use "$(pwd)/.venv/bin/python"

Activate the virtual environment

You will need to perform this step for every new shell you open:

$(pdm venv activate in-project)
export PDM_BUILD_SCM_VERSION=2.3.1.dev1+g21fa6b5

Add a Qualia component to the environment

Add Qualia component, you can specify additional dependency groups in brackets, e.g., for Qualia-Core with Pytorch and ClearML:

pdm add qualia-core[pytorch,clearml]

Repeat this step for any additional Qualia component you want to use, in order from the root of the dependency graph (see Qualia components).

Developer setup

Use this setup if you want to make modifications to one of Qualia’s component source code.

It is recommended to create a new Python environment for Qualia managed by PDM, but you can also install Qualia in an existing virtual environment with Pip.

Additional requirements

  • Git

Existing Python environment with Pip

If you have an existing Python environment with a compatible version of Python, use pip to install Qualia components inside of it.

Clone the repository:

git clone git@github.com:LEAT-EDGE/qualia-core.git

If you do not have an SSH key registered in Gitlab, use the HTTPS URL instead:

git clone https://github.com/LEAT-EDGE/qualia-core.git

Install it, specifying additional dependency groups in brakckets, e.g., for Qualia-Core with PyTorch and ClearML:

cd qualia-core
pip install -e .[pytorch, clearml]

Repeat this step for any additional Qualia component you want to use, in order from the root of the dependency graph (see Qualia components).