qontinuum 0.1.0__tar.gz

qontinuum-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev,ibm]" cirq-core pennylane
+      - run: pytest

qontinuum-0.1.0/.github/workflows/qontinuum.yml

@@ -0,0 +1,19 @@
+name: Qontinuum (dogfood)
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  quantum-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./action
+        with:
+          path: examples
+          seed: "42"
+          install: ".[ibm]"

qontinuum-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build && python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # PyPI trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

qontinuum-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# OS / editors
+.DS_Store
+.idea/
+.vscode/
+
+# Qontinuum local artifacts (snapshots.json IS committed; these are not)
+**/.qontinuum/cache/
+**/.qontinuum/history.jsonl
+qontinuum-report.md
+qontinuum-dashboard.html

qontinuum-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to Qontinuum
+
+## Development setup
+
+```sh
+git clone https://github.com/XTanishkX/quantum
+cd quantum
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev,ibm]"
+```
+
+## Checks
+
+```sh
+ruff check .        # lint
+pytest              # unit + integration tests
+qont test examples  # dogfood the CLI
+```
+
+Both run in CI on every PR, along with the Qontinuum action itself running
+against `examples/` (we eat our own cooking — quantum tests + cost comment).
+
+## Project layout
+
+| Path | What lives there |
+|---|---|
+| `src/qontinuum/circuits` | QASM/Qiskit/Cirq/PennyLane loading, canonical form, hashing, semantic diff |
+| `src/qontinuum/assertions` | statistics (`stats.py`), user-facing asserts, statistic capture context |
+| `src/qontinuum/runner` | `@qtest`, discovery, backends, engine, snapshots |
+| `src/qontinuum/noise` | Aer noise models from IBM calibration data |
+| `src/qontinuum/cost` | pricing catalog (`catalog.yaml`), circuit profiling, estimator |
+| `src/qontinuum/router` | device scoring: success probability × cost, ranking strategies |
+| `src/qontinuum/hardware` | real-QPU adapters (IBM, Braket) behind the all-or-nothing spend guard |
+| `src/qontinuum/report` | versioned JSON schema, markdown renderer, run history, HTML dashboard |
+| `action/` | the composite GitHub Action |
+
+## Design rules
+
+- **The result JSON schema is a contract.** Anything that changes its shape bumps
+  `SCHEMA_VERSION` in `report/schema.py`.
+- **Pricing lives in data, not code.** New devices/providers are added to
+  `cost/catalog.yaml` with a source URL and verified date; the estimator only knows
+  pricing *models* (`per_shot`, `per_second`, `gate_shot`, `hqc`).
+- **Assertions must be shots-aware.** Any new statistical assertion needs a soundness
+  guard: it must refuse configurations that would be flaky by construction.
+- **Offline by default.** Tests and CI must run without accounts or network; anything
+  live (e.g. `@live` calibration) is opt-in.

qontinuum-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qontinuum-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: qontinuum
+Version: 0.1.0
+Summary: CI/CD, noise-aware regression testing, and cost intelligence for quantum programs
+Project-URL: Homepage, https://github.com/XTanishkX/quantum
+Project-URL: Issues, https://github.com/XTanishkX/quantum/issues
+Author: Tanish Arora
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ci,cost-estimation,devops,qiskit,quantum,quantum-computing,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qiskit-aer>=0.15
+Requires-Dist: qiskit-qasm3-import>=0.5
+Requires-Dist: qiskit>=1.3
+Requires-Dist: rich>=13.0
+Requires-Dist: scipy>=1.11
+Requires-Dist: typer>=0.12
+Provides-Extra: braket
+Requires-Dist: amazon-braket-sdk>=1.80; extra == 'braket'
+Requires-Dist: qiskit-braket-provider>=0.4; extra == 'braket'
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: ibm
+Requires-Dist: qiskit-ibm-runtime>=0.30; extra == 'ibm'
+Description-Content-Type: text/markdown
+
+# Qontinuum
+
+**CI/CD, noise-aware regression testing, and cost intelligence for quantum programs.**
+
+Quantum programs don't return values — they return probability distributions sampled from
+noisy hardware. `assert result == expected` doesn't work, and nothing in the classical CI
+toolchain knows that. Qontinuum does.
+
+- **`qont test`** — a pytest-style runner for quantum circuits with *statistical* assertions:
+  total variation distance with shots-aware soundness floors, chi-squared tests, Hellinger
+  fidelity, and snapshot baselines committed as JSON.
+- **`qont cost`** — estimates what your suite would cost on real hardware across providers
+  (IonQ, Rigetti, IQM, AQT via Braket; IBM; Azure Quantum) before you spend a cent.
+- **`qont route`** — recommends hardware for your workload: estimated success probability ×
+  price, ranked by `--optimize cost|fidelity|value`.
+- **`qont run --on ibm:… --max-cost 5`** — executes the suite on *real* hardware behind an
+  all-or-nothing spend guard (default budget: $0 — it refuses until you authorize).
+- **`qont ci`** — one command for CI: run the suite, write a markdown report.
+- **`qont dashboard`** — renders run history as a self-contained HTML observability
+  dashboard (status timeline, per-check statistic trends vs thresholds).
+- **`qont diff` / `qont hash`** — semantic, register-name-agnostic circuit diffing and
+  content addressing.
+- **GitHub Action** — posts a sticky PR comment with regression results and the cost table.
+- **Noise-aware testing** — simulate against real IBM device calibration data, offline,
+  for free.
+- **Bring your own SDK** — `load_circuit` also accepts Cirq circuits and PennyLane tapes.
+
+> Status: pre-release (v0.1 in development).
+
+## Install
+
+```sh
+pip install qontinuum          # core
+pip install 'qontinuum[ibm]'   # + IBM calibration noise models
+```
+
+## Quick start
+
+Write a quantum test in any file named `q_test_*.py`:
+
+```python
+from qiskit import QuantumCircuit
+from qontinuum import qtest, assert_distribution
+
+@qtest(shots=4000)
+def bell_pair():
+    qc = QuantumCircuit(2)
+    qc.h(0)
+    qc.cx(0, 1)
+    qc.measure_all()
+    return qc
+
+@bell_pair.check
+def is_maximally_entangled(result):
+    assert_distribution(result, {"00": 0.5, "11": 0.5}, tvd_threshold=0.05)
+```
+
+```text
+$ qont test
+✓ q_test_bell.py::bell_pair  aer, 4000 shots, 30 ms
+    ✓ is_maximally_entangled
+
+1 passed, 0 failed, 0 errors
+```
+
+### Statistics done right
+
+Sampling noise means even a perfect circuit never reproduces a distribution exactly.
+Every assertion is shots-aware: if your threshold is below what the shot count can
+statistically resolve, Qontinuum refuses to run a test that would be flaky by
+construction — and tells you the shot count that would fix it:
+
+```text
+! is_maximally_entangled  tvd_threshold=0.01 is below the sampling noise floor 0.0289
+  at 4000 shots: even a perfect result would fail ~1% of the time.
+  Use at least 33380 shots or raise the threshold to >= 0.0289.
+```
+
+### Test against real hardware noise — offline and free
+
+```python
+@qtest(shots=4000, backend="ibm:manila")   # bundled real calibration snapshot
+def bell_under_noise(): ...
+
+@qtest(shots=4000, backend="ibm:brisbane@live")  # today's live calibration (free IBM account)
+def bell_today(): ...
+```
+
+### Snapshot testing for quantum
+
+```python
+@qtest(shots=4000, snapshot=True)
+def ghz_5(): ...
+```
+
+`qont snapshot update` records the distribution as a golden baseline (keyed by the
+circuit's content hash). Later runs are compared with a two-sample homogeneity test —
+if the circuit changes, the snapshot is flagged stale for review, exactly like Jest.
+
+### Know the cost before you run on hardware
+
+```text
+$ qont cost
+             Estimated hardware cost — 3 test(s), 12000 total shots
+┃ Provider      ┃ Device                ┃ Est. cost ┃
+│ AWS Braket    │ Rigetti Cepheus       │     $6.00 │
+│ IBM Quantum   │ Heron (Pay-As-You-Go) │     $9.61 │
+│ AWS Braket    │ IQM Garnet            │    $18.30 │
+│ Azure Quantum │ IonQ Aria 1           │    $63.29 │
+│ AWS Braket    │ IonQ Forte            │   $960.90 │
+│ Azure Quantum │ Quantinuum H2         │ 137.4 HQC │
+```
+
+Same suite, **$6 or $961**, depending on where you run it. That's why this table
+belongs on every pull request.
+
+### Route to the right hardware
+
+```text
+$ qont route --optimize value
+┃ # ┃ Provider    ┃ Device          ┃ Est. success/shot ┃ Est. cost ┃ $ / success ┃
+│ 1 │ AWS Braket  │ Rigetti Cepheus │             71.0% │    $10.00 │      $14.08 │
+│ 2 │ IBM Quantum │ Heron (PAYG)    │             93.3% │    $16.01 │      $17.17 │
+```
+
+Cheap-but-noisy vs pricey-but-clean, resolved with one number.
+
+### Run on real hardware — without surprise bills
+
+```sh
+qont run --on ibm:ibm_brisbane --dry-run --max-cost 5    # estimate only
+qont run --on braket:rigetti_cepheus --max-cost 5        # refuses if estimate > $5
+```
+
+The guard is all-or-nothing: the whole suite is priced *before* the first shot is
+submitted, and the default budget is $0.
+
+### Watch your suite over time
+
+Every run appends to `.qontinuum/history.jsonl`; `qont dashboard` turns it into a
+single-file HTML dashboard — status timeline, each check's statistic trending against
+its threshold, cost per run. No server, no JavaScript, works as a CI artifact.
+
+### Diff circuits, not files
+
+```text
+$ qont diff old.qasm new.qasm
+- cx q[0, 1]
++ cx q[1, 0]
+1 ops added, 1 removed
+```
+
+Register renames and formatting don't show up — only semantic changes do (the same
+canonicalization that powers snapshot staleness detection).
+
+## GitHub Action
+
+```yaml
+# .github/workflows/quantum.yml
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  quantum:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: XTanishkX/quantum/action@main
+        with:
+          path: .
+          seed: "42"
+```
+
+Every PR gets one sticky comment (updated in place) with pass/fail per check and the
+hardware cost table.
+
+## Assertions
+
+| Assertion | What it tests |
+|---|---|
+| `assert_distribution(result, expected, tvd_threshold=)` | TVD against an expected distribution, with sampling-floor soundness check |
+| `assert_chi_squared(result, expected, alpha=)` | Pearson goodness-of-fit |
+| `assert_fidelity(result, expected, min_fidelity=)` | Hellinger (classical) fidelity |
+| `assert_probability(result, outcome, min_p=, max_p=)` | Single-outcome probability bounds |
+| `assert_matches_baseline(result, counts, alpha=)` | Two-sample test vs a recorded run |
+
+## License
+
+Apache-2.0