quantum-backend-bench 0.2.3

Backend-agnostic benchmarking toolkit for local quantum SDK simulators.

Quantum Backend Bench

PyPI: https://pypi.org/project/quantum-backend-bench/

Website: https://sidrichardsquantum.github.io/Quantum_Backend_Bench/

Backend-agnostic benchmarking toolkit for local quantum circuit simulators. The package runs the same benchmark definitions across local simulator adapters such as Cirq, PennyLane, Amazon Braket LocalSimulator, Qiskit Aer, CUDA-Q, pyQuil QVM, and QuTiP, then reports standardized runtime, structural, and distribution metrics. pytket is used for circuit analysis and compilation-style metrics, not as an execution backend.

See USAGE.md for a task-oriented guide to the CLI and Python API, and CHANGELOG.md for release notes. For research workflows and interpretation, see PROBLEM.md, THEORY.md, METHODOLOGY.md, RESULTS.md, SCHEMA.md, COMPATIBILITY.md, and LIMITATIONS.md.

Table of Contents

• Features
• Backend Support
• Compatibility
• Installation
• Two-Minute First Run
• GitHub Codespaces
• Quickstart
• Benchmark Suite
  • GHZ
  • QFT
  • Bernstein-Vazirani
  • Deutsch-Jozsa
  • Random Circuit
  • Quantum Volume Style
  • Grover
  • Hamiltonian Simulation
  • QAOA MaxCut
  • Noise Sensitivity
• Python API
• Result Bundles and DataFrames
• Tutorial Notebooks
• Project Layout
• Development
• SDK Utility Workflows
• Notes
• Author
• License

Features

• Unified BenchmarkSpec abstraction for reusable benchmark definitions
• Local-first execution backends with no cloud credentials required
• Built-in benchmarks for GHZ, Bernstein-Vazirani, Deutsch-Jozsa, QFT, random circuits, quantum-volume-style circuits, Grover search, Hamiltonian simulation, QAOA MaxCut, and noise sweeps
• Standardized metrics including depth, gate counts, runtime, success probability, and total variation distance
• CLI commands for discovery, backend capability reporting, single runs, backend comparison, presets, reports, and noise sweeps
• Experiment manifests with environment capture and repeated runtime statistics
• Named benchmark suites for smoke, standard, and scaling runs
• Native circuit drawing through Cirq, PennyLane, Braket, and pytket renderers
• JSON/CSV export, summary rankings, and matplotlib plot generation
• Installable in GitHub Codespaces with Python 3.11+

Backend Support

Backend	Execution	Notes
Cirq	cirq.Simulator	Supports depolarizing noise injection in this project
PennyLane	default.qubit / default.mixed	Uses local devices only
Amazon Braket	LocalSimulator only	Offline execution, no AWS credentials required
Qiskit Aer	AerSimulator	Local Aer simulation with depolarizing noise injection support
NVIDIA CUDA-Q	local simulator target	Optional local CUDA-Q execution adapter
pyQuil QVM	local QVM/quilc runtime	Requires local Forest runtime support
QuTiP	local statevector simulation	Useful for physics-oriented local simulation coverage
pytket	Analysis only	Used for depth and gate metrics, not execution
qBraid	Discovery only	Optional interop/runtime SDK; not used as a local execution backend
Q# / QDK	Discovery only	Optional language/runtime SDK; not used as a circuit backend

The core execution path is intentionally free, local, and credential-free. Backends that require cloud accounts, provider billing, remote queues, or private services should stay outside the default workflow unless they are added as clearly optional provider adapters. The default recommendation is to keep new-user benchmarking instantly accessible through local simulators.

Compatibility

See COMPATIBILITY.md for the supported Python versions, optional SDK extras, local runtime requirements, and CI coverage status for each integration.

Installation

Install from PyPI:

python -m pip install quantum-backend-bench

Install execution backends as needed:

python -m pip install "quantum-backend-bench[cirq]"
python -m pip install "quantum-backend-bench[pennylane]"
python -m pip install "quantum-backend-bench[braket]"
python -m pip install "quantum-backend-bench[qiskit]"
python -m pip install "quantum-backend-bench[cudaq]"
python -m pip install "quantum-backend-bench[pyquil]"
python -m pip install "quantum-backend-bench[qutip]"
python -m pip install "quantum-backend-bench[yaml]"
python -m pip install "quantum-backend-bench[all]"
python -m pip install "quantum-backend-bench[full]"

The default package and .[dev] workflow are self-contained Python installs. The all extra is the practical Python-only comparison stack and intentionally excludes CUDA-Q and pyQuil. Use full only when you explicitly want every Python SDK extra, including heavy or external-runtime-backed adapters.

Install from a local checkout:

python -m pip install --upgrade pip
python -m pip install -e .

For development tools:

python -m pip install -e .[dev]

For the practical local test matrix:

python -m pip install -e ".[all,dev]"

For the exhaustive optional SDK matrix:

python -m pip install -e ".[full,dev]"

The pyQuil execution test also requires local qvm and quilc executables on PATH. Those are external Rigetti runtime tools and are not installed by pip extras.

Two-Minute First Run

For the shortest public path, install the Cirq extra and run the smoke workflow:

python -m pip install "quantum-backend-bench[cirq]"
quantum-bench run ghz --backend cirq --n-qubits 3 --shots 128 --summary
quantum-bench suite smoke --backends cirq --shots 128 --summary

Expected output is a compact table with runtime, depth, gate counts, and benchmark quality metrics, followed by summary rankings. A saved reference bundle for this workflow is available under examples/reference_results/cirq_smoke_2026-06-03/.

GitHub Codespaces

The repository includes a Codespaces-ready .devcontainer/devcontainer.json using a Python 3.11 base image. On container creation it installs the package in editable mode with development dependencies.

Quickstart

List available benchmarks, suites, and local integrations:

quantum-bench list
quantum-bench info
quantum-bench doctor
quantum-bench recommend --use-case research
quantum-bench compatibility
quantum-bench validate

Run a single benchmark:

quantum-bench run ghz --backend cirq --n-qubits 5
quantum-bench run ghz --backend cirq --n-qubits 5 --repeats 5

Compare a benchmark across all execution backends and print summary rankings:

quantum-bench compare qft --backends cirq pennylane braket_local qiskit_aer qutip --n-qubits 5 --summary

Run a random circuit:

quantum-bench run random-circuit --backend braket_local --n-qubits 4 --depth 10 --seed 42

Run Grover:

quantum-bench run grover --backend pennylane --n-qubits 3 --marked-state 101

Run Bernstein-Vazirani:

quantum-bench run bernstein-vazirani --backend cirq --n-qubits 4 --secret-string 101

Run Deutsch-Jozsa:

quantum-bench run deutsch-jozsa --backend cirq --n-qubits 4 --oracle-type balanced --bitmask 101

Run Hamiltonian simulation:

quantum-bench run hamiltonian-sim --backend cirq --n-qubits 4 --time 1.0 --trotter-steps 2

Run QAOA MaxCut:

quantum-bench run qaoa-maxcut --backend cirq --n-qubits 4 --graph ring --gamma 0.8 --beta 0.4

Run a noise sweep:

quantum-bench noise-sweep ghz --backend cirq --n-qubits 5

Run a quantum-volume-style circuit:

quantum-bench run quantum-volume --backend cirq --n-qubits 4 --depth 4 --seed 42

Draw a circuit with a native SDK renderer:

quantum-bench draw ghz --backend cirq --n-qubits 5
quantum-bench draw qft --backend pennylane --n-qubits 5 --save-path artifacts/qft_pennylane.png
quantum-bench draw ghz --backend tket --n-qubits 5 --save-path artifacts/ghz_tket.txt

Save JSON and plots:

quantum-bench compare ghz --backends cirq pennylane braket_local --n-qubits 5 --save-json artifacts/ghz.json --save-plot artifacts/ghz.png

Save distribution, heatmap, noise-quality, and suite plots:

quantum-bench run grover --backend cirq --n-qubits 3 --marked-state 101 --save-distribution artifacts/grover_distribution.png
quantum-bench compare ghz --backends cirq pennylane --n-qubits 4 --save-heatmap artifacts/ghz_heatmap.png
quantum-bench noise-sweep ghz --backend cirq --n-qubits 4 --save-quality-plot artifacts/noise_quality.png
quantum-bench suite smoke --backends cirq --save-suite-plot artifacts/smoke_runtime.png

Save CSV:

quantum-bench compare ghz --backends cirq pennylane --n-qubits 5 --save-csv artifacts/ghz.csv

Compare saved results and fail on regressions:

quantum-bench diff artifacts/baseline.json artifacts/current.json --relative-threshold 0.05 --fail-on-regression
quantum-bench bundle artifacts/current.json --output artifacts/current_bundle
quantum-bench diff artifacts/baseline.csv artifacts/current.csv --metric runtime_seconds

Generate a Markdown report:

quantum-bench report artifacts/current.json --output artifacts/current_report.md

Use packaged comparison presets:

quantum-bench preset list
quantum-bench preset show algorithmic --save-json artifacts/algorithmic_manifest.json
quantum-bench preset run runtime --backends cirq pennylane qiskit_aer --save-report artifacts/runtime_report.md

Run a named suite:

quantum-bench suite smoke --backends cirq --summary
quantum-bench suite standard --backends cirq pennylane braket_local --save-csv artifacts/standard.csv
quantum-bench suite standard --list-cases --save-json artifacts/standard_manifest.json

Run a reproducible experiment manifest:

quantum-bench experiment run examples/manifests/runtime_scaling.json

For more complete workflows, result interpretation, and Python examples, see USAGE.md.

Benchmark Suite

GHZ

Generates GHZ states for configurable qubit counts. Ideal output is concentrated on 00...0 and 11...1.

QFT

Implements the Quantum Fourier Transform for structural and runtime comparisons.

Bernstein-Vazirani

Recovers a hidden bitstring with one oracle query. The final qubit is used as the oracle work qubit, so --secret-string must have length --n-qubits - 1.

Deutsch-Jozsa

Runs constant or linear balanced oracle cases. Balanced cases use --bitmask; constant cases use --oracle-type constant --constant-value 0|1.

Random Circuit

Builds reproducible random circuits using a fixed gate set and explicit seed control.

Quantum Volume Style

Builds reproducible shuffled-pair random layers inspired by quantum volume workloads. This is a portable workload, not a formal quantum volume certification routine.

Grover

Implements a small search benchmark for 2 to 4 qubits and reports marked-state success probability.

Hamiltonian Simulation

Implements first-order Trotterized evolution for a simple Ising-style Hamiltonian:

H = sum_i Z_i Z_{i+1} + 0.5 * sum_i X_i

QAOA MaxCut

Builds a single-layer QAOA circuit for line or ring MaxCut instances and reports success probability as probability mass on optimal cut bitstrings.

Noise Sensitivity

Wraps a base benchmark and sweeps depolarizing noise levels. Noise behavior differs by backend and is reported in result metadata. Cirq, PennyLane, and Qiskit Aer inject depolarizing noise in this project; other adapters may report the request without applying noise.

Python API

from quantum_backend_bench.benchmarks.ghz import build_benchmark
from quantum_backend_bench import build_suite, run_benchmark, summarize_results

benchmark = build_benchmark(n_qubits=5)
results = run_benchmark(benchmark, ["cirq", "pennylane", "braket_local"], shots=1024)
suite_results = [
    result
    for benchmark in build_suite("smoke")
    for result in run_benchmark(benchmark, ["cirq"], shots=128)
]
summary = summarize_results(suite_results)

Result Bundles and DataFrames

Create a shareable result bundle from any saved JSON or CSV result file:

quantum-bench bundle artifacts/results.json --output artifacts/results_bundle

The bundle contains normalized JSON/CSV outputs, flattened records, a Markdown report, plots when matplotlib is available, environment metadata when present, and a README for interpretation. Python users can also flatten results directly:

from quantum_backend_bench import results_to_dataframe

frame = results_to_dataframe("artifacts/results.json")

Tutorial Notebooks

The notebooks/ directory contains succinct package-client tutorials. Each notebook starts with problem context, quantum-advantage scope, and parameter definitions, then uses readable tables, plots where useful, saved artifacts, and verification checks.

• 01_quickstart_cirq.ipynb: GHZ and smoke-suite workflow on the free local Cirq simulator.
• 02_compare_local_simulators.ipynb: installed local simulator comparison for GHZ and QFT.
• 03_hamiltonian_simulation_case_study.ipynb: small Ising-style Hamiltonian simulation scaling study.
• 04_sdk_cirq_workflow.ipynb through 08_sdk_qutip_workflow.ipynb: compact SDK export, execution, plotting, artifact, and verification workflows for Cirq, Qiskit Aer, PennyLane, Braket LocalSimulator, and QuTiP.

Install notebook helpers with:

python -m pip install -e ".[cirq,plot,notebooks]"

Project Layout

quantum_backend_bench/
├── backends/
├── benchmarks/
├── core/
├── utils/
└── cli.py

Example scripts live in examples/, with a run order and expected outputs documented in examples/README.md. They include backend comparison, GHZ execution, oracle benchmarks, quantum-volume-style execution, suite export, plot generation, circuit diagram export, research manifest generation, repeated-runtime analysis, schema inspection, Markdown report generation, backend capability inspection, and a Cirq noise sweep demo. The plot gallery example uses larger circuits, more shots, and multiple backends so the generated images show non-trivial distributions.

Development

Run formatting and linting:

black quantum_backend_bench tests examples
ruff check quantum_backend_bench tests examples

Run the default core test suite:

pytest

Run optional SDK and generated-site documentation checks explicitly when needed:

pytest -m optional_sdk
pytest tests/test_docs_links.py -m "docs or not docs"

Build and inspect release artifacts:

python -m build
python -m twine check dist/*

Continuous integration is handled by .github/workflows/ci.yml, which runs formatting, linting, tests, documentation link validation, Cirq smoke regression checks, package builds, and distribution checks. Publishing is handled by .github/workflows/publish.yml when a version tag such as v0.2.3 is pushed. The workflow expects PyPI trusted publishing to be configured for this repository.

SDK Utility Workflows

The CLI includes SDK-facing workflows beyond local benchmark execution:

quantum-bench export ghz --n-qubits 3 --format openqasm
quantum-bench export ghz --n-qubits 3 --format openqasm3
quantum-bench export ghz --n-qubits 3 --format native --backend cirq
quantum-bench import-qasm artifacts/ghz.qasm3 --name imported_ghz
quantum-bench exact ghz --n-qubits 3 --top-k 4 --amplitudes --observable ZZI
quantum-bench run random-circuit --backend cirq --sweep n-qubits=2:5 --sweep depth=4,8
quantum-bench noise-sweep ghz --backend cirq --noise-type bit_flip
quantum-bench diagnose artifacts/ghz.json
quantum-bench hardware qaoa-maxcut --n-qubits 4 --output artifacts/hardware_qaoa --provider ibm --qasm-version openqasm3 --backend-hint provider-device
quantum-bench recommend --needs-noise --no-external-runtime

Result tables, CSV records, and Markdown reports include compile/transpile metadata when a backend provides it, such as Qiskit Aer compile_seconds, compiled depth, compiled gate counts, and compile toolchain. New applied workloads include vqe-ansatz, phase-estimation, amplitude-estimation, and quantum-kernel. The hardware command writes OpenQASM and provider-specific caveats for IBM, Braket, Rigetti, or generic submission workflows, but it does not submit cloud jobs or handle credentials. SDK tutorial notebooks live in notebooks/04_sdk_cirq_workflow.ipynb through notebooks/08_sdk_qutip_workflow.ipynb and include readable result summaries, top-state plots, saved artifacts, and verification checks.

Notes

• The project targets standard pip environments with Python 3.11 or newer.
• No AWS account, cloud credentials, GPUs, or paid services are required.
• The internal circuit model is intentionally simple to keep backend translation maintainable.

---

Author

Sid Richards

• LinkedIn: sid-richards-21374b30b
• GitHub: SidRichardsQuantum

License

MIT. See LICENSE.