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.

• Index

• Module Index

• Search Page

Quickstart

PyBaMM is available on GNU/Linux, MacOS and Windows.

Using pip

GNU/Linux and Windows

pip install pybamm

macOS

brew install sundials && 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:

• scikits.odes -based solver, see Optional - scikits.odes solver.

• jax -based solver, see Optional - JaxSolver.

Installation

• GNU-Linux & MacOS
• Windows
• Windows Subsystem for Linux (WSL)
• Install from source (developer install)

API documentation

• Expression Tree
  • Symbol
  • Parameter
  • Variable
  • Independent Variable
  • Scalar
  • Array
  • Matrix
  • Vector
  • State Vector
  • Binary Operators
  • Unary Operators
  • Concatenations
  • Broadcasting Operators
  • Functions
  • Input Parameter
  • Interpolant
  • Operations on expression trees
• Models
  • Base Models
  • Lithium-ion Models
  • Lead Acid Models
  • Submodels
• Parameters
  • Parameter Values
  • Geometric Parameters
  • Electrical Parameters
  • Thermal Parameters
  • Lithium-ion Parameters
  • Lead-Acid Parameters
  • Parameters Sets
• Geometry
  • Geometry
  • Battery Geometry
• Meshes
  • Meshes
  • 0D Sub Mesh
  • 1D Sub Meshes
  • 2D Sub Meshes
• Discretisation and spatial methods
  • Discretisation
  • Spatial Method
  • Finite Volume
  • Spectral Volume
  • Scikit Finite Elements
  • Zero Dimensional Spatial Method
• Solvers
  • Base Solver
  • Dummy Solver
  • Scipy Solver
  • JAX Solver
  • Scikits.odes Solvers
  • Casadi Solver
  • Algebraic Solvers
  • Solutions
  • Post-Process Variables
• Experiments
  • Base Experiment Class
• Simulation
• Plotting
  • Quick Plot
  • Dynamic Plot
  • Plot
  • Plot 2D
  • Plot Voltage Components
  • Plot Summary Variables
• Utility functions
• Citations
• Parameters command line interface
• Batch Study

Examples

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

Contributing

There are many ways to contribute to PyBaMM:

• Adding Parameter Values
• Adding a Model
• Adding a Spatial Method
• Adding a Solver

Before contributing, please read the Contribution Guidelines.