Merge branch 'master' into 460-element-equality

Author: precicely

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+name: Spell Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  spellcheck:
+    name: Spell Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      
+      - name: Install codespell
+        run: pip install codespell
+      
+      - name: Run codespell
+        run: codespell --config .codespellrc 

.github/workflows/pytest.yml

@@ -74,7 +74,7 @@ jobs:
     strategy:
       matrix:
         os: [ "windows-latest", "ubuntu-latest" , "macos-latest"]
-        python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
     runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v4

.github/workflows/ruff.yml

@@ -6,4 +6,4 @@ jobs:
     continue-on-error: true
     steps:
       - uses: actions/checkout@v3
-      - uses: chartboost/ruff-action@v1
+      - uses: astral-sh/ruff-action@v1

.github/workflows/run-examples.yml

@@ -0,0 +1,56 @@
+name: Run K-Wave Examples
+
+on:
+  schedule:
+    - cron: '0 0 * * 1'  # Every Monday at 00:00 UTC
+  workflow_dispatch:      # Manual trigger
+
+jobs:
+  discover-examples:
+    runs-on: ubuntu-latest
+    outputs:
+      example_paths: ${{ steps.find-examples.outputs.examples }}
+    steps:
+      - uses: actions/checkout@v4
+      - id: find-examples
+        run: |
+          # Find all Python files in examples subdirectories
+          EXAMPLES=$(find examples -name "*.py" -not -path "*/\.*" | jq -R -s -c 'split("\n")[:-1]')
+          echo "examples=$EXAMPLES" >> "$GITHUB_OUTPUT"
+
+  run-examples:
+    needs: discover-examples
+    runs-on: ubuntu-latest
+    timeout-minutes: 60  # 1 hour timeout per example
+    strategy:
+      fail-fast: false  # Continue running other examples even if one fails
+      matrix:
+        example: ${{ fromJson(needs.discover-examples.outputs.example_paths) }}
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ffmpeg
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'  # Matches requires-python from pyproject.toml
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # Install the package with example dependencies
+          pip install -e ".[example]"
+
+      - name: Run example
+        env:
+          KWAVE_FORCE_CPU: 1
+        run: |
+          echo "Running example: ${{ matrix.example }}"
+          python "${{ matrix.example }}" 

.github/workflows/test_example.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       matrix:
         os: [ "windows-latest", "ubuntu-latest" , "macos-latest"]
-        python-version: [ "3.9", "3.10", "3.11", "3.12"]
+        python-version: [ "3.10", "3.11", "3.12", "3.13" ]
     runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v4
@@ -23,7 +23,7 @@ jobs:
         run: |
           python3 examples/us_bmode_linear_transducer/us_bmode_linear_transducer.py
       - name: Upload example results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: example_bmode_reconstruction_results_${{ matrix.os }}_${{ matrix.python-version }}
           path: ${{ github.workspace }}/example_bmode.png

.github/workflows/test_optional_dependencies.yml

@@ -13,7 +13,7 @@ jobs:
         strategy:
             matrix:
                 os: [ "windows-latest", "ubuntu-latest" , "macos-latest"]
-                python-version: [ "3.9", "3.10", "3.11", "3.12" ]
+                python-version: [ "3.10", "3.11", "3.12", "3.13" ]
                 extra_requirements: [ "test", "examples", "docs", "dev", "all" ]
         runs-on: ${{matrix.os}}
         steps:

.github/workflows/test_pages.yml

@@ -10,7 +10,7 @@ jobs:
         fetch-depth: 0 # otherwise, you will fail to push refs to dest repo
     - uses: actions/setup-python@v5
       with:
-        python-version: '3.9'
+        python-version: '3.10'
         cache: 'pip'
     - name: Build and Commit
       uses: waltsims/pages@pyproject.toml-support

.gitignore

@@ -4,6 +4,7 @@
 
 # Virtual environments
 .venv/
+venv/
 
 # Compiled files
 *.pyc

.pre-commit-config.yaml

@@ -17,6 +17,13 @@ repos:
       args: [ --fix ]
     # Run the formatter.
     - id: ruff-format
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+  - id: codespell
+    additional_dependencies:
+      - tomli
+    args: [--write-changes]
 # - repo: https://github.com/pre-commit/pre-commit-hooks
 #   rev: v4.5.0  # Use the ref you want to point at
 #   hooks:

.readthedocs.yaml

@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
 sphinx:
    configuration: docs/conf.py
 python: