Skip to main content

Python client SDK for the QPI quantum computing platform

Project description

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

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.


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;',
    params=[[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, params, shots) Run raw QASM with parameter bindings
backend.job(job_id) Retrieve a past job

Documentation


License

MIT — see the main repository for details.

Project 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.9.tar.gz (14.5 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.9-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qpi_client-0.0.9.tar.gz
  • Upload date:
  • Size: 14.5 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.9.tar.gz
Algorithm Hash digest
SHA256 d1a3ec2866d1c2feb62cb1ce8dc06c9c8eda28040becf19de0416cb727ff626d
MD5 6ff887a98152510e6fcfda52b07607f7
BLAKE2b-256 eaa3b6f91f1c9f3ac60feb3ef2e846535b9313b3caaef654fccb0817b7e4c78c

See more details on using hashes here.

Provenance

The following attestation bundles were made for qpi_client-0.0.9.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.9-py3-none-any.whl.

File metadata

  • Download URL: qpi_client-0.0.9-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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 9c28b9f7aade666a24e2fab722b21909b37abcedda87240ca93e132a6ca896cb
MD5 806bda554c70ae3ecdb0ea370ba3e840
BLAKE2b-256 3995dd981cd08bdc0e8017de5f703f7bf175da942b36e7cb532b7b98c639de6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for qpi_client-0.0.9-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