Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

QHEAppE — Quantum-as-a-Service through HEAppE

PyPI version Python versions Documentation

Access IQM quantum hardware through the LEXIS Platform via HEAppE.

Documentation: https://it4innovations.github.io/quantum-as-a-service/

Requirements

Compatibility

Install one IQM extra:

Extra

iqm-client

Backends (station-control)

Used by

iqm_qiskit (recommended), iqm36_qiskit

36.0

49.x, 50.x

QHEAppE Client, pulse-level access (QPulla)

iqm35_qiskit

35.0

49.x

legacy qaas.client

Minimum server versions:

Feature

HEAppE

QScheduler

Circuit jobs

6.6+

0.2+

Pulse-level access (QPulla)

6.7.0+

0.2.2+, with pulse access enabled for the machine

Installation

QHEAppE can be installed using pip. To install the package along with optional dependencies for IQM integration:

pip install qaas[iqm_qiskit] --extra-index-url https://opencode.it4i.eu/api/v4/projects/107/packages/pypi/simple

For the other extras see Compatibility. QProvider.get_backend() checks the version the backend reports and raises an error that names the extra to install if it does not match.

Architecture

QHEAppE Architecture Diagram

Quick start

The following example demonstrates the basic usage of the QProvider and QBackend interfaces:

from qheappe_client.qprovider import QProvider
from qiskit import QuantumCircuit

# 1. Build a Qiskit circuit (Bell state)
qc = QuantumCircuit(2, 3)
qc.h(0)
qc.cx(0, 1)
qc.measure([0, 1], [0, 1])
qc.h(0)
qc.measure(0, 2)

# 2. Instantiate QProvider with your LEXIS authentication details
lexis_project = "your_project_name"
resource_name = "your_resource_name"

provider = QProvider(
    lexis_project=lexis_project,
    # Without passing token, an interactive login flow through the browser will happen
    # token=os.getenv("LEXIS_TOKEN"),
)

# Alternatively, you can log in via py4lexis and then pass the session (recommended for remote scripts executed on remote HW via terminal, etc.)
# from py4lexis.session import LexisSession
# session = LexisSession()  # Interactive login flow
# token = session.get_access_token()

# 3. Initialize the QBackend with the client
backend = provider.get_backend(
    lexis_resource=resource_name, backend_name="VLQ"
)

# 4. Transpile the circuit
qc_transpiled = backend.transpile(qc)

# 5. Submit the circuit job
job = backend.run(
    qc_transpiled, shots=1024, memory=True, job_name="demo_bell_state"
)
print(f"Job submitted successfully. Job ID: {job.job_id()}")

# 6. Retrieve results (qiskit.result.Result)
result = job.result()
print("Counts:", result.get_counts())
print(f"Bitstrings: {result.get_memory()!s:.20s}")

# 7. Or use the sampler primitive for a PrimitiveResult
from qheappe_client import QSamplerV2

sampler_result = QSamplerV2(backend).run([qc_transpiled], shots=1024).result()
meas = sampler_result[0].data.meas
print("Counts:", meas.get_counts())
print(f"Bitstrings: {meas.get_bitstrings()!s:.20s}")

job.result() returns a Qiskit Result, as backend.run() does in Qiskit, so tools that take a backend (BackendSamplerV2, BackendEstimatorV2, qiskit-experiments) work unchanged. For PrimitiveResult output, use QSamplerV2; see Reading results.

How to Fetch Calibration Data

Use the client to retrieve a calibration set by its UUID. To retrieve the default calibration set, pass None instead.

from uuid import UUID
from qheappe_client.qprovider import QProvider

provider = QProvider("your_project_name")
calibration_set = provider.get_backend(
    lexis_resource="your_resource_name",
    backend_name="VLQ",
    calibration_set_id=UUID("3a83e2f3-c5a8-43b7-9aa1-e9738ca3204b")
).get_backend_info().calibration_set_id

Authors

License

Apache 2.0 — see LICENSE.

Metadata

Release files for qaas 1.1.0a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qaas 1.1.0a1
File Size Uploaded Provenance Actions
qaas-1.1.0a1.tar.gz 135.4 kB With provenance Details for qaas-1.1.0a1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qaas 1.1.0a1
File Interpreter ABI Platform Actions
qaas-1.1.0a1-py3-none-any.whl Python 3 none any Details for qaas-1.1.0a1-py3-none-any.whl

Total release size: 285.0 kB

Release files / qaas-1.1.0a1.tar.gz

Download URL qaas-1.1.0a1.tar.gz
Size 135.4 kB
Tags Source
SHA-256 checksum
How to use checksums
364374578984f4251d189493d56befa97939a77c219a7f485f757653a261c531
BLAKE2b-256 checksum
How to use checksums
be19d7389e61b431f0049c5819889a026a47350759ac5fa3e5a5e6212c0fd47c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Release files / qaas-1.1.0a1-py3-none-any.whl

Download URL qaas-1.1.0a1-py3-none-any.whl
Size 149.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f42624827a725614c15faf91cc7ef9a03cdba7c627ce1d614c378727a2d16541
BLAKE2b-256 checksum
How to use checksums
8e387b59d97c20a9ded67a1e294353c7847e1424ef5489cef13aff54d1cd8cef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

Security for qaas 1.1.0a1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for qaas-1.1.0a1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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