Merge pull request #4289 from pybamm-team/v24.5

Release v24.5
pybamm-team · Jul 26, 2024 · d026075 · d026075
2 parents bb6fc9b + 7661ed9
commit d026075
Show file tree

Hide file tree

Showing 439 changed files with 16,286 additions and 109,914 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1,13 +1,14 @@
 {
   "files": [
+    "all_contributors.md",
     "README.md"
   ],
   "imageSize": 100,
   "commit": false,
   "badgeTemplate": "[![All Contributors](https://img.shields.io/badge/all_contributors-<%= contributors.length %>-orange.svg)](#-contributors)",
   "contributors": [
     {
-      "login": "tinosulzer",
+      "login": "valentinsulzer",
       "name": "Valentin Sulzer",
       "avatar_url": "https://avatars3.githubusercontent.com/u/20817509?v=4",
       "profile": "https://sites.google.com/view/valentinsulzer",
@@ -215,7 +216,8 @@
       "profile": "https://github.com/jonchapman1",
       "contributions": [
         "ideas",
-        "fundingFinding"
+        "fundingFinding",
+        "doc"
       ]
     },
     {
@@ -772,7 +774,9 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/99216956?v=4",
       "profile": "https://github.com/prady0t",
       "contributions": [
-        "infra"
+        "infra",
+        "code",
+        "test"
       ]
     },
     {
@@ -793,6 +797,149 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "AlessioBugetti",
+      "name": "Alessio Bugetti",
+      "avatar_url": "https://avatars.githubusercontent.com/u/38499721?v=4",
+      "profile": "https://github.com/AlessioBugetti",
+      "contributions": [
+        "infra",
+        "code",
+        "doc",
+        "test"
+      ]
+    },
+    {
+      "login": "kawaMANMI",
+      "name": "kawaMANMI",
+      "avatar_url": "https://avatars.githubusercontent.com/u/39382602?v=4",
+      "profile": "https://github.com/kawaMANMI",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "Akhil-Sharma30",
+      "name": "AKHIL SHARMA",
+      "avatar_url": "https://avatars.githubusercontent.com/u/68015525?v=4",
+      "profile": "http://akhilsharma.info",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "HarshvirSandhu",
+      "name": "Harshvir Sandhu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/75773763?v=4",
+      "profile": "https://github.com/HarshvirSandhu",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "lorenzofavaro",
+      "name": "Lorenzo",
+      "avatar_url": "https://avatars.githubusercontent.com/u/44714920?v=4",
+      "profile": "https://github.com/lorenzofavaro",
+      "contributions": [
+        "code",
+        "test",
+        "doc"
+      ]
+    },
+    {
+      "login": "AndyLiuElysia",
+      "name": "AndyLiuElysia",
+      "avatar_url": "https://avatars.githubusercontent.com/u/143705453?v=4",
+      "profile": "https://github.com/AndyLiuElysia",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Hongmeiqi",
+      "name": "Hongmeiqi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/143798726?v=4",
+      "profile": "https://github.com/Hongmeiqi",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "mleot",
+      "name": "mleot",
+      "avatar_url": "https://avatars.githubusercontent.com/u/140573653?v=4",
+      "profile": "https://github.com/mleot",
+      "contributions": [
+        "code",
+        "test"
+      ]
+    },
+    {
+      "login": "abhicodes369",
+      "name": "Abhi ram",
+      "avatar_url": "https://avatars.githubusercontent.com/u/119055274?v=4",
+      "profile": "https://github.com/abhicodes369",
+      "contributions": [
+        "test"
+      ]
+    },
+    {
+      "login": "parkec3",
+      "name": "Caitlin D. Parke",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26883801?v=4",
+      "profile": "https://github.com/parkec3",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Afgr1087",
+      "name": "Andres Felipe Galvis Rodriguez",
+      "avatar_url": "https://avatars.githubusercontent.com/u/56610829?v=4",
+      "profile": "https://github.com/Afgr1087",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "ikorotkin",
+      "name": "Ivan Korotkin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/29599800?v=4",
+      "profile": "https://github.com/ikorotkin",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "santacodes",
+      "name": "Santhosh",
+      "avatar_url": "https://avatars.githubusercontent.com/u/52504160?v=4",
+      "profile": "https://github.com/santacodes",
+      "contributions": [
+        "code",
+        "infra"
+      ]
+    },
+    {
+      "login": "smitasahu2",
+      "name": "Smita Sahu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/57876346?v=4",
+      "profile": "https://github.com/smitasahu2",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "Ubham16",
+      "name": "Ubham16",
+      "avatar_url": "https://avatars.githubusercontent.com/u/173074476?v=4",
+      "profile": "https://github.com/Ubham16",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs
@@ -10,3 +10,5 @@ a63e49ece0f9336d1f5c2562f7459e555c6e6693
 ff6d81c01331c7d269303b4a8321d9881bdf98fa
 # migrated to ruff-format - https://github.com/pybamm-team/PyBaMM/pull/3655
 60ebd4148059a95428a496f4f55c1175ead362d3
+# implemented cleaner string formatting via f-strings - https://github.com/pybamm-team/PyBaMM/pull/3890
+f395819d1c874071b7e76e32ec4f0bbe42462b48
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,34 @@
+# Automatically request reviews from maintainers
+
+# Package
+/pybamm/discretisations/ @martinjrobins @rtimms @valentinsulzer
+/pybamm/experiment/ @brosaplanella @martinjrobins @rtimms @valentinsulzer @TomTranter
+/pybamm/expression_tree/ @martinjrobins @rtimms @valentinsulzer
+/pybamm/geometry/ @martinjrobins @rtimms @valentinsulzer
+/pybamm/input/ @brosaplanella @DrSOKane @rtimms @valentinsulzer @TomTranter @kratman
+/pybamm/meshes/ @martinjrobins @rtimms @valentinsulzer @rtimms
+/pybamm/models/ @brosaplanella @DrSOKane @rtimms @valentinsulzer @TomTranter @rtimms
+/pybamm/parameters/ @brosaplanella @DrSOKane @rtimms @valentinsulzer @TomTranter @rtimms  @kratman
+/pybamm/plotting/ @martinjrobins @rtimms @Saransh-cpp @valentinsulzer @rtimms  @kratman @agriyakhetarpal
+/pybamm/solvers/ @martinjrobins @rtimms @valentinsulzer @TomTranter @rtimms
+/pybamm/spatial_methods/ @martinjrobins @rtimms @valentinsulzer @rtimms
+/pybamm/* @pybamm-team/maintainers # the files directly under /pybamm/, will not recurse
+
+# CI/CD workflows
+/.github/ @martinjrobins @Saransh-cpp @agriyakhetarpal @kratman @arjxn-py
+
+# Benchmarks
+/benchmarks/ @brosaplanella @Saransh-cpp @agriyakhetarpal @arjxn-py
+
+# Documentation
+/docs/ @kratman @arjxn-py @agriyakhetarpal @Saransh-cpp
+
+# Example scripts
+/examples/ @kratman @agriyakhetarpal @Saransh-cpp
+
+# Installation and other scripts
+/scripts/ @martinjrobins @Saransh-cpp @agriyakhetarpal @kratman @arjxn-py
+
+# Files in the root directory
+/* @martinjrobins @Saransh-cpp @agriyakhetarpal @kratman @arjxn-py
+/CHANGELOG.md # no owner (almost every PR edits the CHANGELOG)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -34,7 +34,7 @@ body:
     id: reproduce
     attributes:
       label: Steps to Reproduce
-      description: Tell us how to reproduce this behaviour. Ideally, this should take the form of a [Minimum Workable Example](https://stackoverflow.com/help/minimal-reproducible-example)
+      description: Tell us how to reproduce this behaviour. Ideally, this should include a code block which produces the error. Strive to make this example as small and simple as possible. It should contain the code required to reproduce the error, and no additional code. For example, if your code includes lines to run a simulation, then lines to plot the results, and the lines to run the simulation fail, only include those lines (and not the plotting lines, which are irrelevant). Often, the act of simplifying code to pinpoint errors can help you find bugs in your own code. For more information, see [these references](https://en.wikipedia.org/wiki/Minimal_reproducible_example#External_links)
     validations:
       required: true
   - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
 blank_issues_enabled: true
 contact_links:
   - name: I'm unsure where to go
-    url: https://www.pybamm.org/contact
+    url: https://www.pybamm.org/community
     about: If you are unsure where to go, then joining our chat is recommended; Just ask!
diff --git a/.github/codecov.yml b/.github/codecov.yml
@@ -1,2 +0,0 @@
-ignore:
-  - pybamm/install_odes.py

diff --git a/.github/workflows/benchmark_on_push.yml b/.github/workflows/benchmark_on_push.yml
@@ -2,7 +2,6 @@ name: Run benchmarks on push
 on:
   push:
     branches: [main, develop]
-  pull_request:
 
 concurrency:
   # Cancel intermediate builds always
@@ -14,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up Python 3.8
+      - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: 3.8
+          python-version: 3.12
 
       - name: Install Linux system dependencies
         run: |

diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -7,15 +7,11 @@ on:
     - develop
 
 jobs:
-  build_docker_images:
+  build_docker_image:
     # This workflow is only of value to PyBaMM and would always be skipped in forks
     if: github.repository_owner == 'pybamm-team'
-    name: Image (${{ matrix.build-args }})
+    name: Build image
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        build-args: ["No solvers", "JAX", "ODES", "IDAKLU", "ALL"]
-      fail-fast: true
 
     steps:
       - name: Checkout
@@ -33,27 +29,12 @@ jobs:
             username: ${{ secrets.DOCKERHUB_USERNAME }}
             password: ${{ secrets.DOCKERHUB_TOKEN }}
 
-      - name: Create tags for Docker images based on build-time arguments
-        id: tags
-        run: |
-          if [ "${{ matrix.build-args }}" = "No solvers" ]; then
-            echo "tag=latest" >> "$GITHUB_OUTPUT"
-          elif [ "${{ matrix.build-args }}" = "JAX" ]; then
-            echo "tag=jax" >> "$GITHUB_OUTPUT"
-          elif [ "${{ matrix.build-args }}" = "ODES" ]; then
-            echo "tag=odes" >> "$GITHUB_OUTPUT"
-          elif [ "${{ matrix.build-args }}" = "IDAKLU" ]; then
-            echo "tag=idaklu" >> "$GITHUB_OUTPUT"
-          elif [ "${{ matrix.build-args }}" = "ALL" ]; then
-            echo "tag=all" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Build and push Docker image to Docker Hub (${{ matrix.build-args }})
-        uses: docker/build-push-action@v5
+      - name: Build and push Docker image to Docker Hub
+        uses: docker/build-push-action@v6
         with:
           context: .
           file: scripts/Dockerfile
-          tags: pybamm/pybamm:${{ steps.tags.outputs.tag }}
+          tags: pybamm/pybamm:latest
           push: true
           platforms: linux/amd64, linux/arm64
 

diff --git a/.github/workflows/lychee_url_checker.yml b/.github/workflows/lychee_url_checker.yml
@@ -17,7 +17,7 @@ jobs:
 
       # cache Lychee results to avoid hitting rate limits
       - name: Restore lychee cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: .lycheecache
           key: cache-lychee-${{ github.sha }}
@@ -28,7 +28,7 @@ jobs:
 
       # use stable version for now to avoid breaking changes
       - name: Lychee URL checker
-        uses: lycheeverse/lychee-action@v1.8.0
+        uses: lycheeverse/lychee-action@v1.10.0
         with:
           # arguments with file types to check
           args: >-
@@ -47,6 +47,7 @@ jobs:
             --exclude-path ./scripts/update_version.py
             --exclude-path asv.conf.json
             --exclude-path docs/conf.py
+            --exclude-path all_contributors.md
             './**/*.rst'
             './**/*.md'
             './**/*.py'

diff --git a/.github/workflows/need_reply_remove.yml b/.github/workflows/need_reply_remove.yml
@@ -1,6 +1,8 @@
 name: Remove needs-reply label
 
 on:
+  schedule:
+      - cron:  '0 3 * * 1'
   issue_comment:
     types:
       - created
@@ -11,7 +13,8 @@ jobs:
     if: |
       github.event.comment.author_association != 'OWNER' &&
       github.event.comment.author_association != 'COLLABORATOR' &&
-      github.repository_owner == 'pybamm-team'
+      github.repository_owner == 'pybamm-team' &&
+      github.event_name != 'pull_request'
     steps:
       - name: Remove needs-reply label
         uses: octokit/[email protected]