ftalgo 0.1.0__tar.gz

ftalgo-0.1.0/.claude/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.0.1",
+  "configurations": [
+    {
+      "name": "site",
+      "runtimeExecutable": ".venv/bin/python",
+      "runtimeArgs": ["-m", "http.server", "8765", "--directory", "site"],
+      "port": 8765
+    }
+  ]
+}

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

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  rust:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: wasm32-unknown-unknown
+      - run: cargo test --lib --features parallel
+      - run: cargo build --release --target wasm32-unknown-unknown --lib
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Python module for the WebAssembly comparison
+        run: |
+          python -m venv .venv
+          .venv/bin/pip install -q maturin numpy
+          .venv/bin/maturin build --release --out dist -q
+          .venv/bin/python - <<'PY'
+          import glob, shutil, zipfile
+          whl = glob.glob("dist/ftalgo-*.whl")[0]
+          with zipfile.ZipFile(whl) as z:
+              name = [n for n in z.namelist() if n.startswith("ftalgo/_ftsim")][0]
+              with z.open(name) as src, open("python/" + name, "wb") as dst:
+                  shutil.copyfileobj(src, dst)
+          PY
+          cp target/wasm32-unknown-unknown/release/ftsim.wasm site/wasm/ftsim.wasm
+          PYTHONPATH=python node tools/wasm-smoke.mjs
+
+  python:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Build the engine and install the test dependencies
+        run: |
+          pip install -q maturin numpy scipy matplotlib pytest hypothesis mpmath pygridsynth \
+            stabilizer-qec stim pymatching qiskit qiskit-aer pyscf
+          maturin build --release --out dist -q
+          python - <<'PY'
+          import glob, shutil, zipfile
+          whl = glob.glob("dist/ftalgo-*.whl")[0]
+          with zipfile.ZipFile(whl) as z:
+              name = [n for n in z.namelist() if n.startswith("ftalgo/_ftsim")][0]
+              with z.open(name) as src, open("python/" + name, "wb") as dst:
+                  shutil.copyfileobj(src, dst)
+          PY
+      - run: python -m pytest -q tests
+      - run: python tools/readme_tables.py --check

ftalgo-0.1.0/.github/workflows/grid.yml

@@ -0,0 +1,141 @@
+# The algorithm grid (tools/grid.py) under a chosen calibration, run by hand
+# (Actions → Algorithm grid → Run workflow). One job plans and builds the engine, up to
+# 256 jobs each run a share of the chunks, and a last job merges them and commits the
+# chunks and the merged results to the data-only branch grid-results:
+#
+#   grid-results/parts/        one JSON per chunk
+#   grid-results/<out>/        one JSON per configuration, laid out like data/results/
+#
+# Run it again after a partial run (a job past the time limit, a cancelled run): the plan
+# skips every chunk already on grid-results, so only the missing ones run.
+name: Algorithm grid
+
+on:
+  workflow_dispatch:
+    inputs:
+      model:
+        description: Fitted model
+        default: data/calibration/model_mr.json
+      out:
+        description: Directory for the merged results (on grid-results)
+        default: results_mr
+      jobs:
+        description: Number of jobs
+        default: "60"
+
+permissions:
+  contents: write
+
+jobs:
+  plan:
+    runs-on: ubuntu-latest
+    outputs:
+      jobs: ${{ steps.plan.outputs.jobs }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Build the engine
+        run: |
+          pip install -q maturin numpy scipy mpmath pygridsynth pyscf
+          maturin build --release --out dist -q
+          python - <<'PY'
+          import glob, shutil, zipfile
+          whl = glob.glob("dist/ftalgo-*.whl")[0]
+          with zipfile.ZipFile(whl) as z:
+              name = [n for n in z.namelist() if n.startswith("ftalgo/_ftsim")][0]
+              with z.open(name) as src, open("python/" + name, "wb") as dst:
+                  shutil.copyfileobj(src, dst)
+          PY
+      - name: Chunks already done
+        run: |
+          mkdir -p done
+          if git fetch -q origin grid-results; then
+            git archive FETCH_HEAD parts | tar -x -C done || true
+          fi
+          ls done/parts 2>/dev/null | wc -l
+      - id: plan
+        name: Plan
+        run: |
+          python tools/grid.py plan --model "${{ inputs.model }}" --out "${{ inputs.out }}" \
+            --jobs "${{ inputs.jobs }}" --parts done/parts > plan.json
+          python -c "import json; print('jobs=' + json.dumps(list(range(len(json.load(open('plan.json'))['jobs'])))))" >> "$GITHUB_OUTPUT"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: plan
+          path: |
+            plan.json
+            python/ftalgo/_ftsim*
+
+  run:
+    needs: plan
+    if: needs.plan.outputs.jobs != '[]'
+    runs-on: ubuntu-latest
+    timeout-minutes: 350
+    strategy:
+      fail-fast: false
+      # Leave two of the account's 20 concurrent jobs free, so CI and Pages
+      # deploys in other repositories are not queued behind the grid.
+      max-parallel: 18
+      matrix:
+        job: ${{ fromJson(needs.plan.outputs.jobs) }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install -q numpy scipy mpmath pygridsynth pyscf
+      - uses: actions/download-artifact@v4
+        with:
+          name: plan
+      - name: Run this job's chunks
+        # Stop short of the job limit so the chunks finished so far are still uploaded.
+        continue-on-error: true
+        run: timeout 330m python tools/grid.py run --plan plan.json --job ${{ matrix.job }} --parts parts
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: parts-${{ matrix.job }}
+          path: parts/*.json
+          if-no-files-found: ignore
+
+  collect:
+    needs: [plan, run]
+    if: always() && needs.plan.result == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - run: pip install -q numpy scipy
+      - uses: actions/download-artifact@v4
+        with:
+          name: plan
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: parts-*
+          path: new-parts
+          merge-multiple: true
+      - name: Merge and commit to grid-results
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          if git fetch -q origin grid-results; then
+            git worktree add -q ../res FETCH_HEAD
+            git -C ../res checkout -q -B grid-results
+          else
+            git worktree add -q --detach ../res
+            git -C ../res checkout -q --orphan grid-results
+            git -C ../res rm -rfq .
+          fi
+          mkdir -p ../res/parts
+          cp new-parts/*.json ../res/parts/ 2>/dev/null || true
+          cp plan.json ../res/plan.json
+          python tools/grid.py merge --plan plan.json --parts ../res/parts --out "../res/${{ inputs.out }}" | tee merge.txt
+          cd ../res
+          git add -A
+          git commit -q -m "Algorithm grid: $(cat "$GITHUB_WORKSPACE/merge.txt")" -m "model ${{ inputs.model }}, run ${{ github.run_id }}" || echo "nothing new"
+          git push -q origin grid-results

ftalgo-0.1.0/.github/workflows/pages.yml

@@ -0,0 +1,34 @@
+name: Deploy Pages
+
+on:
+  push:
+    branches: ["master"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ftalgo-0.1.0/.github/workflows/wheels.yml

@@ -0,0 +1,133 @@
+# Wheels for PyPI, built on a version tag (v*) or by hand.
+#
+# Building and the smoke test run anywhere. Publishing runs only on a tag, by PyPI's trusted
+# publishing: the PyPI project ftalgo trusts this repository's workflow "wheels.yml" in
+# environment "pypi". After publishing, the job creates the GitHub Release for the tag, with the
+# wheels attached; Zenodo archives each release and gives it a DOI.
+name: Wheels
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  # One abi3 wheel per platform serves every CPython from 3.9. Each build first copies the fitted
+  # model and the rotation cache into the package (tools/bundle_data.sh): an installed ftalgo has
+  # no data/ directory.
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        target: [x86_64, aarch64]
+        libc: [auto, musllinux_1_2]
+    steps:
+      - uses: actions/checkout@v5
+      - run: sh tools/bundle_data.sh
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --out dist
+          manylinux: ${{ matrix.libc == 'auto' && matrix.target == 'aarch64' && '2_28' || matrix.libc }}
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.target }}-${{ matrix.libc }}
+          path: dist
+
+  macos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v5
+      - run: sh tools/bundle_data.sh
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: universal2-apple-darwin
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos
+          path: dist
+
+  windows:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v5
+      - run: sh tools/bundle_data.sh
+        shell: bash
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: x64
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-x64
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - run: sh tools/bundle_data.sh
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist
+
+  # The installed wheel, away from the repository, on each operating system.
+  smoke:
+    needs: [linux, macos, windows]
+    strategy:
+      matrix:
+        include:
+          - runner: ubuntu-latest
+            artifact: wheels-linux-x86_64-auto
+          - runner: macos-latest
+            artifact: wheels-macos
+          - runner: windows-latest
+            artifact: wheels-windows-x64
+    runs-on: ${{ matrix.runner }}
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+      - uses: actions/download-artifact@v4
+        with:
+          name: ${{ matrix.artifact }}
+          path: dist
+      - name: Install the wheel and run the smoke test outside the repository
+        shell: bash
+        run: |
+          python -m pip install dist/*.whl
+          mkdir -p "$RUNNER_TEMP/smoke" && cp tools/smoke_installed.py "$RUNNER_TEMP/smoke/"
+          cd "$RUNNER_TEMP/smoke" && python -I smoke_installed.py
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [linux, macos, windows, sdist, smoke]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: "*"
+          merge-multiple: true
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

ftalgo-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+.venv/
+target/
+target-*/
+__pycache__/
+*.pyc
+.pytest_cache/
+.hypothesis/
+dist/
+*.so
+scratch/
+logs/
+# macOS/iCloud sync conflict copies
+* 2.*
+* 2

ftalgo-0.1.0/.zenodo.json

@@ -0,0 +1,38 @@
+{
+  "title": "ft-algorithms: factoring and chemistry on a simulated fault-tolerant quantum computer",
+  "upload_type": "software",
+  "description": "<p>Shor's algorithm (full modular exponentiation, textbook and windowed arithmetic with measurement-based uncomputation) and molecular phase estimation, compiled to Clifford+T+Toffoli and run end to end on a simulated rotated surface-code machine. Every logical error channel (idling, lattice-surgery merges, the surgery CNOT) was measured in circuit-level experiments with stabilizer-qec and checked by a composition test; ftsim, a Rust state-vector simulator stratified by fault count, runs the programs natively, from Python and in the browser. Results are success probabilities against code distance, error budgets, and extrapolations to RSA-2048 and FeMoco compared with published estimates at their authors' own failure budgets, with the memory model's dependence on circuit and noise model measured.</p>",
+  "creators": [
+    {
+      "name": "Sands, Jasper"
+    }
+  ],
+  "access_right": "open",
+  "license": "MIT",
+  "keywords": [
+    "fault-tolerant quantum computing",
+    "surface code",
+    "lattice surgery",
+    "resource estimation",
+    "Shor's algorithm",
+    "quantum phase estimation",
+    "magic states"
+  ],
+  "related_identifiers": [
+    {
+      "identifier": "https://github.com/Jaspersands/ft-algorithms",
+      "relation": "isSupplementTo",
+      "scheme": "url"
+    },
+    {
+      "identifier": "https://ft.jaspersands.com/report/report.html",
+      "relation": "isDocumentedBy",
+      "scheme": "url"
+    },
+    {
+      "identifier": "10.5281/zenodo.23212075",
+      "relation": "requires",
+      "scheme": "doi"
+    }
+  ]
+}

ftalgo-0.1.0/CITATION.cff

@@ -0,0 +1,33 @@
+cff-version: 1.2.0
+message: "If you use ft-algorithms or its results, please cite it as below."
+title: "ft-algorithms: factoring and chemistry on a simulated fault-tolerant quantum computer"
+abstract: >-
+  Shor's algorithm (full modular exponentiation, textbook and windowed arithmetic) and molecular
+  phase estimation compiled to Clifford+T+Toffoli and run end to end on a simulated rotated
+  surface-code machine whose logical error channels (idling, lattice-surgery merges, the surgery
+  CNOT) were measured by circuit-level simulation with stabilizer-qec and checked by a composition
+  test; ftsim, a Rust state-vector simulator stratified by fault count, runs the programs natively,
+  from Python and in the browser. Results are success probabilities against code distance, error
+  budgets, and extrapolations to RSA-2048 and FeMoco compared with published estimates.
+type: software
+authors:
+  - given-names: Jasper
+    family-names: Sands
+license: MIT
+version: 0.1.0
+repository-code: "https://github.com/Jaspersands/ft-algorithms"
+url: "https://ft.jaspersands.com"
+keywords:
+  - fault-tolerant quantum computing
+  - surface code
+  - lattice surgery
+  - resource estimation
+  - Shor's algorithm
+  - quantum phase estimation
+references:
+  - type: software
+    title: "stabilizer-qec: a quantum error-correction simulator and decoder"
+    authors:
+      - given-names: Jasper
+        family-names: Sands
+    doi: 10.5281/zenodo.23212075

ftalgo-0.1.0/CNAME

@@ -0,0 +1 @@
+ft.jaspersands.com

ftalgo-0.1.0/Cargo.lock

@@ -0,0 +1,184 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "622f3fc73690be383c7214310406f28a90e6edeadc3cea882f9d71e495b9711a"
+dependencies = [
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc74980687109a3b14c72fd458107bf0baa1da1a1a805e178d15501ba9b86d9d"
+dependencies = [
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.23"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a31eee39dddec8330830986fcd7625edb5a24ec90ea038215273bbc3adb08ac6"
+
+[[package]]
+name = "either"
+version = "1.18.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "252afb9ae5eaa683babdc6a068b3f5726eb19e05070c731f9b2a23a7c3e8ed34"
+
+[[package]]
+name = "ftsim"
+version = "0.1.0"
+dependencies = [
+ "pyo3",
+ "rayon",
+]
+
+[[package]]
+name = "heck"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
+
+[[package]]
+name = "libc"
+version = "0.2.190"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78"
+
+[[package]]
+name = "once_cell"
+version = "1.21.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
+
+[[package]]
+name = "portable-atomic"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05c8b63e8d9609db387f0324918f81d68fe27748f084ef092fb35954d0539a85"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.107"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "pyo3"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "700d18fa267b73b9b521fd7e13580e2f446916f176cacee1ab63fcc8191f1655"
+dependencies = [
+ "libc",
+ "once_cell",
+ "portable-atomic",
+ "pyo3-build-config",
+ "pyo3-ffi",
+ "pyo3-macros",
+]
+
+[[package]]
+name = "pyo3-build-config"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b3fc0c4d08f6bb10e71fe39dfb9e2f59c6eb6854e22ec8092f50c69a4499adb"
+dependencies = [
+ "target-lexicon",
+]
+
+[[package]]
+name = "pyo3-ffi"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dfc0b8e19df29aad7086cf977bb0c2a2f143e30567eb113e9cf72b62ca698330"
+dependencies = [
+ "libc",
+ "pyo3-build-config",
+]
+
+[[package]]
+name = "pyo3-macros"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6100e8a4b5eba53afaa5ed078364851a0b2499c553a44c31026b929049b49dc6"
+dependencies = [
+ "proc-macro2",
+ "pyo3-macros-backend",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pyo3-macros-backend"
+version = "0.29.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6143877a16e82b5a727b7127ff4cd86858a24a28d745d72f43e6f227c7b1bdb3"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rayon"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fb39b166781f92d482534ef4b4b1b2568f42613b53e5b6c160e24cfbfa30926d"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "22e18b0f0062d30d4230b2e85ff77fdfe4326feb054b9783a3460d8435c8ab91"
+dependencies = [
+ "crossbeam-deque",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.119"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "target-lexicon"
+version = "0.13.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.26"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"