Skip to content

Installation

This page covers how to install the RQM ecosystem packages for development or use.

Prerequisites

  • Python 3.9 or later
  • pip package manager
  • (Optional) A virtual environment manager such as venv or conda

Installing from PyPI

The packages are published to PyPI and can be installed with pip.

pip install rqm-core

pip install rqm-qiskit

Install both at once:

pip install rqm-core rqm-qiskit

Installing from GitHub (Editable)

For development or to track the latest changes, install directly from GitHub in editable mode:

pip install git+https://github.com/RQM-Technologies-dev/rqm-core.git

pip install git+https://github.com/RQM-Technologies-dev/rqm-qiskit.git

To install an editable local clone:

git clone https://github.com/RQM-Technologies-dev/rqm-core.git
cd rqm-core
pip install -e .

git clone https://github.com/RQM-Technologies-dev/rqm-qiskit.git
cd rqm-qiskit
pip install -e .

Setting Up rqm-notebooks

The rqm-notebooks repository contains Jupyter notebooks and does not require a separate package install. Clone the repo and install its dependencies:

git clone https://github.com/RQM-Technologies-dev/rqm-notebooks.git
cd rqm-notebooks
pip install -r requirements.txt
jupyter lab

If you are new to the ecosystem, install both core packages and then clone the notebooks:

# 1. Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# 2. Install the core packages
pip install rqm-core rqm-qiskit

# 3. Clone the notebooks for interactive learning
git clone https://github.com/RQM-Technologies-dev/rqm-notebooks.git
cd rqm-notebooks
pip install -r requirements.txt
jupyter lab

Verifying Your Installation

import rqm_core
import rqm_qiskit
print("RQM ecosystem ready.")

Dependencies

rqm-qiskit depends on rqm-core and will install it automatically if it is not already present. You do not need to install both separately unless you want only the math layer.