PyBaMM user guide#

This guide is an overview and explains the important features; details are found in API documentation.

Getting started

Fundamentals and usage

Example notebooks#

PyBaMM ships with example notebooks that demonstrate how to use it and reveal some of its functionalities and its inner workings. For more examples, see the Examples section.

Getting Started

Tutorial 1 - How to run a model
Tutorial 2 - Compare models
Tutorial 3 - Basic plotting
Tutorial 4 - Setting parameter values
Tutorial 5 - Run experiments
Tutorial 6 - Managing simulation outputs
Tutorial 7 - Model options
Tutorial 8 - Solver options
Tutorial 9 - Changing the mesh
Tutorial 10 - Creating a model
Tutorial 11 - Creating a submodel

Creating Models

Creating a simple ODE model
Creating a simple PDE model
A step towards the Single Particle Model
Comparing full and reduced-order models
A half cell model
Creating a Simple Model for SEI Growth