Welcome to PyBaMM’s documentation!

Python Battery Mathematical Modelling (PyBAMM) solves continuum models for batteries, using both numerical methods and asymptotic analysis.

PyBaMM is hosted on GitHub. This page provides the API, or developer documentation for pybamm.


Detailed examples can be viewed on the GitHub examples page, and run locally using jupyter notebook, or online through Binder.


There are many ways to contribute to PyBaMM:

Before contributing, please read the Contribution Guidelines.