Summary Variables#

class pybamm.SummaryVariables(solution: Solution, cycle_summary_variables: list[SummaryVariables] | None = None, esoh_solver: ElectrodeSOHSolver | None = None, user_inputs: dict[str, Any] | None = None)[source]#

Class for managing and calculating summary variables from a PyBaMM solution. Summary variables are only calculated when simulations are run with PyBaMM Experiments.

Parameters:
cycle_number#

Stores the cycle number for each saved cycle, for use when plotting. Length is equal to the number of cycles in a solution.

Type:

array[int]

property all_variables: list[str]#

Return names of all possible summary variables, including eSOH variables if appropriate.

property esoh_variables: list[str] | None#

Return names of all eSOH variables.

update(var: str)[source]#

Compute and store a variable and its change.

update_esoh()[source]#

Create all aggregated eSOH variables