Release v4.0.0: scikit-build-core packaging, CI gate, accuracy suites

.condaignore

@@ -0,0 +1,7 @@
+build/
+out/
+.vscode/
+.claude/
+*.mltbx
+nul
+*.reg

.gitattributes

@@ -5,3 +5,4 @@
 *.mexa64 filter=lfs diff=lfs merge=lfs -text
 *.pyd filter=lfs diff=lfs merge=lfs -text
 *.so filter=lfs diff=lfs merge=lfs -text
+*.tif filter=lfs diff=lfs merge=lfs -text

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,37 @@
+## Description
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Firmware version:
+* Hardware:
+* SDK:
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

.github/workflows/ci.yml

@@ -0,0 +1,98 @@
+name: CI
+
+# Build-gate: compile the CUDA extension and import the package on the same
+# platforms conda-forge ships (Windows + Linux). This catches source/recipe
+# drift *before* a release reaches the feedstock. Runners have no GPU, so we
+# only verify the package builds and imports; the full TIFF accuracy suite is
+# run locally on a GPU box before tagging a release.
+
+on:
+  push:
+    branches: [main, develop, conda-forge]
+  pull_request:
+    branches: [main, develop]
+  workflow_dispatch:
+    inputs:
+      python-matrix:
+        description: "Comma-separated Python versions to build"
+        default: "3.12"
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-gate:
+    name: Build & import (${{ matrix.os }}, py${{ matrix.python }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python: ["3.12"]
+
+    defaults:
+      run:
+        shell: bash -el {0}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: false   # source build does not need the LFS test images
+
+      - name: Set up MSVC (Windows)
+        if: runner.os == 'Windows'
+        uses: ilammy/msvc-dev-cmd@v1
+
+      - uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniforge-version: latest
+          channels: conda-forge
+          conda-remove-defaults: "true"
+          # Use base rather than a named env: activating the auto-created
+          # 'test' env intermittently fails on the Windows runners
+          # (EnvironmentNameNotFound), and base always exists.
+          activate-environment: ""
+
+      # CUDA comes from conda-forge (compiler only; runners have no GPU) —
+      # the same channel the feedstock builds against, and one less
+      # third-party action that breaks when runner images move.
+      # CUDA 13.x: nvcc 12.x rejects the MSVC that windows-latest ships
+      # (VS 2026); the 12.x pairing is covered by the feedstock's own CI,
+      # which pins VS 2022.
+      - name: Install build dependencies
+        run: conda install -y -c conda-forge python=${{ matrix.python }} cmake ninja "scikit-build-core>=0.10" numpy pip cuda-nvcc cuda-cudart-dev cuda-cudart-static "cuda-version=13.*"
+
+      - name: Install host compiler for nvcc (Linux)
+        if: runner.os == 'Linux'
+        run: conda install -y -c conda-forge c-compiler cxx-compiler
+
+      - name: Build & install (mirrors the feedstock pip path)
+        env:
+          # A single architecture keeps the gate fast; we only need it to
+          # compile + import, not to run on a specific GPU.
+          CMAKE_ARGS: "-DCMAKE_CUDA_ARCHITECTURES=75"
+          # Force Ninja: on Windows CMake would otherwise pick the Visual
+          # Studio generator, which needs the CUDA VS-integration files that
+          # the conda-forge nvcc package does not ship.
+          CMAKE_GENERATOR: Ninja
+        # On failure, surface the toolchain and first error lines as
+        # annotations so the failure is diagnosable from the run summary.
+        run: |
+          set -o pipefail
+          if ! python -m pip install . --no-build-isolation -v 2>&1 | tee build.log; then
+            echo "::error::cl=$(command -v cl 2>/dev/null || echo MISSING) nvcc=$(command -v nvcc 2>/dev/null || echo MISSING) cmake=$(cmake --version | head -1)"
+            grep -iE "error|fatal" build.log | head -n 8 | while IFS= read -r line; do echo "::error::${line}"; done
+            exit 1
+          fi
+
+      - name: Import smoke test (no GPU required to import)
+        run: |
+          python - <<'PY'
+          import hydra_image_processor as hip
+          import HIP, Hydra            # legacy back-compat shims
+          print("hydra_image_processor", hip.__version__)
+          assert hip.__version__ == "4.0.0", hip.__version__
+          assert HIP is Hydra, "shims should both alias the compiled extension"
+          print("device_count:", hip.device_count())   # 0 on a GPU-less runner
+          PY

.github/workflows/matlab-multibuild.yml

@@ -0,0 +1,155 @@
+name: Multi-Platform Toolbox Build
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  workflow_dispatch:
+
+jobs:
+  build-mex-windows:
+    name: Build MEX (Windows)
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install CUDA Toolkit
+        uses: Jimver/cuda-toolkit@v0.2.14
+        with:
+          cuda: '12.4.1'
+
+      - name: Setup MATLAB
+        uses: matlab-actions/setup-matlab@v2
+
+      - name: Configure CMake
+        run: |
+           cmake -S . -B build -G "Visual Studio 17 2022" -DHYDRA_MODULE_NAME=HIP
+           # Matlab_ROOT is set by setup-matlab and detected by FindMatlab module usually
+           # If not, we might need -DMatlab_ROOT_DIR=$env:MATLAB_ROOT
+
+      - name: Build MEX
+        run: |
+           cmake --build build --config Release --target HydraMex
+
+      - name: Verify Output
+        shell: powershell
+        run: |
+           # Verify the mex file exists in the source tree (copied by autoInstallMex)
+           if (Test-Path "src/MATLAB/+HIP/@Cuda/HIP.mexw64") {
+               Write-Host "MEX file found."
+           } else {
+               Write-Error "MEX file not found in src/MATLAB/+HIP/@Cuda/HIP.mexw64"
+               # Check build dir if autoInstall failed
+               Get-ChildItem -Recurse -Filter HIP.mexw64
+               exit 1
+           }
+
+      - uses: actions/upload-artifact@v4
+        with:
+           name: mex-windows
+           path: src/MATLAB/+HIP/@Cuda/HIP.mexw64
+
+  build-mex-linux:
+    name: Build MEX (Linux)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install CUDA Toolkit
+        uses: Jimver/cuda-toolkit@v0.2.14
+        with:
+          cuda: '12.4.1'
+
+      - name: Setup MATLAB
+        uses: matlab-actions/setup-matlab@v2
+
+      - name: Configure CMake
+        run: |
+           cmake -S . -B build -DHYDRA_MODULE_NAME=HIP
+
+      - name: Build MEX
+        run: |
+           cmake --build build --config Release --target HydraMex
+
+      - name: Verify Output
+        run: |
+           if [ -f "src/MATLAB/+HIP/@Cuda/HIP.mexa64" ]; then
+               echo "MEX file found."
+           else
+               echo "MEX file not found in src/MATLAB/+HIP/@Cuda/HIP.mexa64"
+               find . -name "HIP.mexa64"
+               exit 1
+           fi
+
+      - uses: actions/upload-artifact@v4
+        with:
+           name: mex-linux
+           path: src/MATLAB/+HIP/@Cuda/HIP.mexa64
+
+  package-toolbox:
+    name: Package Toolbox
+    needs: [build-mex-windows, build-mex-linux]
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup MATLAB
+        uses: matlab-actions/setup-matlab@v2
+
+      - name: Download Windows MEX
+        uses: actions/download-artifact@v4
+        with:
+          name: mex-windows
+          path: src/MATLAB/+HIP/@Cuda
+
+      - name: Download Linux MEX
+        uses: actions/download-artifact@v4
+        with:
+          name: mex-linux
+          path: src/MATLAB/+HIP/@Cuda
+
+      - name: Patch PRJ File
+        shell: python
+        run: |
+          import os
+
+          prj_path = r'src/MATLAB/HydraImageProcessor.prj'
+          with open(prj_path, 'r') as f:
+              content = f.read()
+
+          # Replace absolute paths with ${PROJECT_ROOT} if they look like the user's local path
+          # The user's path was D:\Users\ewait\git\programming\hydra-image-processor
+          # We'll just genericize any absolute path pattern if possible, or just the specific one.
+          # Easier: Update the <build-deliverables> section to use ${PROJECT_ROOT}
+
+          # Since we don't know the exact string that might be in the repo vs what was pasted,
+          # we will try to be smart.
+          # But actually, verify if the repo version has absolute paths.
+          # If it uses ${PROJECT_ROOT} mostly, we are good.
+          # The snippet showed absolute path in <build-deliverables>.
+
+          import re
+          # Regex to find <file ...>ANYTHING\Hydra Image Processor.mltbx</file> inside <build-deliverables>
+          # and replace it with <file ...>${PROJECT_ROOT}\Hydra Image Processor.mltbx</file>
+
+          new_content = re.sub(
+              r'(<build-deliverables>\s*<file[^>]*>).*?(\Hydra Image Processor\.mltbx</file>)',
+              r'\1${PROJECT_ROOT}\2',
+              content,
+              flags=re.DOTALL
+          )
+
+          with open(prj_path, 'w') as f:
+              f.write(new_content)
+
+          print("Patched .prj file.")
+
+      - name: Package Toolbox
+        uses: matlab-actions/run-command@v2
+        with:
+          command: |
+             matlab.addons.toolbox.packageToolbox('src/MATLAB/HydraImageProcessor.prj');
+
+      - uses: actions/upload-artifact@v4
+        with:
+           name: HydraImageProcessor.mltbx
+           path: src/MATLAB/Hydra Image Processor.mltbx

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+
+# Tag-driven release. Pushing a `vX.Y.Z` tag (after the CI gate is green on
+# main) creates a GitHub Release. conda-forge's autotick bot detects the new
+# release, opens a version-bump PR on the feedstock (updating version + sha256),
+# and once merged the feedstock builds and publishes every variant.
+#
+# Release checklist:
+#   1. Bump `[project].version` in pyproject.toml and update CHANGELOG.md.
+#   2. Merge to main with a green CI gate.
+#   3. git tag vX.Y.Z && git push origin vX.Y.Z   (must match pyproject version)
+#   4. Merge the feedstock autotick PR (or open one manually).
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write   # required to create a GitHub Release
+
+jobs:
+  release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: false
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Verify tag matches pyproject version
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          pyproj="$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")"
+          echo "tag=$tag  pyproject=$pyproj"
+          if [ "$tag" != "$pyproj" ]; then
+            echo "::error::Tag '$GITHUB_REF_NAME' does not match pyproject version '$pyproj'"
+            exit 1
+          fi
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: gh release create "$GITHUB_REF_NAME" --title "$GITHUB_REF_NAME" --generate-notes --verify-tag

.gitignore

@@ -47,3 +47,19 @@ CmakeCache.txt
 out
 .vs
 CMakeSettings.json
+src/Python/hydra_image_processor.egg-info
+
+# Agent and Build artifacts
+.claude/
+conda-build-dir/
+
+# Compiled extension dropped into the package dir by local CMake/pip builds
+# (the wheel gets its copy from the CMake install rule, not from git)
+/src/Python/hydra_image_processor/*.pyd
+/src/Python/hydra_image_processor/*.so
+/src/Python/hydra_image_processor/*.dylib
+
+# Python build artifacts (scikit-build-core / pip / wheels)
+/dist/
+*.egg-info/
+*.whl