Skip to main content

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/

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.2.tar.gz (421.6 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.2-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.2-cp311-abi3-manylinux_2_28_ppc64le.whl (11.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ppc64le

qrmi-0.24.2-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.2.tar.gz.

File metadata

  • Download URL: qrmi-0.24.2.tar.gz
  • Upload date:
  • Size: 421.6 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.2.tar.gz
Algorithm Hash digest
SHA256 7d02746e28de207bcb9de7f3c0b1b5d5a94cf38469bf73599658e51e718ca654
MD5 706d7a1e8ee7a9b3dd9eef6132617616
BLAKE2b-256 3dd1941e4385d6e031435fc2db5f590fd778e32e335f07b0c33fa8b4c8caab1b

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.2.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.2-cp311-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qrmi-0.24.2-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ecc78c66616532cfff2451d5d3999c05edf4e7c349aceddeac955888490b7b67
MD5 c8f7816f8298a666d9b78953b15c025c
BLAKE2b-256 94919c5a0d3ffa1a5fe8be07ec28d94eb13c427fb5ef84bb92c66898ac551226

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.2-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.2-cp311-abi3-manylinux_2_28_ppc64le.whl.

File metadata

File hashes

Hashes for qrmi-0.24.2-cp311-abi3-manylinux_2_28_ppc64le.whl
Algorithm Hash digest
SHA256 eebbee99372a0f71bbd93b93c6393f65707cf3d87b31428607a14946138b4637
MD5 285fa0edda90e26a058e7f47df1e5c15
BLAKE2b-256 bc75f1e4f7d2d91b4f26924bd34ba8dcdafe51f0855c96e0137ba822f2ca235f

See more details on using hashes here.

Provenance

The following attestation bundles were made for qrmi-0.24.2-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.2-cp311-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qrmi-0.24.2-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 c09fa634a561f4d3f12fa90acf6f29e4be86b1e24b4e47ab7cec4406a980793e
MD5 f19e54f612b76ef7e2bdb3d20cc64eff
BLAKE2b-256 163786c51cf1c8e5d47ba2c454320fbb07ea9a819ce21f3baa95dad29aedf9c1

See more details on using hashes here.

Provenance

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

This release

0.24.2 This release

4 files

0.24.1

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