██████╗ ██████╗ ██╗
██╔═══██╗██╔══██╗██║
██║   ██║██████╔╝██║
██║▄▄ ██║██╔═══╝ ██║
╚██████╔╝██║     ██║
 ╚══▀▀═╝ ╚═╝     ╚═╝

QPI Python Client

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

client = QPIClient("http://localhost:8090", api_token="my-token")
# The name is the QPU's; its qubit count is read from the server.
backend = client.get_backend("mock")

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

QPIBackend (Qiskit)

Documentation

• Main QPI Repository
• PyPI Project Page

License

MIT — see the main repository for details.