Quantum resource management interface (QRMI)

Platform PyPI - Python Version

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

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

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.20.0.tar.gz (358.2 kB view details)

Uploaded Jul 15, 2026 Source

Built Distributions

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

qrmi-0.20.0-cp311-abi3-manylinux_2_28_x86_64.whl (9.1 MB view details)

Uploaded Jul 15, 2026 CPython 3.11+manylinux: glibc 2.28+ x86-64

qrmi-0.20.0-cp311-abi3-manylinux_2_28_ppc64le.whl (11.7 MB view details)

Uploaded Jul 15, 2026 CPython 3.11+manylinux: glibc 2.28+ ppc64le

qrmi-0.20.0-cp311-abi3-manylinux_2_28_aarch64.whl (9.1 MB view details)

Uploaded Jul 15, 2026 CPython 3.11+manylinux: glibc 2.28+ ARM64

File details

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

File metadata

Download URL: qrmi-0.20.0.tar.gz
Upload date: Jul 15, 2026
Size: 358.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qrmi-0.20.0.tar.gz
Algorithm	Hash digest
SHA256	`e9d1eb0f392fd5eeb23079116f2dda45a1ac1f790ff99789896d7a042f88360d`
MD5	`c5aaee02a2fb07d731b9f6e2ffc5e023`
BLAKE2b-256	`c65898894bd057ffd740cdf1858f77587a85f8780ea9ccf8c2001b2c4f43a85f`

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.20.0.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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: qrmi-0.20.0.tar.gz
- Subject digest: e9d1eb0f392fd5eeb23079116f2dda45a1ac1f790ff99789896d7a042f88360d
- Sigstore transparency entry: 2174130025
- Sigstore integration time: Jul 15, 2026
Source repository:
- Permalink: qiskit-community/qrmi@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Branch / Tag: refs/heads/main
- Owner: https://github.com/qiskit-community
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Trigger Event: workflow_dispatch

File details

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

File metadata

Download URL: qrmi-0.20.0-cp311-abi3-manylinux_2_28_x86_64.whl
Upload date: Jul 15, 2026
Size: 9.1 MB
Tags: CPython 3.11+, manylinux: glibc 2.28+ x86-64
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qrmi-0.20.0-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm	Hash digest
SHA256	`b740921bf3bbd0386541412421738689bc8072dbcf09558a5090bd2158f1dd7a`
MD5	`2af201419872a966e2cfe920c34bb112`
BLAKE2b-256	`3998d2970da17a0c36802d36897dd1d9a5bba7e7082446118929b00a302b53de`

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.20.0-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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: qrmi-0.20.0-cp311-abi3-manylinux_2_28_x86_64.whl
- Subject digest: b740921bf3bbd0386541412421738689bc8072dbcf09558a5090bd2158f1dd7a
- Sigstore transparency entry: 2174130353
- Sigstore integration time: Jul 15, 2026
Source repository:
- Permalink: qiskit-community/qrmi@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Branch / Tag: refs/heads/main
- Owner: https://github.com/qiskit-community
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Trigger Event: workflow_dispatch

File details

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

File metadata

Download URL: qrmi-0.20.0-cp311-abi3-manylinux_2_28_ppc64le.whl
Upload date: Jul 15, 2026
Size: 11.7 MB
Tags: CPython 3.11+, manylinux: glibc 2.28+ ppc64le
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qrmi-0.20.0-cp311-abi3-manylinux_2_28_ppc64le.whl
Algorithm	Hash digest
SHA256	`d0da6d724a969e82d1f6ad0c6a7f4b34ebddef830ef37a8ff9e9cbd822ba9199`
MD5	`46aabc1d1f233b28ffe25695822f84b3`
BLAKE2b-256	`d415835955402fd7451bf4029323795854b1ae4c799cc19ef21be666c255a351`

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.20.0-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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: qrmi-0.20.0-cp311-abi3-manylinux_2_28_ppc64le.whl
- Subject digest: d0da6d724a969e82d1f6ad0c6a7f4b34ebddef830ef37a8ff9e9cbd822ba9199
- Sigstore transparency entry: 2174130246
- Sigstore integration time: Jul 15, 2026
Source repository:
- Permalink: qiskit-community/qrmi@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Branch / Tag: refs/heads/main
- Owner: https://github.com/qiskit-community
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Trigger Event: workflow_dispatch

File details

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

File metadata

Download URL: qrmi-0.20.0-cp311-abi3-manylinux_2_28_aarch64.whl
Upload date: Jul 15, 2026
Size: 9.1 MB
Tags: CPython 3.11+, manylinux: glibc 2.28+ ARM64
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qrmi-0.20.0-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm	Hash digest
SHA256	`355faac990da57e647eba1c01aadd021d67af8416d78552d2f9100b2274b1d03`
MD5	`e0ca34dbec293870c550a06a48d19d4e`
BLAKE2b-256	`d94c35e77487682b033c7925f830a843b7f98841ea9bb41918a8849d2079db66`

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.20.0-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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: qrmi-0.20.0-cp311-abi3-manylinux_2_28_aarch64.whl
- Subject digest: 355faac990da57e647eba1c01aadd021d67af8416d78552d2f9100b2274b1d03
- Sigstore transparency entry: 2174130148
- Sigstore integration time: Jul 15, 2026
Source repository:
- Permalink: qiskit-community/qrmi@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Branch / Tag: refs/heads/main
- Owner: https://github.com/qiskit-community
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@2fe630033bdd0287188aff46b2d7f7d63ec8d4c0
- Trigger Event: workflow_dispatch