Getting Started

Table of Contents

Installation instructions

PyBaMM is available on pip:

pip install pybamm

More detailed instructions can be found here.

Getting Started notebooks

If you would like to get started with PyBaMM you can go through the Getting Started notebooks which introduce the basic features. Following the links below will launch the notebooks on Google Colab so you can run them on the cloud without having to install PyBaMM on your computer.

Supporting materials

We regularly hold PyBaMM workshops. Here you can find a list of the workshops we have held with links to the corresponding recordings and supporting material.

Video tutorials

Getting Started

This video explains what PyBaMM is and takes you through the basics of setting up and running simulations.

Plug & Play Physics

This video shows how submodels enable "plug and play" physics PyBaMM, and showcases submodels for lithium plating and multi-particle models (particle size distributions).


This video shows different features related to parameterisation, including how to add new parameter sets, optimise the parameter values and calculate the sensitivity of the solutions with respect to certain parameters.


This video shows how to simulate experiments in PyBaMM and interact with their solutions.

Advanced Examples

This video showcases some advanced examples using PyBaMM.

Open-source battery modelling

This presentation was given during the Early Career Researcher day of the Faraday Institution Conference 2020 ( We give an overview of PyBaMM, and showcase some of the research it has enabled.