Quantum resource management interface (QRMI)

License Current Release Platform PyPI - Python Version manylinux: 2_28 C99 Lua 5.4+ Minimum rustc 1.91 Downloads Downloads DOI arXiv CI

[!IMPORTANT] Deprecation notice (since v0.23.0)

The IBM Qiskit Runtime Service API has been renamed to the IBM Quantum Compute Service API. Resource names and environment variable prefixes have changed accordingly. Legacy names remain supported until November 21, 2026. See the migration guide for details.

The Quantum resource management interface (QRMI) is a vendor-agnostic library for high-performance compute (HPC) systems to access, control, and monitor the behavior of quantum computational resources. It acts as a thin middleware layer that abstracts away the complexities associated with controlling quantum resources through a set of simple APIs. Written in Rust, this interface also exposes Python and C APIs for ease of integration into nearly any computational environment.

Find the source code to build and deploy QRMI in this GitHub repository.

An optional task_runner command line tool to execute quantum payloads against quantum hardware is included in the Python package. Find the full documentation in the GitHub repository.

Installation

Python

We encourage installing QRMI via pip:

pip install qrmi

To use a specific quantum resource, install QRMI with the corresponding optional dependencies:

pip install "qrmi[ibm]"       # Include dependencies for IBM
pip install "qrmi[iqm]"       # Include dependencies for IQM
pip install "qrmi[pasqal]"    # Include dependencies for Pasqal
pip install "qrmi[alice-bob]" # Include dependencies for Alice and Bob
pip install "qrmi[all]"       # Include dependencies for all quantum resources except `alice-bob`

Or combine multiple resources:

pip install "qrmi[ibm,pasqal]"

[!NOTE] Note: ibm and iqm extras cannot be installed together, as they depend on incompatible versions of Qiskit.

[!NOTE] Note: alice-bob cannot be installed alongside ibm or iqm, as it depends on Qiskit versions earlier than 2.0.

Pip will handle all dependencies automatically and you will always install the latest (and well-tested) version.

To install from source, follow the instructions in the documentation.

Standalone C library

Prebuilt binaries for Linux(glibc 2.28 compatible) on x86_64, ppc64le, and aarch64 platforms are available for download from the Releases tab of this GitHub repository.

To install from source, follow the instructions in the documentation.

Getting Started

This GitHub repository contains a variety of example code. See the README in each directory for details.

One of example of usage of QRMI in compute infrastrcture project is Slurm plugin for quantum resources. QRMI is used in Slurm plugin to control quantum resources during lifetime of Slurm job. See implementation and documentation of Quantum spank plugins for Slurm.

How to Cite This Work

QRMI is the work of many people who contribute to the project at different levels. If you use QRMI, please consider citing the associated overview paper Quantum resources in resource management systems. This helps support the continued development and visibility of the repository. The BibTeX citation handle can be found in the BibTeX file file.

Note we expect multiple versions of the overview paper to be released as the project evolves.

Contribution Guidelines

For information on how to contribute to this project, please take a look at our contribution guidelines.

If you'd like to contribute to QRMI, please take a look at our contribution guidelines. By participating, you are expected to uphold our code of conduct.

We use GitHub issues for tracking requests and bugs. Please join the Qiskit Slack community for discussion, comments, and questions.

Frequently Asked Questions

Refer this document.

References and Acknowledgements

  1. Quantum spank plugins for Slurm https://github.com/qiskit-community/spank-plugins
  2. Slurm documentation https://slurm.schedmd.com/
  3. Qiskit https://www.ibm.com/quantum/qiskit
  4. IBM Quantum https://www.ibm.com/quantum
  5. Pasqal https://pasqal.com
  6. STFC The Hartree Centre, https://www.hartree.stfc.ac.uk. This work was supported by the Hartree National Centre for Digital Innovation (HNCDI) programme.
  7. Rensselaer Polytechnic Institute, Center for Computational Innovation, http://cci.rpi.edu/
  8. Alice & Bob https://alice-bob.com/

Project links

Data verified by PyPI on Aug 28, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.24.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ohtanim from gravatar.com ohtanim

Credits

Author: Alice and Bob, IBM, Pasqal SAS and UKRI-STFC (Hartree Centre)

GitHub Statistics

Data verified by PyPI on Aug 28, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

Apache-2.0
View SPDX License List

Requires

Python >=3.11

Provides Extra

alice-bob all ibm iqm pasqal

Tags

quantum-computing quantum-programming-language qiskit pulser slurm slurm-job-scheduler slurm-workload-manager python rust

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qrmi-0.24.1.tar.gz (421.7 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qrmi-0.24.1-cp311-abi3-manylinux_2_28_x86_64.whl (9.3 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ x86-64

qrmi-0.24.1-cp311-abi3-manylinux_2_28_ppc64le.whl (11.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ppc64le

qrmi-0.24.1-cp311-abi3-manylinux_2_28_aarch64.whl (9.2 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

File details

Details for the file qrmi-0.24.1.tar.gz.

File metadata

  • Download URL: qrmi-0.24.1.tar.gz
  • Upload date:
  • Size: 421.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qrmi-0.24.1.tar.gz
Algorithm Hash digest
SHA256 5e25e8f625f34fb16492225eca28865bbcfa53b2bf9579d52e17493df319aee0
MD5 45bea9046964c5f33dd726444f6aac97
BLAKE2b-256 34cfd75412af229128c80c1377592e13fea75151735d646b26c75a44a38afa23

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.1.tar.gz:

Publisher: release.yml on qiskit-community/qrmi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qrmi-0.24.1-cp311-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qrmi-0.24.1-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e99e4473869b5474c7ea2d03f83e166f51c97a12c623f15835cb0d1f21100fa2
MD5 efd0178f35470d590c6c448684ba0aa7
BLAKE2b-256 c298b6b723a82f201b8c39e8339fdbfdec4c07b4e383aeed455d0afe0f90cdc5

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.1-cp311-abi3-manylinux_2_28_x86_64.whl:

Publisher: release.yml on qiskit-community/qrmi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qrmi-0.24.1-cp311-abi3-manylinux_2_28_ppc64le.whl.

File metadata

File hashes

Hashes for qrmi-0.24.1-cp311-abi3-manylinux_2_28_ppc64le.whl
Algorithm Hash digest
SHA256 9846a904d97792a9cfe47ff4aa570cf1556d3d0306c81e98a4654121c0993cd0
MD5 1fb9e6482c87021c39c09e96197c608a
BLAKE2b-256 66a5649654c6c3fa5a8bde54c4cb507dd5cfc1d6f922761632f1daba9ef7e239

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.1-cp311-abi3-manylinux_2_28_ppc64le.whl:

Publisher: release.yml on qiskit-community/qrmi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qrmi-0.24.1-cp311-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qrmi-0.24.1-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 1f531994bebbe79e22c7d067cdb10b5dbb9f29fc057ac2dcefe859c154393ec0
MD5 c524a221d4042aceefeda2da83ee1f2f
BLAKE2b-256 54d664a455bf97cfd5c6f4d61a35b3fc6f29e2bc66a2a05c87086766190f2509

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.1-cp311-abi3-manylinux_2_28_aarch64.whl:

Publisher: release.yml on qiskit-community/qrmi

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.24.2

4 files

This release

0.24.1 This release

4 files

0.24.0

4 files

0.23.1

4 files

0.23.0

4 files

0.22.0

4 files

0.21.1

4 files

0.21.0

4 files

0.20.1

4 files

0.20.0

4 files

0.19.1

4 files

0.19.0

4 files

0.18.0

4 files

0.17.2

4 files

0.17.1

4 files

0.17.0

4 files

0.16.0

4 files

0.15.0

4 files

0.14.3

4 files

0.14.2

4 files

0.14.1

4 files

0.14.0

4 files

0.13.3

2 files

0.13.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page