invisensing 1.0.0__tar.gz

invisensing-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+# Continuous-integration sanity check for every push / PR.
+#
+# Builds the Rust extension on Linux against the currently-supported
+# Python versions and runs the pytest suite. Keeps `release.yml`
+# focused on the publishing pipeline (and avoids paying for the full
+# manylinux + macOS + Windows matrix on every commit — only release
+# tags trigger that).
+
+name: CI
+
+on:
+  push:
+    branches: [master, main]
+  pull_request: {}
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: tests · python ${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      # Build the wheel via maturin-action — it handles the Rust
+      # toolchain, the manylinux container, and the venv that recent
+      # `maturin develop` requires. Outputs `target/wheels/*.whl`.
+      - name: Build wheel
+        uses: PyO3/maturin-action@v1
+        with:
+          command: build
+          args: --release --interpreter python${{ matrix.python }} --out target/wheels
+          manylinux: auto
+          sccache: true
+
+      # Install the freshly-built wheel + the runtime deps + pytest.
+      # We use the wheel rather than `maturin develop` so the test run
+      # exercises the exact same artefact that would ship to PyPI.
+      - name: Install wheel + test deps
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pytest
+          python -m pip install --find-links target/wheels invisensing
+
+      - name: Run the test suite
+        run: pytest tests/ -v

invisensing-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: Deploy Doxygen Documentation
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Install Doxygen
+      run: sudo apt-get install -y doxygen graphviz
+
+    - name: Generate Documentation
+      run: doxygen Doxyfile
+
+    - name: Check generated files
+      run: ls -R ./Docs/html
+
+    - name: Debug deploy
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./Docs/html
+        publish_branch: gh-pages
+        dry_run: true
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./Docs/html
+        publish_branch: gh-pages

invisensing-1.0.0/.github/workflows/release-testpypi.yml

@@ -0,0 +1,163 @@
+# Build wheels and publish to **TestPyPI** (test.pypi.org) on demand.
+#
+# Trigger:
+#   - Manual only (Actions tab → "Release to TestPyPI" → Run workflow).
+#     Pick a ref (branch or tag) to build from. No tag push required —
+#     useful for verifying the release pipeline without committing to
+#     a real version number on PyPI proper.
+#
+# Authentication:
+#   - Uses TestPyPI's own Trusted Publishing (OIDC). The trust
+#     relationship must be configured separately on test.pypi.org
+#     (see the comment on the `publish` job below).
+#
+# Version policy:
+#   - PyPI/TestPyPI versions are immutable. If you want to iterate
+#     ("rebuild and re-publish") you must bump the version each time.
+#     Standard practice: use a pre-release suffix while testing —
+#     `1.0.0a1`, `1.0.0rc1`, `1.0.0.dev1`, etc. (PEP 440).
+#   - Edit `pyproject.toml` + `Cargo.toml` to a fresh pre-release
+#     before running, otherwise TestPyPI will reject the upload as
+#     a duplicate.
+
+name: Release to TestPyPI
+
+on:
+  workflow_dispatch: {}
+
+concurrency:
+  group: release-testpypi-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  # ── Linux wheels: 2 archs × cp39-cp313 ──
+  build-linux:
+    name: wheels · linux · ${{ matrix.target }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [x86_64, aarch64]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Build wheels (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --interpreter 3.9 3.10 3.11 3.12 3.13
+          manylinux: 2014
+          sccache: true
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.target }}
+          path: dist/
+
+  # ── macOS wheels: target × python ──
+  build-macos:
+    name: wheels · macos · ${{ matrix.target }} · py${{ matrix.python }}
+    runs-on: ${{ matrix.target == 'x86_64' && 'macos-13' || 'macos-14' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [x86_64, aarch64]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Build wheel (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --interpreter python${{ matrix.python }}
+          sccache: true
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-${{ matrix.target }}-py${{ matrix.python }}
+          path: dist/
+
+  # ── Windows wheels: x86_64 × python ──
+  build-windows:
+    name: wheels · windows · py${{ matrix.python }}
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+      - name: Build wheel (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: x86_64
+          args: --release --out dist --interpreter python${{ matrix.python }}
+          sccache: true
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-py${{ matrix.python }}
+          path: dist/
+
+  # ── Source distribution ──
+  build-sdist:
+    name: sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/
+
+  # ── Publish to TestPyPI ──
+  #
+  # One-time setup on test.pypi.org:
+  #   1. Sign in (separate account from pypi.org — same email is fine).
+  #   2. https://test.pypi.org/manage/account/publishing/ → Add a
+  #      pending publisher with:
+  #        - PyPI Project Name: invisensing
+  #        - Owner: invisensing-io
+  #        - Repository name: python-lib
+  #        - Workflow name: release-testpypi.yml
+  #        - Environment name: testpypi
+  #
+  # One-time setup on GitHub:
+  #   - Settings → Environments → New environment named "testpypi"
+  #     (optionally with required reviewers as for the prod env).
+  publish:
+    name: publish to TestPyPI
+    needs: [build-linux, build-macos, build-windows, build-sdist]
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/invisensing
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Download all build artefacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: List what's about to be published
+        run: ls -la dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+          verbose: true

invisensing-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,176 @@
+# Build multi-platform wheels and publish to PyPI on tagged releases.
+#
+# Trigger:
+#   - Push a tag matching `v*` (e.g. `v1.0.0`) → CI builds wheels for
+#     Linux x86_64/aarch64 + macOS x86_64/arm64 + Windows x86_64 across
+#     CPython 3.9–3.13, plus the source distribution, then uploads them
+#     all to PyPI in a single atomic publish step.
+#
+# Authentication:
+#   - Uses **PyPI Trusted Publishing (OIDC)** — no API token to manage,
+#     no secret to leak. The trust relationship is configured once on
+#     PyPI side.
+#
+# Manual trigger:
+#   - You can also run the workflow from the Actions tab via
+#     `workflow_dispatch` to verify the build matrix without publishing
+#     (publish job only runs on tag pushes).
+
+name: Release to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch: {}
+
+# Only one release pipeline at a time per ref. Cancel an in-flight one
+# if a newer tag is pushed (rare but cheap).
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  # ── Linux wheels: manylinux2014 builds all 5 Python versions per arch ──
+  #
+  # The manylinux container ships every supported CPython, including
+  # 3.14 — but PyO3 0.24 only supports up to 3.13, so we must list the
+  # interpreters explicitly (not `--find-interpreter`, which would pull
+  # 3.14 and fail with "configured Python interpreter version (3.14)
+  # is newer than PyO3's maximum supported version (3.13)").
+  build-linux:
+    name: wheels · linux · ${{ matrix.target }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [x86_64, aarch64]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build wheels (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          # Explicit list — one job builds 5 wheels (cp39-cp313). When
+          # we bump to PyO3 >= 0.25 we can add 3.14 here too.
+          args: --release --out dist --interpreter 3.9 3.10 3.11 3.12 3.13
+          manylinux: 2014
+          sccache: true
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.target }}
+          path: dist/
+
+  # ── macOS wheels: aarch64 only (Apple Silicon native) ──
+  #
+  # `macos-13` (the last GitHub-hosted Intel runner pool) is heavily
+  # saturated — observed >20 min queue time with no runner pickup. The
+  # x86_64 axis is dropped from this release; Intel-Mac users install
+  # via `pip install invisensing` which falls back to the sdist (needs
+  # a Rust toolchain). Add x86_64 back in a follow-up release if there
+  # is real demand. Apple Silicon (arm64) ships normally — that's the
+  # vast majority of current Mac users.
+  build-macos:
+    name: wheels · macos · ${{ matrix.target }} · py${{ matrix.python }}
+    runs-on: macos-14
+    strategy:
+      fail-fast: false
+      matrix:
+        target: [aarch64]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Build wheel (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist --interpreter python${{ matrix.python }}
+          sccache: true
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-${{ matrix.target }}-py${{ matrix.python }}
+          path: dist/
+
+  # ── Windows wheels: x86_64 only, one job per Python version ──
+  build-windows:
+    name: wheels · windows · py${{ matrix.python }}
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Build wheel (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          target: x86_64
+          args: --release --out dist --interpreter python${{ matrix.python }}
+          sccache: true
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-py${{ matrix.python }}
+          path: dist/
+
+  # ── Source distribution (single sdist for all platforms) ─────────────
+  build-sdist:
+    name: sdist
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist (maturin)
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/
+
+  # ── Publish: gathers all wheels + sdist and uploads to PyPI ──────────
+  #
+  # Runs only on tag pushes (skipped on workflow_dispatch). Uses Trusted
+  # Publishing — no PYPI_API_TOKEN, no secret. The `id-token: write`
+  # permission grants this workflow the OIDC token PyPI verifies.
+  publish:
+    name: publish to PyPI
+    needs: [build-linux, build-macos, build-windows, build-sdist]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/invisensing
+    permissions:
+      id-token: write     # OIDC token for Trusted Publishing
+      contents: read
+    steps:
+      - name: Download all build artefacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: List what's about to be published
+        run: ls -la dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true

invisensing-1.0.0/.gitignore

@@ -0,0 +1,34 @@
+# Python build artefacts
+dist/
+build/
+*.egg-info/
+__pycache__/
+*.py[cod]
+*$py.class
+.pytest_cache/
+.tox/
+.coverage
+htmlcov/
+
+# Rust build artefacts (maturin / cargo)
+target/
+*.lock
+Cargo.lock
+
+# Compiled native extension copied into the package by `maturin develop`
+python/invisensing/*.so
+python/invisensing/*.pyd
+
+# IDE / editor
+.vscode/
+.idea/
+*.swp
+
+# Test outputs
+tests/output/
+
+# Generated docs
+Docs/*
+
+# Internal release runbook — kept locally for the maintainer, never pushed
+PUBLISHING.md

invisensing-1.0.0/Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+name = "invisensing-core"
+version = "1.0.0"
+edition = "2021"
+description = "Native Rust core for the Invisensing Python SDK — fast DAT reader and de-interleave kernels for PCIe7821 DAS acquisitions"
+license = "MIT"
+repository = "https://github.com/invisensing-io/python-lib"
+keywords = ["DAS", "fiber-optic", "demodulation", "audace", "pyo3"]
+categories = ["science"]
+readme = "README.md"
+
+[lib]
+# The Python wheel imports this as `invisensing._core` (see lib.rs #[pymodule]).
+name = "_core"
+crate-type = ["cdylib"]
+
+[dependencies]
+# PyO3 binds Rust functions to Python; `extension-module` builds a .so/.pyd that
+# Python's import machinery picks up directly (no libpython link at compile time
+# — needed for portable wheels under PEP 599 / manylinux).
+# PyO3 0.24 brings the fix for the `PyString::from_object` buffer
+# overflow advisory (the 0.22.x branch was never patched). Numpy bumps
+# in lockstep — the two crates pin matching versions to each other.
+pyo3 = { version = "0.24", features = ["extension-module"] }
+# numpy gives us zero-copy `PyArray1`/`PyArray2` constructors and lets us return
+# numpy arrays whose memory is owned by Rust without an extra copy.
+numpy = "0.24"
+
+[profile.release]
+# Wheels ship release builds; tune for runtime perf over compile time.
+lto = "thin"
+codegen-units = 1
+opt-level = 3

invisensing-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 Invisensing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.