Python Battery Mathematical Modelling (PyBaMM)

Published June 8, 2021 | Version 22.7

Software Open

Features

Moved general code about submodels to BaseModel instead of BaseBatteryModel, making it easier to build custom models from submodels. (#2169)
Events can now be plotted as a regular variable (under the name "Event: event_name", e.g. "Event: Minimum voltage [V]") (#2158)
Added example showing how to print whether a model is compatible with a parameter set (#2112)
Added SEI growth on cracks (#2104)
Added Arrhenius temperature dependence of SEI growth (#2104)
The "Inner SEI reaction proportion" parameter actually gets used now (#2104)
New OKane2022 parameter set replaces Chen2020_plating (#2104)
SEI growth, lithium plating and porosity change can now be set to distributed in SPMe. There is an additional option called x-average side reactions which allows to set this (note that for SPM it is always x-averaged). (#2099)

Optimizations

Improved eSOH calculations to be more robust (#2192,#2199)
The (2x2x2=8) particle diffusion submodels have been consolidated into just three submodels (Fickian diffusion, polynomial profile, and x-averaged polynomial profile) with optional x-averaging and size distribution. Polynomial profile and x-averaged polynomial profile are still two separate submodels, since they deal with surface concentration differently.
Added error for when solution vector gets too large, to help debug solver errors (#2138)

Bug fixes

Fixed error reporting for simulation with experiment (#2213)
Fixed a bug in Simulation that caused initial conditions to change when solving an experiment multiple times (#2204)
Fixed labels and ylims in plot_voltage_components(#2183)
Fixed 2D interpolant (#2180)
Fixes a bug where the SPMe always builds even when build=False (#2169)
Some events have been removed in the case where they are constant, i.e. can never be reached (#2158)
Raise explicit NotImplementedError if trying to call bool() on a pybamm Symbol (e.g. in an if statement condition) (#2141)
Fixed bug causing cut-off voltage to change after setting up a simulation with a model (#2138)
A single solution cycle can now be used as a starting solution for a simulation (#2138)

Breaking changes

Exchange-current density functions (and some other functions) now take an additional argument, the maximum particle concentration for that phase (#2134)
Loss of lithium to SEI on cracks is now a degradation variable, so setting a particle mechanics submodel is now compulsory (NoMechanics will suffice)

Notes

If you use PyBaMM, please cite it as below.

Name	Size	Download all
pybamm-team/PyBaMM-v22.7.zip md5:a6e9f7a65517c65ac2ee7858f4c8de78	13.0 MB	Preview Download