Python Battery Mathematical Modelling

# PyBaMM

PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package written in Python. Our mission is to accelerate battery modelling research by providing open-source tools for multi-institutional, interdisciplinary collaboration. Broadly, PyBaMM consists of (i) a framework for writing and solving systems of differential equations, (ii) a library of battery models and parameters, and (iii) specialized tools for simulating battery-specific experiments and visualizing the results. Together, these enable flexible model definitions and fast battery simulations, allowing users to explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.

PyBaMM uses an open governance model and is fiscally sponsored by NumFOCUS. Consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.

## ๐ป Using PyBaMM

The easiest way to use PyBaMM is to run a 1C constant-current discharge with a model of your choice with all the default settings:

import pybamm

model = pybamm.lithium_ion.DFN()  # Doyle-Fuller-Newman model
sim = pybamm.Simulation(model)
sim.solve([0, 3600])  # solve for 1 hour
sim.plot()

or simulate an experiment such as a constant-current discharge followed by a constant-current-constant-voltage charge:

import pybamm

experiment = pybamm.Experiment(
[
(
"Discharge at C/10 for 10 hours or until 3.3 V",
"Rest for 1 hour",
"Charge at 1 A until 4.1 V",
"Hold at 4.1 V until 50 mA",
"Rest for 1 hour",
)
]
* 3,
)
model = pybamm.lithium_ion.DFN()
sim.solve()
sim.plot()

However, much greater customisation is available. It is possible to change the physics, parameter values, geometry, submesh type, number of submesh points, methods for spatial discretisation and solver for integration (see DFN script or notebook).

For new users we recommend the Getting Started guides. These are intended to be very simple step-by-step guides to show the basic functionality of PyBaMM, and can either be downloaded and used locally, or used online through Google Colab.

Further details can be found in a number of detailed examples, hosted here on github. In addition, there is a full API documentation, hosted on Read The Docs. Additional supporting material can be found here.

Note that the examples on the default develop branch are tested on the latest develop commit. This may sometimes cause errors when running the examples on the pybamm pip package, which is synced to the main branch. You can switch to the main branch on github to see the version of the examples that is compatible with the latest pip release.

## Versioning

PyBaMM makes releases every four months and we use CalVer, which means that the version number is YY.MM. The releases happen, approximately, at the end of January, May and September. There is no difference between releases that increment the year and releases that increment the month; in particular, releases that increment the month may introduce breaking changes. Breaking changes for each release are communicated via the CHANGELOG, and come with deprecation warnings or errors that are kept for at least one year (3 releases). If you find a breaking change that is not documented, or think it should be undone, please open an issue on GitHub.

## ๐ Installing PyBaMM

PyBaMM is available on GNU/Linux, MacOS and Windows. We strongly recommend to install PyBaMM within a python virtual environment, in order not to alter any distribution python files. For instructions on how to create a virtual environment for PyBaMM, see the documentation.

### Using pip

pip install pybamm

### Using conda

PyBaMM is available as a conda package through the conda-forge channel.

conda install -c conda-forge pybamm

### Optional solvers

Following GNU/Linux and macOS solvers are optionally available:

## ๐ Citing PyBaMM

Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2021). Python Battery Mathematical Modelling (PyBaMM). Journal of Open Research Software, 9(1).

You can use the BibTeX

@article{Sulzer2021,
title = {{Python Battery Mathematical Modelling (PyBaMM)}},
author = {Sulzer, Valentin and Marquis, Scott G. and Timms, Robert and Robinson, Martin and Chapman, S. Jon},
doi = {10.5334/jors.309},
journal = {Journal of Open Research Software},
publisher = {Software Sustainability Institute},
volume = {9},
number = {1},
pages = {14},
year = {2021}
}

We would be grateful if you could also cite the relevant papers. These will change depending on what models and solvers you use. To find out which papers you should cite, add the line

pybamm.print_citations()

to the end of your script. This will print BibTeX information to the terminal; passing a filename to print_citations will print the BibTeX information to the specified file instead. A list of all citations can also be found in the citations file. In particular, PyBaMM relies heavily on CasADi. See CONTRIBUTING.md for information on how to add your own citations when you contribute.

## ๐ ๏ธ Contributing to PyBaMM

If you'd like to help us develop PyBaMM by adding new methods, writing documentation, or fixing embarrassing bugs, please have a look at these guidelines first.

## ๐ซ Get in touch

For any questions, comments, suggestions or bug reports, please see the contact page.

## โจ Contributors

Thanks goes to these wonderful people (emoji key):

 Valentin Sulzer๐ ๐ป ๐ ๐ก ๐ค ๐ง ๐ โ ๏ธ โ ๐ Robert Timms๐ ๐ป ๐ ๐ก ๐ค ๐ง ๐ โ ๏ธ โ Scott Marquis๐ ๐ป ๐ ๐ก ๐ค ๐ง ๐ โ ๏ธ โ Martin Robinson๐ ๐ป ๐ ๐ก ๐ค ๐ โ ๏ธ โ Ferran Brosa Planella๐ ๐ ๐ป ๐ ๐ก ๐ค ๐ง โ ๏ธ โ ๐ Tom Tranter๐ ๐ป ๐ ๐ก ๐ค ๐ โ ๏ธ โ Thibault Lestang๐ ๐ป ๐ ๐ก ๐ค ๐ โ ๏ธ ๐ Diego๐ ๐ ๐ป ๐ felipe-salinas๐ป โ ๏ธ suhaklee๐ป โ ๏ธ viviantran27๐ป โ ๏ธ gyouhoc๐ ๐ป โ ๏ธ Yannick Kuhn๐ป โ ๏ธ Jacqueline Edge๐ค ๐ ๐ Fergus Cooper๐ป โ ๏ธ jonchapman1๐ค ๐ Colin Please๐ค ๐ cwmonroe๐ค ๐ Greg๐ค ๐ Faraday Institution๐ต Alexander Bessman๐ ๐ก dalbamont๐ป Anand Mohan Yadav๐ WEILONG AI๐ป ๐ก โ ๏ธ lonnbornj๐ป โ ๏ธ ๐ก Priyanshu Agarwalโ ๏ธ ๐ป ๐ ๐ ๐ง โ DrSOKane๐ป ๐ก ๐ โ ๏ธ โ ๐ Saransh Chopra๐ป โ ๏ธ ๐ โ ๐ ๐ง David Straub๐ ๐ป maurosgroi๐ค Amarjit Singh Gaba๐ป KennethNwanoro๐ป โ ๏ธ Ali Hussain Umar Bhatti๐ป โ ๏ธ Leshinka Molel๐ป ๐ค tobykirk๐ค ๐ป โ ๏ธ โ Chuck Liu๐ ๐ป partben๐ Gavin Wiggins๐ ๐ป Dion Wilde๐ ๐ป Elias Hohl๐ป KAschad๐ Vaibhav-Chopra-GT๐ป bardsleypt๐ ๐ป ndrewwang๐ ๐ป MichaPhilipp๐ Alec Bills๐ป Agriya Khetarpal๐ ๐ป ๐ ๐ Alex Wadell๐ป โ ๏ธ ๐ iatzak๐ ๐ ๐ป Ankit Kumar๐ป Aniket Singh Rawat๐ป ๐ Jerom Palimattom Tom๐ ๐ป โ ๏ธ Brady Planden๐ก jsbrittain๐ป โ ๏ธ Arjun๐ ๐ป ๐ ๐ CHEN ZHAO๐ darryl-ad๐ป ๐ ๐ค julian-evers๐ป Jason Siegel๐ป ๐ค Tom Maull๐ป โ ๏ธ ejfdickinson๐ค ๐ bobonice๐ ๐ป Eric G. Kratz๐ ๐ ๐ ๐ป โ ๏ธ Andrรฉs Ignacio Torres๐ Agnik Bakshi๐ RuiheLi๐ป โ ๏ธ chmabaur๐ ๐ป Abhishek Chaudhari๐ ๐ป Shubham Bhardwaj๐ Jonathan Lauber๐ Pradyot Ranjan๐ XuboGU๐ป ๐ Ankit Meda๐ป

This project follows the all-contributors specification. Contributions of any kind welcome!

## Project details

### Source Distribution

pybamm-24.1.tar.gz (6.8 MB view hashes)

### Built Distributions

pybamm-24.1-cp312-cp312-win_amd64.whl (8.4 MB view hashes)

pybamm-24.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (22.6 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

pybamm-24.1-cp312-cp312-macosx_10_9_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

pybamm-24.1-cp311-cp311-win_amd64.whl (8.4 MB view hashes)

pybamm-24.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (22.6 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

pybamm-24.1-cp311-cp311-macosx_10_9_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

pybamm-24.1-cp310-cp310-win_amd64.whl (8.4 MB view hashes)

pybamm-24.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (22.6 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

pybamm-24.1-cp310-cp310-macosx_10_9_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

pybamm-24.1-cp39-cp39-win_amd64.whl (8.4 MB view hashes)

pybamm-24.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (22.6 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

pybamm-24.1-cp39-cp39-macosx_10_9_x86_64.whl (12.9 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

pybamm-24.1-cp38-cp38-win_amd64.whl (8.4 MB view hashes)