V2.17.x -> main

.binder/environment.yml

@@ -0,0 +1 @@
+../conda/environment.yaml

.binder/postBuild

@@ -0,0 +1,8 @@
+#!/bin/bash -v
+
+# stop on error
+set -e
+
+echo "Install Underworld2"
+
+pip install .

.gitattributes

@@ -3,3 +3,5 @@
 *.ipynb	diff=jupyternotebook
 
 *.ipynb	merge=jupyternotebook
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.github/pull_request_template.md

@@ -2,7 +2,7 @@
 
 - [ ] I have read the `CONTRIBUTING.rst` document.
 - [ ] I have updated the docstrings accordingly.
-- [ ] I have updated `CHANGES.md`.
+- [ ] I have updated `CHANGELOG.md`.
 - [ ] I have added tests which give complete coverage for my changes.
 - [ ] I have provided a usage example for my changes. 
 - [ ] All new and existing tests pass.

.github/workflows/conda-build-test.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches:
       - main
-      - developmemt
+      - development
       - v2.*
   pull_request:
     branches:
@@ -17,20 +17,23 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
 
       - name: Set up Micromamba
-        uses: mamba-org/setup-micromamba@v2
+        uses: mamba-org/setup-micromamba@v3
         with:
-          environment-file: conda/environment.yaml
+          environment-file: conda/CI-env.lock
+          environment-name: uw-2.17
+          generate-run-shell: true
           cache-environment: true
-          cache-downloads: true
-          init-shell: bash
-
-      - name: Compile the code, run tests
-        shell: micromamba-shell {0}
+          #cache-downloads: false
+
+      - name: compile and pytests
         run: | 
-          micromamba list
-          pip list
-          pip install .
-          pytest ./docs/pytests/tests.py ./docs/pytests/test_examples.py
+          micromamba env list 
+          micromamba list -v
+          env
+          pip install git+https://github.com/kinnala/meshplex badlands
+          pip install . --no-build-isolation
+          pytest ./docs/pytests/tests.py ./docs/pytests/test_examples.py ./docs/pytests/test_UWGeo_examples.py
+        shell: micromamba-shell {0}

.github/workflows/issue-metrics.yml

@@ -0,0 +1,43 @@
+name: Monthly issue metrics - Underworld
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "30 22 25 * *" # 22:30 on the 25th every month
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: issue metrics
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: read
+    steps:
+      - name: Get dates for last month
+        shell: bash
+        run: |
+          # Calculate the first day of the previous month
+          first_day=$(date -d "last month" +%Y-%m-01)
+
+          # Calculate the last day of the previous month
+          last_day=$(date -d "$first_day +1 month -1 day" +%Y-%m-%d)
+
+          #Set an environment variable with the date range
+          echo "$first_day..$last_day"
+          echo "last_month=$first_day..$last_day" >> "$GITHUB_ENV"
+
+      - name: Run issue-metrics tool
+        uses: github-community-projects/issue-metrics@v4
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          SEARCH_QUERY: 'repo:underworldcode/underworld2 repo:underworldcode/underworld3 is:issue created:${{ env.last_month }} -reason:"not planned"'
+
+      - name: Create issue
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Monthly issue metrics report
+          token: ${{ secrets.GH_TOKEN }}
+          content-filepath: ./issue_metrics.md
+          assignees: julesghub

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,83 @@
+name: Publish Python distribution 📦 to TestPyPI then PyPI
+
+on: 
+  workflow_dispatch: 
+  release:
+    type: [publish] # triggers when you publish a GitHub release
+
+jobs:
+
+  build_uw:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout release
+      uses: actions/checkout@v4
+
+    - name: Set up Micromamba
+      uses: mamba-org/setup-micromamba@v2
+      with:
+        environment-file: conda/CI-env.lock
+        environment-name: uw-2.17
+        generate-run-shell: true
+        cache-environment: true
+
+    - name: Form tarball to publish
+      run: | 
+        micromamba env list 
+        micromamba list -v
+        pip install build
+        env
+        python3 -m build --sdist
+      shell: micromamba-shell {0}
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: underworld-${{ github.event.release.name }}
+        path: dist/
+
+  publish_testpypi:
+    name: Publish to TestPyPI
+    needs: build_uw
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/underworld  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download package
+        uses: actions/download-artifact@v4
+        with:
+          name: underworld-${{ github.event.release.name }}
+          path: dist/
+
+      - name: Push 📦 to testPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish_pypi:
+    name: Publish to PyPI
+    needs: publish_testpypi 
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/underworld
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download package
+        uses: actions/download-artifact@v4
+        with:
+          name: underworld-${{ github.event.release.name }}
+          path: dist/
+
+      - name: Push 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -106,3 +106,7 @@ docs/test/Pressure_Error.png
 
 docs/test/uplift/buildMount.txt
 docs/test/temp.h5
+
+# pixi environments
+.pixi
+*.egg-info

.zenodo.json

@@ -1,21 +1,30 @@
 {
     "creators": [
-        {
-            "name": "Romain Beucher",
-            "affiliation": "Research School of Earth Sciences, The Australian National University",
-            "orcid": "0000-0003-3891-5444"
-        },
         {
             "name": "Julian Giordani",
             "affiliation": "School of Earth Science, The University of Sydney",
             "orcid": "0000-0003-4515-9296"
         },
+        {
+            "name": "Ben Knight",
+            "affiliation": "Curtin University",
+            "orcid": "0000-0001-7919-2575"
+        },  
+        {
+            "name": "Neng Lu",
+            "affiliation": "Research School of Earth Sciences, The Australian National University",
+            "orcid": "0000-0001-9424-2315"
+        },
         {
             "name": "Louis Moresi",
             "affiliation": "Research School of Earth Sciences, The Australian National University",
             "orcid": "0000-0003-3685-174X"
         },
         {
+            "name": "Romain Beucher",
+            "affiliation": "Research School of Earth Sciences, The Australian National University",
+            "orcid": "0000-0003-3891-5444"
+        },        {
             "name": "John Mansour",
             "affiliation": "Monash eResearch Centre, Monash University",
             "orcid": "0000-0001-5865-1664"
@@ -84,16 +93,6 @@
             "affiliation": "School of Earth and Ocean Sciences, Cardiff University",
             "orcid": "0000-0002-7182-1864"
         },
-        {
-            "name": "Ben Knight",
-            "affiliation": "Monash University",
-            "orcid": "0000-0001-7919-2575"
-        },  
-        {
-            "name": "Neng Lu",
-            "affiliation": "Research School of Earth Sciences, The Australian National University",
-            "orcid": "0000-0001-9424-2315"
-        } 
     ],
     "license": "lgpl-3.0",
     "title": "Underworld2: Python Geodynamics Modelling for Desktop, HPC and Cloud",

CHANGES.md → CHANGELOG.md

@@ -1,5 +1,40 @@
-CHANGES: Underworld2
+CHANGELOG: Underworld2
 =======================
+
+Release 2.17.2 [2026-05-07]
+---------------------------
+New:
+* ALE-IB (Arbitrary Lagragian Eulerian - Internal Boundary) models added. #753
+
+Changes:
+* Adding UWGeo example tests to CI testing.
+* Rename files .yaml -> .yml.
+
+Fixes:
+* clean.sh fix
+* PostHog metrics changed - 'distinct_id' fix. 
+
+Release 2.17.1 [2026-02-01]
+---------------------------
+Changes:
+* Support python 3.9-3.12.
+
+Fixes:
+* Swarm checkpoint fix - `proc_offset` is no longer a h5py attribute. #749
+
+
+Release 2.17 [2025-07-08]
+-------------------------
+New:
+* Move container definitions to `./docs/development/container/`. Podman container is now preferred over docker and Dockerfiles.
+
+Changes:
+* UWGeodynamics - Badlands coupling imporvements.  See [blog](https://www.underworldcode.org/new-features-of-the-surface-coupling-framework-in-underworld-2/)
+
+Fixes:
+* Fix for Badlands coupling - Tectonic velocity now evaluated at surface, rather than Badlands basement recGrid. #725
+* UWGeo checkpoint times fix, e5d9ba1
+
 Release 2.16 [2025-03-03]
 ---------------------------
 New: