Skip to main content
 ██████╗ ██████╗ ██╗
██╔═══██╗██╔══██╗██║
██║   ██║██████╔╝██║
██║▄▄ ██║██╔═══╝ ██║
╚██████╔╝██║     ██║
 ╚══▀▀═╝ ╚═╝     ╚═╝

QPI Python Client

PyPI version CI/CD Workflow GitHub Tag License

Python client SDK for the QPI quantum computing platform. Includes both a low-level HTTP client and a Qiskit-compatible backend.

📚 Read the Documentation


Install

pip install qpi-client

Requires Python ≥ 3.10.


Quick Start

Low-level client

from qpi_client import QPIClient

client = QPIClient("http://localhost:8090", api_token="my-token")

# Submit a job
job_id = client.submit_job([
    {"circuit": 'OPENQASM 3.0; include "stdgates.inc"; qubit[2] q; bit[2] c; h q[0]; cx q[0], q[1]; c = measure q;'}
], shots=1024)
print("Job ID:", job_id)

# Wait for completion
job = client.job(job_id)
result = job.result(timeout=120)
print(result.get_counts())

Qiskit integration

from qiskit.circuit import QuantumCircuit
from qpi_client import QPIClient, QPIBackend

client = QPIClient("http://localhost:8090", api_token="my-token")
backend = QPIBackend(client, num_qubits=5)

qc = QuantumCircuit(2, 2)
qc.h(0)
qc.cx(0, 1)
qc.measure([0, 1], [0, 1])

job = backend.run(qc, shots=4096)
result = job.result(timeout=120)
print(result.get_counts())

Submit raw QASM with parameters

job = backend.run(
    qasm='OPENQASM 3.0; include "stdgates.inc"; qubit[1] q; bit[1] c; rx({{theta}}) q[0]; c = measure q;',
    parameter_values=[[0.5], [1.0]],
    shots=1024
)
result = job.result()

API Overview

QPIClient

Method Description
QPIClient(base_url, api_token) Create a new client
submit_job(circuits, shots, ...) Submit a quantum job
job(job_id) Retrieve a job by ID (returns QPIJob)
list_jobs() List all jobs for the authenticated user
cancel_job(job_id) Request job cancellation
get_backend(name) Get a Qiskit-compatible backend

QPIBackend (Qiskit)

Method Description
backend.run(circuit, shots) Run a QuantumCircuit
backend.run(qasm, parameter_values, shots) Run raw QASM with parameter bindings
backend.job(job_id) Retrieve a past job

Documentation


License

MIT — see the main repository for details.

Download files

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

Source Distribution

qpi_client-0.0.39.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

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

qpi_client-0.0.39-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file qpi_client-0.0.39.tar.gz.

File metadata

  • Download URL: qpi_client-0.0.39.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qpi_client-0.0.39.tar.gz
Algorithm Hash digest
SHA256 59e0812f779406e88f7ee90d58e2e9788e9d926fa4930fc150c1cfbb4df9d99d
MD5 d556d61fa0da3356f42cdcabb751e475
BLAKE2b-256 bc55dd0a045777316cb0d5e2f34b520a9c57b19d745f23c52d47e58b53a8b888

See more details on using hashes here.

Provenance

The following attestation bundles were made for qpi_client-0.0.39.tar.gz:

Publisher: ci.yml on sopherapps/qpi

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

File details

Details for the file qpi_client-0.0.39-py3-none-any.whl.

File metadata

  • Download URL: qpi_client-0.0.39-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for qpi_client-0.0.39-py3-none-any.whl
Algorithm Hash digest
SHA256 c6bd4d314f8fcdb64f7635fe80bfb6d7219a4c1bb3a0da0e34bb8616ca49203b
MD5 b036761b3484bf750de0d20bea448d8c
BLAKE2b-256 d81be3ef074618fbc6d390d3aecc807d6335bd5b63947c9b4cdc8d8d32c4b1e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for qpi_client-0.0.39-py3-none-any.whl:

Publisher: ci.yml on sopherapps/qpi

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page