Runnable notebooks, workflows, and adoption paths for the QONTOS platform.
The public learning surface for circuit ingestion, partitioning, simulation, proofs, and provider interoperability.
Overview · Start Here · Installation · Docs Hub · Repository Map · Execution Modes · Related Repositories
QONTOS Examples is the public adoption layer for the QONTOS stack. It turns the SDK, simulator, and benchmark concepts into runnable notebooks and scripts that show how the platform behaves in real workflows.
Start with docs/index.md for the lightweight docs hub and the fastest route into the learning paths. For the canonical install and release policy across the public repos, use the shared policy.
| Level | Resource | Description |
|---|---|---|
| Beginner | Hello Qubit | First circuit submission and result inspection |
| Beginner | Bell State | Entanglement and measurement basics |
| Intermediate | Partitioning | Modular execution planning for larger circuits |
| Intermediate | Multi-Backend | Registry-driven backend selection and scheduling |
| Advanced | VQE Chemistry | Hybrid chemistry-style workflow with QONTOS primitives |
Python 3.10 or later is required.
The QONTOS packages are not yet published to PyPI. Install from pinned release tags:
pip install git+https://github.com/qontos/qontos.git@v0.2.0
pip install git+https://github.com/qontos/qontos-sim.git@v0.1.0Or install the curated examples environment:
pip install -r requirements.txtNote: Once packages are published to PyPI, installation will simplify to
pip install qontos qontos-sim.
| Path | Purpose |
|---|---|
notebooks/ |
Guided notebook walkthroughs from beginner to advanced workflows |
examples/python/ |
Core SDK and proof-oriented scripts |
examples/partitioning/ |
Partitioning strategy examples and algorithm comparisons |
examples/providers/ |
Local simulator, provider-specific, and future native-hardware examples |
tests/ |
Lightweight checks that keep examples aligned with the public API surface |
submit_job.py- basic job submission flowasync_jobs.py- async multi-job workflowexecution_proof.py- execution integrity walkthroughresult_inspection.py- result analysis and inspectioncircuit_normalization.py- ingest and normalize circuits offline
greedy_partition.py- simple modular partitioningspectral_partition.py- larger graph-based partitioning path
local_simulator.py- local simulator executionibm_quantum.py- IBM Quantum integration pathamazon_braket.py- Amazon Braket integration pathnative_qontos.py- future native hardware interface shape
| Example | Status | Requirements |
|---|---|---|
circuit_normalization.py |
Works now | Offline |
submit_job.py |
Works now | Local simulator |
execution_proof.py |
Works now | Offline |
greedy_partition.py |
Works now | Offline |
spectral_partition.py |
Works now | Offline |
local_simulator.py |
Works now | Local simulator |
async_jobs.py |
Requires server | Running QONTOS API |
result_inspection.py |
Requires server | Running QONTOS API |
ibm_quantum.py |
Requires credentials | IBM Quantum account |
amazon_braket.py |
Requires credentials | AWS account |
native_qontos.py |
Future path | Native hardware in development |
| Repository | Role |
|---|---|
| qontos | Flagship SDK and public developer entry point |
| qontos-sim | Simulators, digital twin, and tensor-network modeling |
| qontos-benchmarks | Evidence and methodology for public claims |
| qontos-research | Whitepapers, roadmap, and technical publications |
QONTOS · Hybrid superconducting-photonic quantum computing · Built by Zhyra Quantum Research Institute (ZQRI)