Skip to main content

QIR-QIS

Crates.io PyPI

A compiler that validates and translates QIR (Quantum Intermediate Representation) to Quantinuum QIS (Quantum Instruction Set). This tool enables quantum programs written in QIR to run on Quantinuum's quantum computing systems.

Features

  • QIR Validation: Validates QIR bitcode for correctness and spec compliance
  • QIS Translation: Compiles QIR to Quantinuum's native QIS instruction set
  • Python & Rust API: Use as a Rust library or Python package
  • CLI Tool: Command-line interface for quick compilation

See qtm-qir-reference.md for details on supported QIR features and their mapping to Quantinuum QIS.

Installation

From Source (Rust)

Requirements:

  • Rust >= 1.91.0
  • LLVM 21
# Point llvm-sys to your LLVM 21 installation
export LLVM_SYS_211_PREFIX=/path/to/llvm21

cargo build --release

The compiled binary will be available at target/release/qir-qis.

Python Package

Requirements:

  • Python >= 3.10, < 3.15
  • uv (recommended) or pip

Available pre-built wheels:

  • Linux: x86_64 (manylinux_2_28), aarch64 (manylinux_2_28)
  • macOS: x86_64, arm64 (Apple Silicon)
  • Windows: x86_64

All wheels support Python 3.10+ using the stable ABI (abi3).

# Using uv (recommended)
uv pip install qir-qis

# Using pip
pip install qir-qis

Usage

Command Line

Compile a QIR LLVM IR file to QIS bitcode:

# Basic usage
qir-qis input.ll

# With custom optimization level
qir-qis -O 3 input.ll

# Specify target architecture
qir-qis -t x86-64 input.ll

# Or using cargo
cargo run -- input.ll

This generates input.qis.bc containing the compiled QIS bitcode.

On Windows, the default mode remains conservative: -O 0 -t native. Optimized conversion requires requesting optimization (for example, -O 1) and is supported only with -t x86-64; other optimized target combinations still fail fast to avoid known unstable LLVM 21 paths.

Python API

See examples/python_api.py for a complete working example.

uv run examples/python_api.py

For a more comprehensive example with quantum simulation, see main.py.

Rust API

See examples/rust_api.rs for a complete working example.

cargo run --example rust_api

To keep untrusted entry-point metadata from driving effectively unbounded compiler allocations, validation and translation accept at most 65,535 statically declared qubits and 65,535 statically declared results. The Rust constants MAX_STATIC_QUBITS and MAX_STATIC_RESULTS expose these limits.

Platform Notes

Windows support is functional, but a few LLVM integration paths still differ from Linux and macOS:

  • Optimized conversion on Windows is currently supported only when optimization is requested (for example, -O 1) with -t x86-64; other optimized target combinations fail fast instead of entering known unstable LLVM paths.
  • LLVM verifier failures return a generic error on Windows instead of the full verifier message.
  • Native target codegen on Windows uses conservative CPU settings instead of host CPU feature detection.
  • -O0 optimization on Windows is a validation-only fast path and does not rewrite the module triple.

These limitations are implementation details of the current LLVM/Inkwell integration rather than QIR feature differences.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for:

  • How to report issues and submit pull requests
  • Coding standards and commit message format
  • Development workflow and testing requirements

Development setup, test commands, and LLVM upgrade guidance live in DEVELOPMENT.md. Release notes are available in CHANGELOG.md.

License

Apache-2.0

Copyright Quantinuum

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

qir_qis-0.1.11-cp310-abi3-win_amd64.whl (20.1 MB view details)

Uploaded CPython 3.10+Windows x86-64

qir_qis-0.1.11-cp310-abi3-manylinux_2_28_x86_64.whl (30.3 MB view details)

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

qir_qis-0.1.11-cp310-abi3-manylinux_2_28_aarch64.whl (29.4 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

qir_qis-0.1.11-cp310-abi3-macosx_11_0_arm64.whl (21.0 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

qir_qis-0.1.11-cp310-abi3-macosx_10_9_x86_64.whl (21.9 MB view details)

Uploaded CPython 3.10+macOS 10.9+ x86-64

File details

Details for the file qir_qis-0.1.11-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: qir_qis-0.1.11-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 20.1 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for qir_qis-0.1.11-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 181d371c9fbc5091cedceaba156887f454def5bf35d02fab60f88b09a598e513
MD5 6cd66cc5436327c68433466fc391035b
BLAKE2b-256 7ff2fbdfd972df32041dae00796ab31df29d1cc1b3424e5b3a5f64c025f9aa8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for qir_qis-0.1.11-cp310-abi3-win_amd64.whl:

Publisher: wheels-release.yml on Quantinuum/qir-qis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qir_qis-0.1.11-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for qir_qis-0.1.11-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 61444817dee4754b2c29c184dd9bc364278d0b16b6e552ae2ba24f18c9801655
MD5 321051f51a3f0861bd9e43a4b094ac96
BLAKE2b-256 c131a84480182f7185c3706a3c6db357f2e23dc6df6d4e8ad53061ed2cd6f297

See more details on using hashes here.

Provenance

The following attestation bundles were made for qir_qis-0.1.11-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: wheels-release.yml on Quantinuum/qir-qis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qir_qis-0.1.11-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for qir_qis-0.1.11-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 5fe323b1f42d7d89a1bb0ae79d3f602de6b8154ceeb8a612be845ba3d36f545b
MD5 655c43fe3a088d61bb8c89cb73d1ba84
BLAKE2b-256 b83ec00eb922a188fce3717ed1e2125d526b9ae5a249aa26753c8a5abbf363e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for qir_qis-0.1.11-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: wheels-release.yml on Quantinuum/qir-qis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qir_qis-0.1.11-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for qir_qis-0.1.11-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cd3620d169a7947ff4331796cee1b44920a70a2f90ca24969a1f3ed38b7703c4
MD5 2216fbe4d08130a9fcef20a240ffcf23
BLAKE2b-256 386da0963f5fc74813ed123783689791ae9a6ea36d1f576a20370050e6bc395f

See more details on using hashes here.

Provenance

The following attestation bundles were made for qir_qis-0.1.11-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: wheels-release.yml on Quantinuum/qir-qis

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file qir_qis-0.1.11-cp310-abi3-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for qir_qis-0.1.11-cp310-abi3-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 4f77231fdc6f5a18b2676ffccfaef295cf5736116de056ca446e2a79578ab244
MD5 3bfb9b3612138da72fa920e92637c0fa
BLAKE2b-256 2e478151819751fcee4d399064ae17de65b02ca59add57a1816a6b76710f52aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for qir_qis-0.1.11-cp310-abi3-macosx_10_9_x86_64.whl:

Publisher: wheels-release.yml on Quantinuum/qir-qis

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.1.11 This release

5 files

0.1.10

5 files

0.1.9

5 files

0.1.8

5 files

0.1.7

5 files

0.1.6

5 files

0.1.5

5 files

0.1.4

5 files

0.1.3

5 files

0.1.2

5 files

0.1.1

5 files

0.1.0

4 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