IBM QDMI Device

IBM QDMI Device connects IBM Quantum Platform to the Quantum Device Management Interface (QDMI), a vendor-neutral C API for quantum hardware. The C++20 library handles API-key authentication, calibration queries, and the job lifecycle. It submits OpenQASM 3 circuits and returns ordered shots and histograms. Optional Qiskit and PennyLane integrations use the same native interface.

Live metadata validation has passed; quantum execution has not yet been validated on hardware. Examples default to local simulation.

Installation

Install the package from PyPI with Python 3.11 or newer:

uv venv
uv pip install ibm-qdmi                # core library and Python entry points
uv pip install "ibm-qdmi[qiskit]"      # adds the Qiskit backend (IBMBackend)
uv pip install "ibm-qdmi[executor]"    # adds Executor programs (IBMBackend.executor)
uv pip install "ibm-qdmi[pennylane]"   # adds the PennyLane devices

Prebuilt wheels are available for Linux (x86_64, aarch64), macOS (arm64), and Windows (x86_64, ARM64). They bundle the native library, headers, and CMake package configuration. To build from source or install the native library for C++ projects with CMake, follow the installation guide.

Use .env.example as a reference for connection and optional client settings. Supply credentials through the process environment or a secret manager; the device does not load .env files.

Where to Start

Contributing

Contributions are welcome, including bug reports, documentation improvements, and new features. See the Contributing Guide for the development workflow, coding standards, and pull request process.

License

The core C++ library and Python package are licensed under the Apache License 2.0 with LLVM exception. See LICENSE for the license text.

Binary wheels statically link libcurl, cpr, and nlohmann/json; Linux wheels also bundle OpenSSL. Their license texts ship with each wheel and are available in licenses/.