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

Contents

• Expression Tree
  • Symbol
  • Parameter
  • Variable
  • Independent Variable
  • Scalar
  • 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
  • Base Parameter Values
  • Geometric Parameters
  • Electrical Parameters
  • Thermal Parameters
  • Standard Lithium-ion Parameters
  • Standard Lead-Acid Parameters
  • Print parameters
  • Parameters Sets
• Geometry
  • Geometry
• Meshes
  • Meshes
  • 0D Sub Mesh
  • 1D Sub Meshes
  • 2D Sub Meshes
• Discretisation and spatial methods
  • Discretisation
  • Spatial Method
  • Finite Volume
  • Scikit Finite Elements
  • Zero Dimensional Spatial Method
• Solvers
  • Algebraic Solvers
  • Base Solvers
  • Scipy Solver
  • Scikits.odes Solvers
  • Casadi Solver
  • Solution
• Experiments
  • Base Experiment Class
• Post-Process Variables
• Utility functions
• Simulation
• Citations
• Parameters command line interface

Examples

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

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.