Quantum Resource Management Interface (QRMI)
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, C and Lua APIs for ease of integration into nearly any computational environment.
The source code to build and deploy QRMI is available here.
An optional task_runner command line tool to execute quantum payloads against quantum hardware is included in the Python package. For more information, read the documentation available here.
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]"
Pip will handle all dependencies automatically and you will always install the latest (and most thoroughly 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 repository's Releases tab.
To install from source, follow the instructions in the documentation.
Getting Started
You can explore the full range of example code here. Each example directory includes a README containing more details.
One example of QRMI usage in a compute infrastructure project is the Slurm plugin for quantum resources. QRMI is used in these Slurm plugins to control quantum resources during the lifecycle of a Slurm job. You can find full details of the implementation of Quantum SPANK plugins for Slurm here.
Citing QRMI
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.
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.
For further questions, comments and discussion, please consider joining the Qiskit Slack community.
Frequently Asked Questions
A list of frequently asked questions is maintained here.
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, https://cci.rpi.edu/
- Alice & Bob https://alice-bob.com/
1 maintainer
Metadata
1 maintainer
Release files for qrmi 0.25.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| qrmi-0.25.0.tar.gz | 778.4 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| qrmi-0.25.0-cp311-abi3-manylinux_2_28_x86_64.whl | CPython 3.11 | abi3 | Linux glibc 2.28+ x86-64 | Details |
| qrmi-0.25.0-cp311-abi3-manylinux_2_28_ppc64le.whl | CPython 3.11 | abi3 | Linux glibc 2.28+ PowerPC 64-le | Details |
| qrmi-0.25.0-cp311-abi3-manylinux_2_28_aarch64.whl | CPython 3.11 | abi3 | Linux glibc 2.28+ ARM64 | Details |
Total release size: 31.4 MB
Release files / qrmi-0.25.0.tar.gz
| Download URL | qrmi-0.25.0.tar.gz |
|---|---|
| Size | 778.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5bc00b2360f8a6afb71adff90980dabaf6a3d6eadc6247b306ac6ab361afe0e3
|
|
BLAKE2b-256 checksum How to use checksums |
d4f7f02d43c66834d34cffdd6ab4730c7443688509f17fc1ff2a231ba80c12ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / qrmi-0.25.0-cp311-abi3-manylinux_2_28_x86_64.whl
| Download URL | qrmi-0.25.0-cp311-abi3-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 9.4 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
1033191aa60d7016912dbbac39abcca8056be436de261cc4c248dd77e6260a5c
|
|
BLAKE2b-256 checksum How to use checksums |
d2b7726d4bae3185f0c3a717102089e0cb1a311e026bb0b4f408bc94f97bf695
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / qrmi-0.25.0-cp311-abi3-manylinux_2_28_ppc64le.whl
| Download URL | qrmi-0.25.0-cp311-abi3-manylinux_2_28_ppc64le.whl |
|---|---|
| Size | 11.9 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ PowerPC 64-le abi3 |
|
SHA-256 checksum How to use checksums |
5fa966446f65151f9f58276225fcef2ea9b046a8d6f791b3735eb00dfed1053a
|
|
BLAKE2b-256 checksum How to use checksums |
445071e4da137fe4656fff810c03f116152dd6b741771c401f879747fe152ec5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency logRelease files / qrmi-0.25.0-cp311-abi3-manylinux_2_28_aarch64.whl
| Download URL | qrmi-0.25.0-cp311-abi3-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 9.3 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
874801101fae94231ab532ae07a43f21b56781a3088a31c0c7a9c8dd9ddcdeec
|
|
BLAKE2b-256 checksum How to use checksums |
8b3302a6c17c89d4c0790393621888f1c82792751c9e1942cb8de48b8afebcfa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 26, 2026.
Transparency log
