API Reference¶

Complete reference documentation for all QuantSDK public APIs.

All classes and functions are auto-documented from source code docstrings.

Core Modules¶

Module	Description
`quantsdk.circuit`	The `Circuit` class — core abstraction for building quantum circuits
`quantsdk.gates`	All 50+ quantum gate classes with unitary matrix definitions
`quantsdk.result`	The `Result` class — measurement results, probabilities, and visualization
`quantsdk.runner`	The `qs.run()` function — top-level circuit execution
`quantsdk.backend`	`Backend` ABC, `BackendInfo`, and `BackendStatus`

Interop & Backends¶

Module	Description
`quantsdk.interop`	Framework interop (Qiskit, OpenQASM, Cirq, PennyLane)
`quantsdk.backends.ibm`	IBM Quantum and Aer backend adapters
`quantsdk.simulators.local`	Built-in pure-NumPy local simulator

Top-Level API¶

The most common entry points, available directly from import quantsdk as qs:

import quantsdk as qs

qs.Circuit      # Build quantum circuits
qs.Result       # Inspect execution results
qs.run          # Execute circuits on any backend
qs.__version__  # SDK version string

`quantsdk.run`¶

run ¶

run(
    circuit: Circuit,
    shots: int = 1024,
    backend: str | None = None,
    *,
    optimize_for: str | None = None,
    max_cost_usd: float | None = None,
    min_fidelity: float | None = None,
    seed: int | None = None,
    **options: Any,
) -> Result

Execute a quantum circuit.

This is the main entry point for running circuits. By default, runs on the local simulator. Specify a backend name or optimization constraints to use cloud backends (requires TheQuantCloud account).

PARAMETER	DESCRIPTION
`circuit`	The quantum circuit to execute. TYPE: `Circuit`
`shots`	Number of measurement repetitions (default: 1024). TYPE: `int` DEFAULT: `1024`
`backend`	Backend name. Options: `None` or `"local_simulator"` — Pure NumPy local simulator (default) `"aer"` or `"aer_simulator"` — Qiskit Aer simulator (requires qiskit-aer) `"ibm_<name>"` — IBM Quantum hardware (requires token + qiskit-ibm-runtime) TYPE: `str \| None` DEFAULT: `None`
`optimize_for`	Optimization target — "quality", "speed", or "cost". Enables QuantRouter smart routing (coming in v0.2). TYPE: `str \| None` DEFAULT: `None`
`max_cost_usd`	Maximum cost in USD (cloud only). TYPE: `float \| None` DEFAULT: `None`
`min_fidelity`	Minimum acceptable fidelity (cloud only). TYPE: `float \| None` DEFAULT: `None`
`seed`	Random seed for reproducible results (simulator only). TYPE: `int \| None` DEFAULT: `None`
`**options`	Additional backend-specific options. TYPE: `Any` DEFAULT: `{}`

RETURNS	DESCRIPTION
`Result`	Result object containing measurement counts and metadata.

Example::

import quantsdk as qs

circuit = qs.Circuit(2)
circuit.h(0)
circuit.cx(0, 1)
circuit.measure_all()

# Run on local simulator (default)
result = qs.run(circuit, shots=1000)
print(result.counts)  # {'00': 503, '11': 497}

# Run on Aer simulator
result = qs.run(circuit, backend="aer", shots=1000)

# Run on IBM Quantum hardware
result = qs.run(circuit, backend="ibm_brisbane", shots=4096)

# Smart routing (coming in v0.2)
# result = qs.run(circuit, optimize_for="quality", shots=1000)