AEPyBaMM

AEPyBaMM (aepybamm) is a Python library that supports the use of About:Energy's Electrochemical models (such as About:DFN) in the PyBaMM implementation.

AEPyBaMM is an interface between the PyBaMM package for battery modelling and the BPX package for expression of electrochemical parameter sets. AEPyBaMM v0.2.3 requires PyBaMM v26.7+ (last supported version PyBaMM v26.7.1) and BPX v1.1.1.

The core functionality of AEPyBaMM is expressed through the function get_params, which combines a BPX parameter set and any user-defined options to yield a tuple of self-consistent pybamm.ParameterValues and pybamm.lithium_ion.{model} objects.

Example use case:

import pybamm
from aepybamm import get_params

fp_bpx = "*.json" # filepath of BPX JSON file containing parameter set

parameter_values, model = get_params(
    fp_bpx,
    **kwargs, # additional options to get_params()
)

sim = pybamm.Simulation(
    model,
    parameter_values=parameter_values,
    **kwargs, # additional options to pybamm.Simulation
)

# The pybamm.Simulation 'sim' can now be solved and post-processed as desired.

AEPyBaMM additionally provides functions solve_from_expdata and compare, to aid simple solution and comparison operations on experimental data without using the PyBaMM API directly.