Skip to main content

Quantum circuit analysis and structured feature extraction tools.

Project description

qCoder

qcoder is a local, deterministic quantum circuit evidence CLI.

Free qcoder commands run offline and do not call hosted services, upload telemetry, or run QPU/simulator jobs.

Public CLI surface

  • qcoder analyze
  • qcoder batch
  • qcoder context
  • qcoder review
  • qcoder pro (Pro bootstrap and client contract; non-confidential local plumbing only)

Pro Preview boundaries

Public qcoder ships Free local commands plus a Pro bootstrap/client contract. It is not the sellable hosted Pro product.

For a public, pilot-safe walkthrough, see the Pro Preview pilot walkthrough. The current public PyPI alpha client surface for Pro Preview is qcoder==0.5.0a2. It is not Pro V0.0 and not a sellable launched Pro product.

  • Free commands (analyze, batch, context, review) are Apache-2.0, local-first/offline, and useful without Pro. They do not upload data, call a qCoder hosted service, or run QPU/simulator jobs.
  • qcoder pro bootstrap (signup, login, install, status, validate) stores local token/config only. It does not upload circuits, run confidential analysis, or generate Pro cards locally.
  • qcoder pro workflow --dry-run-manifest writes a local JSON contract (qcoder.pro_preview.workflow_manifest.v0) and performs no network calls. This is the default path for most users.
  • qcoder pro workflow --submit posts a sanitized manifest only to an explicitly configured --service-url (or QCODER_PRO_API_URL). Use it only when QRS has given you a service URL and token. The default https://qcoder.ai/preview URL is not accepted for submit.
  • There is no generally available production hosted Pro service, account/token issuance, artifact/source upload, telemetry/training ingest, confidential local analyzer/cards, QPU/provider execution, or launched Pro V0.0 behavior in this public-main surface.
  • No confidential Pro analysis or cards are bundled in this package. Token-gating is access control only, not a secrecy boundary.

Quick start

Install:

pip install qcoder

Analyze a circuit:

qcoder analyze path/to/circuit.qasm --json

Create local context and review artifacts:

qcoder context path/to/circuit.qasm --out-json preflight.context.json --out-md preflight.context.md
qcoder review --counts-json counts.json --format qiskit_counts --preflight-json preflight.context.json --out-json execution.review.json --out-md execution.review.md

Pro Preview bootstrap (local contract rehearsal):

qcoder pro --help
qcoder pro signup
qcoder pro install --token <token-if-provided>
qcoder pro status
qcoder pro validate
qcoder pro workflow --qasm path/to/circuit.qasm --dry-run-manifest pro.workflow.manifest.json

Use --dry-run-manifest unless QRS has given you a non-default service URL and token for contract rehearsal. Manifest-only submit (no artifact upload) is opt-in:

qcoder pro workflow --qasm path/to/circuit.qasm --submit --service-url <url-qrs-provided>

Support-safe checklist for Pro Preview pilots

Safe to share with QRS support:

  • qcoder --version
  • command name
  • HTTP status or CLI error code
  • job_id, if produced
  • redacted output
  • manifest schema/version

Do not share:

  • bearer tokens
  • secrets
  • source code
  • repository archives
  • notebooks
  • private prompts or chat transcripts
  • raw QASM/source artifacts through unsupported paths

Architecture notes: docs/architecture.md.

Optional extras

pip install "qcoder[qiskit]"
pip install "qcoder[cirq]"
pip install "qcoder[pennylane]"

License

Apache-2.0 (see LICENSE and NOTICE).

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

qcoder-0.5.0a3.tar.gz (59.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qcoder-0.5.0a3-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

Details for the file qcoder-0.5.0a3.tar.gz.

File metadata

  • Download URL: qcoder-0.5.0a3.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for qcoder-0.5.0a3.tar.gz
Algorithm Hash digest
SHA256 f79f7cb03be1f3eb370e500d92963a215e7805d3dbe56a2776a293290f1cf584
MD5 dbc2e03232e357a556df725c6a07189c
BLAKE2b-256 d1dd74b1e9d2044e115279025c0fd386a12aaf1f9486cfce72f0750a81f88b44

See more details on using hashes here.

File details

Details for the file qcoder-0.5.0a3-py3-none-any.whl.

File metadata

  • Download URL: qcoder-0.5.0a3-py3-none-any.whl
  • Upload date:
  • Size: 74.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for qcoder-0.5.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 416ce4511312bfd894d1a85a726ee92ee528a23fa79c7146d30cce41bc8625d1
MD5 a348e01d76e8feb2f2b7134c334f5ce8
BLAKE2b-256 b95b28488306d4b76f997433a10af53dfad5f562eaa0f9b4eae8808ed1c5079b

See more details on using hashes here.

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