qcoder 0.1.0a1

Quantum circuit analysis and structured feature extraction tools.

qCoder

qCoder helps developers inspect quantum circuits before they run them. It reads OpenQASM circuits, extracts repeatable structural features, and emits structured JSON (single file) or JSONL (batches)—useful for notebooks, CI, pull-request review, and AI coding assistants when you attach or paste deterministic context next to circuit text.

CLI: qcoder analyze and qcoder batch. Optional Qiskit intake: pip install "qcoder[qiskit]".

Company / legal: Quantum Ready Solutions. Product docs: qcoder.ai · manual. Source: github.com/QuantumReadySolutions/qCoder. Support: [e-mail].

What qCoder analyzes

qCoder summarizes circuit structure from declarations in your source files. Pair its JSON output with simulator or hardware run data whenever you need execution evidence.

Package layout (supported public surface)

For this release, treat the supported surface as:

• qcoder analyze — single-circuit extraction (human or --json).
• qcoder batch — directory batch to JSONL.
• qcoder[qiskit] — optional QuantumCircuit intake into the same extractor as OpenQASM.
• Documented feature output — see qcoder.ai — Feature reference and engines/feature_extraction/features/schema_v0.py; JSON carries a schema_version alongside named fields.

Other modules under src/qcoder may exist for prototyping (extra tooling or engines outside the commands above). Unless documented here, docs/, or qcoder.ai, they do not share the same stability expectations as analyze / batch and documented output.

Brief notes live in docs/architecture.md.

Install

pip install qcoder

Pre-release lines on PyPI use segments such as 0.1.0a1.

Optional Qiskit adapter:

pip install "qcoder[qiskit]"

Requires Python 3.11+. Runtime dependency: NumPy.

CLI quickstart

qcoder analyze path/to/circuit.qasm
qcoder analyze path/to/circuit.qasm --json
qcoder batch path/to/qasm_dir/ --out features.jsonl

Develop / test (from a clone)

python -m venv .venv
source .venv/bin/activate
pip install -e ".[qiskit]"
pip install pytest
pytest -q

License

Licensed under the Apache License 2.0. See LICENSE and NOTICE.