Merge pull request #771 from pybop-team/25.6

Release v25.6

Author: NicolaCourtier

.all-contributorsrc

@@ -159,6 +159,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "vpratz",
+      "name": "Valentin Pratz",
+      "avatar_url": "https://avatars.githubusercontent.com/u/112951103?v=4",
+      "profile": "https://https://github.com/vpratz",
+      "contributions": [
+        "example"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/test_on_pull_request.yaml

@@ -37,7 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-13, macos-14]
+        os: [ubuntu-latest, windows-latest]
         python-version: ["3.12"]
 
     name: Integration tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
@@ -90,7 +90,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-13, macos-14]
+        os: [ubuntu-latest, windows-latest, macos-14]
         python-version: ["3.12"]
 
     name: Test examples (${{ matrix.os }} / Python ${{ matrix.python-version }})

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.11.2"
+    rev: "v0.12.3"
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]

CHANGELOG.md

@@ -8,6 +8,26 @@
 
 ## Breaking Changes
 
+# [v25.6](https://github.com/pybop-team/PyBOP/tree/v25.6) - 2025-07-16
+
+## Features
+
+- [#767](https://github.com/pybop-team/PyBOP/pull/767) - Adds the `GroupedSPM` model for parameter identification.
+- [#644](https://github.com/pybop-team/PyBOP/pull/644) - Adds example applications for common battery experiments.
+
+## Optimisations
+
+- [#763](https://github.com/pybop-team/PyBOP/pull/763) - Updates the GITT pulse fitting method to allow iteration over many pulses.
+
+## Bug Fixes
+
+- [#771](https://github.com/pybop-team/PyBOP/pull/771) - Match naming of `n_sensitivity_samples` and fix intermittent `test_optimisation_f_guessed` test.
+- [#737](https://github.com/pybop-team/PyBOP/pull/737) - Sensitivities no longer available for CasadiSolver in Pybamm v25.6 onwards. Updates Hallemans example scripts.
+- [#705](https://github.com/pybop-team/PyBOP/pull/705) - Bug fix `fitting_problem.evaulate()` failure return type alongside fixes for Pybamm `v25.4`.
+- [#546](https://github.com/pybop-team/PyBOP/pull/546) - Default Pybamm solver to `IDAKLU`, changes required for Pybamm v25.4.1
+
+## Breaking Changes
+
 # [v25.3](https://github.com/pybop-team/PyBOP/tree/v25.3) - 2025-03-28
 
 ## Features

CITATION.cff

@@ -31,5 +31,5 @@ keywords:
 journal: "arXiv"
 date-released: 2024-12-20
 doi: 10.48550/arXiv.2412.15859
-version: "25.3" # Update this alongside new releases
+version: "25.6" # Update this alongside new releases
 repository-code: 'https://www.github.com/pybop-team/pybop'

README.md

@@ -93,8 +93,8 @@ The table below lists the currently supported [models](https://github.com/pybop-
 | Multi-Species Multi-Reaction (MSMR)           | Minkowski                          | Weight Decayed Adaptive Moment Estimation (AdamW) <tr></tr>        |
 | Weppner-Huggins                               | Sum of Power                       | Improved Resilient Backpropagation (iRProp-) <tr></tr>             |
 | Equivalent Circuit Models (ECM)               | Gaussian Log Likelihood            | SciPy Minimize & Differential Evolution  <tr></tr>                 |
-| Grouped-parameter SPMe (GroupedSPMe)          | Log Posterior                      | Cuckoo Search  <tr></tr>                                           |
-|                                               | Gravimetric Energy / Power Density | Simulated Annealing  <tr></tr>                                     |
+| Grouped-parameter SPM (GroupedSPM)            | Log Posterior                      | Cuckoo Search  <tr></tr>                                           |
+| Grouped-parameter SPMe (GroupedSPMe)          | Gravimetric Energy / Power Density | Simulated Annealing  <tr></tr>                                     |
 |                                               | Volumetric Energy / Power Density  | Random Search <tr></tr>                                            |
 |                                               |                                    | Gradient Descent <tr></tr>                                         |
 |                                               |                                    | Nelder Mead <tr></tr>                                              |
@@ -118,7 +118,7 @@ PyBOP is released under the [BSD 3-Clause License](https://github.com/pybop-team
 
 ## Contributors ✨
 
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+Thanks goes to these wonderful people:
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
@@ -145,6 +145,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/pipliggins"><img src="https://avatars.githubusercontent.com/u/55396775?v=4?s=100" width="100px;" alt="Pip Liggins"/><br /><sub><b>Pip Liggins</b></sub></a><br /><a href="https://github.com/pybop-team/PyBOP/commits?author=pipliggins" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/vpratz"><img src="https://avatars.githubusercontent.com/u/112951103?v=4?s=100" width="100px;" alt="Valentin Pratz"/><br /><sub><b>Valentin Pratz</b></sub></a><br /><a href="https://github.com/pybop-team/PyBOP/commits?author=vpratz" title="Examples">💡</a></td>
     </tr>
   </tbody>
 </table>

conftest.py

@@ -1,4 +1,5 @@
 import matplotlib
+import numpy as np
 import plotly
 import pytest
 
@@ -76,3 +77,8 @@ def pytest_collection_modifyitems(config, items):
                 reason=f"Test does not match the selected options: {', '.join(selected_markers)}"
             )
             item.add_marker(skip_this)
+
+
+@pytest.fixture(autouse=True)
+def set_random_seed():
+    np.random.seed(40)

docs/_static/switcher.json

@@ -4,11 +4,16 @@
       "url": "https://pybop-docs.readthedocs.io/en/latest/"
     },
     {
-      "name": "v25.3 (stable)",
-      "version": "v25.3",
-      "url": "https://pybop-docs.readthedocs.io/en/v25.3/",
+      "name": "v25.6 (stable)",
+      "version": "v25.6",
+      "url": "https://pybop-docs.readthedocs.io/en/v25.6/",
       "preferred": true
     },
+    {
+      "name": "v25.3",
+      "version": "v25.3",
+      "url": "https://pybop-docs.readthedocs.io/en/v25.3/"
+    },
     {
       "name": "v25.1",
       "version": "v25.1",

examples/notebooks/battery_parameterisation/monte_carlo_ecm_identification.ipynb

@@ -567,76 +567,13 @@
    "execution_count": null,
    "id": "26",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "Using Haario-Bardenet adaptive covariance MCMC\n",
-      "Generating 3 chains.\n",
-      "Running in parallel with 12 worker processes.\n",
-      "/Users/engs2510/.pyenv/versions/3.12.4/lib/python3.12/multiprocessing/popen_fork.py:66: RuntimeWarning:\n",
-      "\n",
-      "os.fork() was called. os.fork() is incompatible with multithreaded code, and JAX is multithreaded, so this will likely lead to a deadlock.\n",
-      "\n",
-      "| Iteration: 1 | Iter/s:  0.00 |\n",
-      "| Iteration: 2 | Iter/s:  13.90 |\n",
-      "| Iteration: 3 | Iter/s:  34.29 |\n",
-      "| Iteration: 4 | Iter/s:  35.65 |\n",
-      "| Iteration: 5 | Iter/s:  12.33 |\n",
-      "| Iteration: 6 | Iter/s:  52.30 |\n",
-      "| Iteration: 7 | Iter/s:  57.62 |\n",
-      "| Iteration: 8 | Iter/s:  61.78 |\n",
-      "| Iteration: 9 | Iter/s:  60.53 |\n",
-      "| Iteration: 10 | Iter/s:  43.81 |\n",
-      "| Iteration: 50 | Iter/s:  36.97 |\n",
-      "| Iteration: 100 | Iter/s:  64.95 |\n",
-      "| Iteration: 150 | Iter/s:  24.37 |\n",
-      "| Iteration: 200 | Iter/s:  24.10 |\n",
-      "| Iteration: 250 | Iter/s:  118.53 |\n",
-      "Initial phase completed.\n",
-      "| Iteration: 300 | Iter/s:  18.04 |\n",
-      "| Iteration: 350 | Iter/s:  33.45 |\n",
-      "| Iteration: 400 | Iter/s:  6.26 |\n",
-      "| Iteration: 450 | Iter/s:  11.71 |\n",
-      "| Iteration: 500 | Iter/s:  10.42 |\n",
-      "| Iteration: 550 | Iter/s:  13.09 |\n",
-      "| Iteration: 600 | Iter/s:  8.01 |\n",
-      "| Iteration: 650 | Iter/s:  8.72 |\n",
-      "| Iteration: 700 | Iter/s:  11.52 |\n",
-      "| Iteration: 750 | Iter/s:  9.72 |\n",
-      "| Iteration: 800 | Iter/s:  9.79 |\n",
-      "| Iteration: 850 | Iter/s:  10.70 |\n",
-      "| Iteration: 900 | Iter/s:  8.04 |\n",
-      "| Iteration: 950 | Iter/s:  6.94 |\n",
-      "| Iteration: 1000 | Iter/s:  9.31 |\n",
-      "| Iteration: 1050 | Iter/s:  12.79 |\n",
-      "| Iteration: 1100 | Iter/s:  7.40 |\n",
-      "| Iteration: 1150 | Iter/s:  11.16 |\n",
-      "| Iteration: 1200 | Iter/s:  10.76 |\n",
-      "| Iteration: 1250 | Iter/s:  23.48 |\n",
-      "| Iteration: 1300 | Iter/s:  14.77 |\n",
-      "| Iteration: 1350 | Iter/s:  25.48 |\n",
-      "| Iteration: 1400 | Iter/s:  9.10 |\n",
-      "| Iteration: 1450 | Iter/s:  14.50 |\n",
-      "| Iteration: 1500 | Iter/s:  10.89 |\n",
-      "Halting: Maximum number of iterations (1500) reached.\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "[1.0155273  1.01614157 1.01238518 1.0032307 ]\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "sampler = pybop.HaarioBardenetACMC(\n",
     "    posterior,\n",
     "    chains=3,\n",
     "    x0=results_optim.x,  # Initialise at the MAP estimate\n",
-    "    max_iterations=1500,  # Increase for accurate posteriors\n",
+    "    max_iterations=500,  # Increase for accurate posteriors\n",
     "    warm_up=350,\n",
     "    verbose=True,\n",
     "    parallel=parallel,  # Only supported for macOS/WSL/Linux\n",