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, 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.
We encourage installing QRMI via pip:
pip install qrmiTo 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
ibm and iqm extras cannot be installed together, as they depend on incompatible versions of Qiskit.
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 most thoroughly tested) version.
To install from source, follow the instructions in the documentation.
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.
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.
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.
Note
We expect multiple versions of the overview paper to be released as the project evolves.
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.
A list of frequently asked questions is maintained here.
- 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/