Merge pull request #493 from pybop-team/main

Main -> develop

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Features
 
+## Bug Fixes
+
+## Breaking Changes
+
+# [v24.9.0](https://github.com/pybop-team/PyBOP/tree/v24.9.0) - 2024-09-10
+
+## Features
+
 - [#462](https://github.com/pybop-team/PyBOP/pull/462) - Enables multidimensional learning rate for `pybop.AdamW` with updated (more robust) integration testing. Fixes bug in `Minkowski` and `SumofPower` cost functions for gradient-based optimisers.
 - [#411](https://github.com/pybop-team/PyBOP/pull/411) - Updates notebooks with README in `examples/` directory, removes kaleido dependency and moves to nbviewer rendering, displays notebook figures with `notebook_connected` plotly renderer
 - [#6](https://github.com/pybop-team/PyBOP/issues/6) - Adds Monte Carlo functionality, with methods based on Pints' algorithms. A base class is added `BaseSampler`, in addition to `PintsBaseSampler`.

CITATION.cff

@@ -11,5 +11,5 @@ authors:
     family-names: Courtier
   - given-names: David
     family-names: Howey
-version: "24.6.1" # Update this when you release a new version
+version: "24.9.0" # Update this when you release a new version
 repository-code: 'https://www.github.com/pybop-team/pybop'

docs/_static/switcher.json

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

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pybop"
-version = "24.6.1"
+version = "24.9.0"
 authors = [
   {name = "The PyBOP Team"},
 ]

tests/integration/test_spm_parameterisations.py

@@ -216,7 +216,7 @@ def test_multiple_signals(self, multi_optimiser, spm_two_signal_cost):
             "absolute_tolerance": 1e-6,
             "max_unchanged_iterations": 55,
             "sigma0": [0.035, 0.035, 6e-3, 6e-3]
-            if spm_two_signal_cost is pybop.GaussianLogLikelihood
+            if isinstance(spm_two_signal_cost, pybop.GaussianLogLikelihood)
             else None,
         }
 

tests/integration/test_transformation.py

@@ -48,7 +48,7 @@ def parameters(self):
             ),
         )
 
-    @pytest.fixture(params=[0.4, 0.7])
+    @pytest.fixture(params=[0.5])
     def init_soc(self, request):
         return request.param
 
@@ -80,14 +80,14 @@ def cost(self, model, parameters, init_soc):
         ],
     )
     @pytest.mark.integration
-    def test_spm_optimisers(self, optimiser, cost):
+    def test_spm_transformation(self, optimiser, cost):
         x0 = cost.parameters.initial_value()
-        sigma0 = None if optimiser is pybop.AdamW else 0.2
         optim = optimiser(
             cost=cost,
-            sigma0=sigma0,
+            sigma0=0.1,
             max_unchanged_iterations=35,
-            max_iterations=150,
+            absolute_tolerance=1e-6,
+            max_iterations=250,
         )
 
         initial_cost = optim.cost(x0)
@@ -105,8 +105,8 @@ def get_data(self, model, init_soc):
         experiment = pybop.Experiment(
             [
                 (
-                    "Discharge at 1C for 3 minutes (4 second period)",
-                    "Charge at 1C for 3 minutes (4 second period)",
+                    "Discharge at 1C for 3 minutes (5 second period)",
+                    "Charge at 1C for 3 minutes (5 second period)",
                 ),
             ]
         )