dioptrin 0.7.0__tar.gz

dioptrin-0.7.0/.gitattributes

@@ -0,0 +1 @@
+test_data/CeO2_Pilatus1M.tif filter=lfs diff=lfs merge=lfs -text

dioptrin-0.7.0/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  fmt:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo clippy --all-targets -- -D warnings
+      - run: cargo clippy --all-targets --features python -- -D warnings
+
+  test:
+    name: Test (${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - run: cargo build --all-targets
+      - run: cargo test
+
+  test-python:
+    name: Test Python bindings
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install maturin
+      - run: cargo build --features python
+      - run: maturin build --features python

dioptrin-0.7.0/.github/workflows/python-release.yml

@@ -0,0 +1,129 @@
+name: Python Build
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  wheels:
+    name: Wheels (${{ matrix.os }}, Python ${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-14, macos-15-intel]
+        python: ['3.11', '3.12', '3.13', '3.14', '3.15']
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python }}
+          allow-prereleases: true
+      - name: Build unrestricted wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          args: --release --out dist --features python -i ${{ matrix.python }}
+          sccache: 'true'
+          manylinux: '2_28'
+      - name: Check publication contents
+        run: python scripts/check_release_wheels.py dist
+      - name: Install and check unrestricted wheel
+        shell: bash
+        run: |
+          python -m pip install --only-binary=:all: dist/*.whl
+          python scripts/check_unrestricted_install.py
+      - uses: actions/upload-artifact@v7
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.python }}
+          path: dist/*.whl
+          if-no-files-found: error
+
+  sdist:
+    name: Source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-python@v7
+        with:
+          python-version: '3.13'
+      - uses: dtolnay/rust-toolchain@stable
+      - run: python -m pip install maturin
+      - run: maturin sdist --out dist
+      - run: python scripts/check_release_wheels.py dist
+      - uses: actions/upload-artifact@v7
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [wheels, sdist]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/download-artifact@v8
+        with:
+          pattern: wheels-*
+          path: dist
+          merge-multiple: true
+      - uses: actions/download-artifact@v8
+        with:
+          name: sdist
+          path: dist
+      - run: python scripts/check_release_wheels.py dist
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          python - <<'PYNOTES'
+          import os, re
+          from pathlib import Path
+          version = os.environ["GITHUB_REF_NAME"].removeprefix("v")
+          changelog = Path("CHANGELOG.md").read_text()
+          match = re.search(r"^## \[" + re.escape(version) + r"\].*?\n(.*?)(?=^## \[|\Z)",
+                            changelog, flags=re.MULTILINE | re.DOTALL)
+          if match is None or not match.group(1).strip():
+              raise SystemExit("Missing release notes for " + version)
+          notes = match.group(1).strip()
+          root = "https://github.com/" + os.environ["GITHUB_REPOSITORY"]
+          root += "/blob/" + os.environ["GITHUB_REF_NAME"] + "/docs/"
+          notes = notes.replace("](docs/", "](" + root)
+          Path("RELEASE_NOTES.md").write_text(notes + "\n")
+          PYNOTES
+          gh release create "$GITHUB_REF_NAME" --verify-tag --notes-file RELEASE_NOTES.md dist/*.whl dist/*.tar.gz
+
+  pypi-publish:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [wheels, sdist, release]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dioptrin/
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/download-artifact@v8
+        with:
+          pattern: wheels-*
+          path: dist
+          merge-multiple: true
+      - uses: actions/download-artifact@v8
+        with:
+          name: sdist
+          path: dist
+      - run: python scripts/check_release_wheels.py dist
+      - name: Publish wheels and source distribution
+        uses: pypa/gh-action-pypi-publish@v1.14.2
+        with:
+          attestations: false

dioptrin-0.7.0/.github/workflows/test.yml

@@ -0,0 +1,136 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  rust-tests:
+    name: Rust Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-git-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo build
+        uses: actions/cache@v4
+        with:
+          path: target
+          key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run Rust tests
+        run: cargo test
+
+      - name: Check Rust formatting
+        run: cargo fmt -- --check
+
+  python-tests:
+    name: Python Tests & Examples
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          allow-prereleases: true
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-git-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo build
+        uses: actions/cache@v4
+        with:
+          path: target
+          key: ${{ runner.os }}-py${{ matrix.python-version }}-cargo-build-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install Python dependencies
+        run: |
+          uv venv .venv
+          source .venv/bin/activate
+          uv pip install maturin
+
+      - name: Build Python package
+        run: |
+          source .venv/bin/activate
+          maturin develop --features python
+
+      - name: Install test dependencies
+        run: |
+          source .venv/bin/activate
+          uv pip install .[test]
+
+      - name: Generate test output data
+        run: cargo test
+
+      - name: Test integration and array batch regressions
+        run: |
+          source .venv/bin/activate
+          python -m unittest python_examples.test_fast_math python_examples.test_batch_array_borrowing python_examples.test_image_switching python_examples.test_azimuthal_std
+
+      - name: Test typed TIFF input and persistent file workers
+        run: |
+          source .venv/bin/activate
+          python scripts/check_file_pipeline.py
+
+      - name: Run Python examples
+        run: |
+          source .venv/bin/activate
+          python test_examples.py
+
+  benchmarks:
+    name: Benchmarks (no regression check)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: true
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Run benchmarks
+        run: |
+          cargo bench --bench integrate --no-run
+          cargo bench --bench build --no-run
+          cargo bench --bench integrator --no-run

dioptrin-0.7.0/.gitignore

@@ -0,0 +1,19 @@
+.vscode
+
+/target
+/Cargo.lock
+
+test_data/*.tif
+!test_data/CeO2_Pilatus1M.tif
+!test_data/LaB6_40keV_MarCCD.tif
+!test_data/ceo2_side.tif
+test_data/*.tiff
+test_data/*.h5
+test_data/test_output/*.png
+test_data/test_output/*.txt
+
+*.ipynb
+notebooks/.ipynb_checkpoints
+
+keys/private.key
+license.key

dioptrin-0.7.0/.python-version

@@ -0,0 +1 @@
+3.13

dioptrin-0.7.0/AGENTS.md

@@ -0,0 +1,33 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+- `src/` contains the Rust library code, organized by domain modules like `integration/`, `lut/`, `math/`, and core files such as `lib.rs`, `geometry.rs`, `frame.rs`, and `poni.rs`.
+- `benches/` holds Criterion benchmarks (`integrate`, `build`) and their harness configs.
+- `test_data/` stores PONI inputs and reference outputs; tests also create `test_data/test_output/`.
+- `notebooks/` contains Python notebooks/scripts for validation checks.
+- `target/` is Cargo build output and should not be edited manually.
+
+## Build, Test, and Development Commands
+- `cargo build` compiles the library.
+- `cargo test` runs unit/integration tests in `src/`, including data-driven checks.
+- `cargo bench --bench integrate` runs integration benchmarks.
+- `cargo bench --bench build` runs LUT build benchmarks.
+
+## Coding Style & Naming Conventions
+- Rust 2021 edition; follow standard Rust formatting (`cargo fmt`) with default rustfmt settings (no repo-specific config).
+- Use idiomatic naming: `snake_case` for functions/modules, `CamelCase` for types, `SCREAMING_SNAKE_CASE` for constants.
+- Keep module boundaries aligned with the existing domain structure (e.g., integration logic under `src/integration/`).
+
+## Testing Guidelines
+- Tests live alongside code (e.g., `src/integration/tests.rs`) and use `#[test]`.
+- Some tests download `test_data/CeO2_Pilatus1M.tif` from GitHub on first run; ensure network access is available.
+- Generated comparison output is written to `test_data/test_output/`; keep this directory out of commits unless explicitly requested.
+
+## Commit & Pull Request Guidelines
+- Commit messages follow a simple type prefix: `feat:`, `fix:`, `refactor:`, `doc:`, `bench:` (lowercase), then a short imperative summary.
+- PRs should describe the change, list affected modules (e.g., `src/lut/`), and include benchmark or test results when performance is touched.
+- If behavior or outputs change, note any updated reference data under `test_data/test_reference/`.
+
+## Configuration & Data Tips
+- PONI geometry files live in `test_data/`; prefer adding new fixtures there with clear naming (e.g., `v3.poni`).
+- For large artifacts or external datasets, document download sources rather than committing binaries.