Skip to main content

Quantum resource management interface (QRMI)

License Current Release Platform PyPI - Python Version 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.20.1.tar.gz (358.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.20.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.20.1-cp311-abi3-manylinux_2_28_ppc64le.whl (11.7 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.28+ ppc64le

qrmi-0.20.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.20.1.tar.gz.

File metadata

  • Download URL: qrmi-0.20.1.tar.gz
  • Upload date:
  • Size: 358.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.20.1.tar.gz
Algorithm Hash digest
SHA256 f8376c8debca36ab4ac67997a97c5d758c1f481d5f6d63eb7a86cefe8a9e37b8
MD5 b768f876b0c77c93e4cc0ea780cdd6c6
BLAKE2b-256 965b10114e82f61232ccdc976f0110f59973abdb3ecb032a442cd082e4314c50

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.20.1-cp311-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0100ed90e99d4aee61ed4d9779ac4e80cf34ad65a4e03f7a09b0d9325ca502a7
MD5 2e8c504b9cdfd2fae07456ab82a9c10c
BLAKE2b-256 c92ceb4590317931f5186076483e09ff3a3f15dc93c6cbbe7d5c0f00854dbe3f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.20.1-cp311-abi3-manylinux_2_28_ppc64le.whl
Algorithm Hash digest
SHA256 f1e6e5196107d18b7ad7a76cc50bb3eb42a54d7cbe6d4e81f0fb63782d66508c
MD5 77718af34734375f0c6ce19239f1530b
BLAKE2b-256 717fe57f00cc622be96c0122f0478b3c740048ffaa2ea59ae86e02637c097318

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for qrmi-0.20.1-cp311-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 24c0d93921a08be8daab12d7e8d88498b0a8389d07c6e0159ad9e946e8059f0b
MD5 678a3129756c1cf5663a08eeb416f59c
BLAKE2b-256 8080320529e6d423f5e136985b46467c0242953c7cb78ccfe2f570da79c33819

See more details on using hashes here.

Provenance

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

0.21.1

4 files

0.21.0

4 files

This release

0.20.1 This release

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