Merge branch 'develop' into develop

Author: kratman

.github/workflows/run_periodic_tests.yml

@@ -30,7 +30,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-13, macos-14, windows-latest ]
+        os: [ ubuntu-latest, macos-13, macos-latest, windows-latest ]
         python-version: ["3.10", "3.11", "3.12"]
     name: Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
 
@@ -48,7 +48,7 @@ jobs:
           sudo apt-get install libopenblas-dev texlive-latex-extra dvipng
 
       - name: Install macOS system dependencies
-        if: matrix.os == 'macos-13' || matrix.os == 'macos-14'
+        if: matrix.os == 'macos-13' || matrix.os == 'macos-latest'
         env:
           HOMEBREW_NO_INSTALL_CLEANUP: 1
           HOMEBREW_NO_AUTO_UPDATE: 1

.github/workflows/scorecard.yml

@@ -65,6 +65,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@ce28f5bb42b7a9f2c824e633a3f6ee835bab6858 # v3.29.0
+        uses: github/codeql-action/upload-sarif@181d5eefc20863364f96762470ba6f862bdef56b # v3.29.2
         with:
           sarif_file: results.sarif

.github/workflows/test_on_push.yml

@@ -48,7 +48,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-13, macos-14, windows-latest]
+        os: [ubuntu-latest, macos-13, macos-latest, windows-latest]
         python-version: ["3.10", "3.11", "3.12"]
     name: Tests (${{ matrix.os }} / Python ${{ matrix.python-version }})
 
@@ -74,7 +74,7 @@ jobs:
           sudo apt-get install libopenblas-dev texlive-latex-extra dvipng
 
       - name: Install macOS system dependencies
-        if: matrix.os == 'macos-13' || matrix.os == 'macos-14'
+        if: matrix.os == 'macos-13' || matrix.os == 'macos-latest'
         env:
           HOMEBREW_NO_INSTALL_CLEANUP: 1
           HOMEBREW_NO_AUTO_UPDATE: 1

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ ci:
 
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.12.0"
+    rev: "v0.12.1"
     hooks:
       - id: ruff
         args: [--fix, --show-fixes]
@@ -44,7 +44,6 @@ repos:
         - id: sp-repo-review
 
   - repo: https://github.com/woodruffw/zizmor-pre-commit
-    rev: v1.9.0
+    rev: v1.11.0
     hooks:
       - id: zizmor
-        args: [--pedantic]

CHANGELOG.md

@@ -2,12 +2,15 @@
 
 ## Features
 
+- Creates `BaseProcessedVariable` to enable object combination when adding solutions together ([#5076](https://github.com/pybamm-team/PyBaMM/pull/5076))
 - Added a `Constant` symbol for named constants. This is a subclass of `Scalar` and is used to represent named constants such as the gas constant. This avoids constants being simplified out when constructing expressions. ([#5070](https://github.com/pybamm-team/PyBaMM/pull/5070))
 - Generalise `pybamm.DiscreteTimeSum` to allow it to be embedded in other expressions ([#5044](https://github.com/pybamm-team/PyBaMM/pull/5044))
 - Adds `all` key-value pair to `output_variables` sensitivity dictionaries, accessible through `solution[var].sensitivities['all']`. Aligns shape with conventional solution sensitivities object. ([#5067](https://github.com/pybamm-team/PyBaMM/pull/5067))
+- Add support for `output_variables` to `pybamm.DiscreteTimeSum` and `pybamm.ExplicitTimeIntegral` expressions. ([#5071](https://github.com/pybamm-team/PyBaMM/pull/5071))
 
 ## Bug fixes
 
+- Fixed a bug that ignored the default duration of drive cycles for `CRate` steps and a bug that overwrote custom `period` arguments for drive cycles. ([#5090](https://github.com/pybamm-team/PyBaMM/pull/5090))
 - Converts sensitivities to numpy objects, fixing bug in `DiscreteTimeSum` sensitivity calculation ([#5037](https://github.com/pybamm-team/PyBaMM/pull/5037))
 - Raises error if `pybamm.Interpolant` given 1D x values that are not strictly increasing ([#5061](https://github.com/pybamm-team/PyBaMM/pull/5061))
 - Removes the discontinuity caused by a Heaviside (which is a function of time) when a solver is called with a non-zero initial time ([#5075](https://github.com/pybamm-team/PyBaMM/pull/5075)).

src/pybamm/experiment/step/base_step.py

@@ -147,7 +147,12 @@ def __init__(
                 pybamm.t - pybamm.InputParameter("start time"),
                 name="Drive Cycle",
             )
-            self.period = np.diff(t).min()
+            if period is None:
+                # Infer the period from the drive cycle
+                self.period = np.diff(t).min()
+            else:
+                self.period = _convert_time_to_seconds(period)
+
         elif is_python_function:
             t = pybamm.t - pybamm.InputParameter("start time")
             self.value = value(t)
@@ -272,6 +277,12 @@ def __eq__(self, other):
     def __hash__(self):
         return hash(self.basic_repr())
 
+    def _default_timespan(self, value):
+        """
+        Default timespan for the step is one day (24 hours).
+        """
+        return 24 * 3600
+
     def default_duration(self, value):
         """
         Default duration for the step is one day (24 hours) or the duration of the
@@ -281,7 +292,7 @@ def default_duration(self, value):
             t = value[:, 0]
             return t[-1]
         else:
-            return 24 * 3600  # one day in seconds
+            return self._default_timespan(value)
 
     @staticmethod
     def default_period():

src/pybamm/experiment/step/steps.py

@@ -157,7 +157,7 @@ def __init__(self, value, **kwargs):
     def current_value(self, variables):
         return self.value * pybamm.Parameter("Nominal cell capacity [A.h]")
 
-    def default_duration(self, value):
+    def _default_timespan(self, value):
         # "value" is C-rate, so duration is "1 / value" hours in seconds
         # with a 2x safety factor
         return 1 / abs(value) * 3600 * 2

src/pybamm/expression_tree/unary_operators.py

@@ -1093,6 +1093,10 @@ def _from_json(cls, snippet: dict):
     def _unary_new_copy(self, child, perform_simplifications=True):
         return self.__class__(child, self.initial_condition)
 
+    def _unary_evaluate(self, child):
+        # return result of evaluating the child, we'll only implement the sum once the model is solved (in pybamm.ProcessedVariable)
+        return child
+
     def is_constant(self):
         return False
 

src/pybamm/solvers/base_processed_variable.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+import abc
+
+import pybamm
+
+
+class BaseProcessedVariable(abc.ABC):
+    """
+    Shared API for both 'on-demand' and 'computed' processed variables.
+    """
+
+    @abc.abstractmethod
+    def __call__(self, **coords): ...
+
+    @abc.abstractmethod
+    def as_computed(self) -> pybamm.ProcessedVariableComputed: ...
+
+    def update(
+        self,
+        other: BaseProcessedVariable,
+        new_sol: pybamm.Solution,
+    ) -> pybamm.ProcessedVariableComputed:
+        """
+        Return a *new* CPV that is `self` followed by `other`.
+        Works no matter which concrete types we start with.
+        """
+        return self.as_computed()._concat(other.as_computed(), new_sol)

src/pybamm/solvers/base_solver.py

@@ -260,11 +260,22 @@ def set_up(self, model, inputs=None, t_eval=None, ics_only=False):
         self.computed_var_fcns = {}
         self.computed_dvar_dy_fcns = {}
         self.computed_dvar_dp_fcns = {}
+        self._time_integral_vars = {}
         for key in self.output_variables:
-            # ExplicitTimeIntegral's are not computed as part of the solver and
-            # do not need to be converted
-            if isinstance(model.variables_and_events[key], pybamm.ExplicitTimeIntegral):
-                continue
+            # Check for any ExplicitTimeIntegral or DiscreteTimeSum variables
+            processed_time_integral = (
+                pybamm.ProcessedVariableTimeIntegral.from_pybamm_var(
+                    model.variables_and_events[key],
+                    model.len_rhs_and_alg,
+                )
+            )
+            # We will evaluate the sum node in the solver and sum it afterwards
+            if processed_time_integral is None:
+                var = model.variables_and_events[key]
+            else:
+                var = processed_time_integral.sum_node
+                self._time_integral_vars[key] = processed_time_integral
+
             # Generate Casadi function to calculate variable and derivates
             # to enable sensitivites to be computed within the solver
             (
@@ -273,7 +284,7 @@ def set_up(self, model, inputs=None, t_eval=None, ics_only=False):
                 self.computed_dvar_dp_fcns[key],
                 _,
             ) = process(
-                model.variables_and_events[key],
+                var,
                 BaseSolver._wrangle_name(key),
                 vars_for_processing,
                 use_jacobian=True,
@@ -1470,7 +1481,7 @@ def _check_empty_model(self, model):
 
     def get_platform_context(self, system_type: str):
         # Set context for parallel processing depending on the platform
-        if system_type.lower() in ["linux", "darwin"]:
+        if system_type.lower() in ["linux"]:
             return "fork"
         return "spawn"