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)
  • qcoder student (Student status/demo/evidence aliases for hosted Preview connectivity checks)

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.0a4. 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
qcoder student status
qcoder student demo
qcoder student evidence

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.0a4.tar.gz (62.0 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.0a4-py3-none-any.whl (76.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: qcoder-0.5.0a4.tar.gz
  • Upload date:
  • Size: 62.0 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.0a4.tar.gz
Algorithm Hash digest
SHA256 0f6f55f18f3bf98b4f78371372c108118bc4fb8b4029523aa0028db81d6f5acf
MD5 1239e45a31ce30901feaf68199a9bd35
BLAKE2b-256 8856381548ea10dd8204bcb1c7a9cc8bef58dddad7013dc17f14d2fee4756200

See more details on using hashes here.

File details

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

File metadata

  • Download URL: qcoder-0.5.0a4-py3-none-any.whl
  • Upload date:
  • Size: 76.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.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 0ba02c0f01ae6da3e7cac62789cf8d6445089ee94efbec318beb89ce6380114c
MD5 03f010c36ba821bc5db591f62e6a3078
BLAKE2b-256 d6f884b33e4c8dbf8e4d2f4482bf8ced9c6649f2e741ae1a14e57e4a88effb0e

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