Supporting material for the review paper
F. Brosa Planella, W. Ai, A.M. Boyce, A. Ghosh, I. Korotkin, S. Sahu, V. Sulzer, R. Timms, T.G. Tranter, M. Zyskin, S.J. Cooper, J.S. Edge, J.M. Foster, M. Marinescu, B. Wu, G. Richardson, A continuum of physics-based lithium-ion battery models reviewed, Progress in Energy. 4 (2022) 042003.
This repository contains various Jupyter notebooks to run some of the models presented in the review.
- compare_models.ipynb: compare DFN, SPMe and SPM, and generate Figures 8 and 9 of the paper.
- compare_parameters.ipynb: study the effect of parameter values by comparing Ecker 2015 and Chen 2020.
- compare_SPMe.ipynb: compare the outputs of the two formulations of SPMe (Marquis et al. 2019 and Richardson et al. 2020) with the DFN model.
- exploring_dimensionality.ipynb: compare the effects of dimensionality for thermal models.
- overpotentials.ipynb: plot the overpotentials for the various models.
- particle_plot.ipynb: plot the lithium concentration in the particles.
To run the notebooks you first will have to install PyBaMM (see instructions below) and then launch the notebooks. You can do this locally by running the command
jupyter notebook
from your local repository, or online using Google Colab.
The folder COMSOL_models contains the COMSOL files to run a 2D example of the microscale model. More details can be found in the README of the folder.
To run these notebooks you need to install PyBaMM. Here you can find the instructions for Linux & MacOS and for Windows.