Installation

This section describes how to install qpmr using pip or from source. It is recommended to install the package inside a virtual environment.

Prerequisites

• Python 3.10 or newer

• pip installed

Creating a virtual environment (recommended)

First, create and activate a virtual environment.

On Linux and macOS:

python -m venv venv
source venv/bin/activate

On Windows:

python -m venv venv
venv\Scripts\activate

Once activated, your shell prompt should indicate that the virtual environment is active.

Installing with pip

The easiest way to install qpmr is via pip:

pip install qpmr

To upgrade to the latest version:

pip install --upgrade qpmr

Installing from source

To install qpmr from source, clone the repository:

git clone https://github.com/LockeErasmus/qpmr.git
cd qpmr

Install the package using pip:

pip install .

For development purposes, you can install the package in editable mode:

pip install -e .