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

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.21.1.tar.gz (374.5 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.21.1-cp311-abi3-manylinux_2_28_x86_64.whl (9.1 MB view details)

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

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ppc64le

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

Uploaded CPython 3.11+manylinux: glibc 2.28+ ARM64

File details

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

File metadata

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

File hashes

Hashes for qrmi-0.21.1.tar.gz
Algorithm Hash digest
SHA256 b2981e4ed940a91c240148969cfbf862d870b2a6ec3bebf2daaaa5f6d43a02f4
MD5 1921a18b3ed9373b82e1c733f1e74f4a
BLAKE2b-256 ed9ee8c3566751be7b149fa1725ab3bfa6cdf8f9fb14d271c60f16f7310db83d

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.21.1-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 95e29c889a2113bd2f45d45088dfcc0c3b5625f725bf027444d9cd38193df136
MD5 fd7633aa72973acbdd0b2549f1294b01
BLAKE2b-256 40494daa5eb4f678d0b590878e3a5318d37c784f9af7720f33bc12223f9d7dab

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.21.1-cp311-abi3-manylinux_2_28_ppc64le.whl
Algorithm Hash digest
SHA256 113c7c47a29bdece9bb0019b0ed5096ac37499d754069619448d6a6120c2d420
MD5 182f3e76ce9713fd6c4995d94a196cb8
BLAKE2b-256 838b932b7328faa5005fa4be7d2f7682539400320683264186963c4ce8862488

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.21.1-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 cba1e1d420430eeded074ba9df0195e38427b0d553ff53812158e23be5ed0251
MD5 99bde71f03a9c80e54fbd89785dcc748
BLAKE2b-256 e86f54bcc49522fac104a1b07fc47e076a0fbb41e0c381f04fb9552b0f19f1f0

See more details on using hashes here.

Provenance

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

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

This release

0.21.1 This release

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