API documentation

Release:

26.10.1.1.dev37+gd575513dc

Date:

Oct 27, 2026

This reference manual details the classes, functions, modules, and objects included in PyBaMM, describing what they are and what they do. For a high-level introduction to PyBaMM, see the user guide and the examples.

• Expression Tree
  • Symbol
  • Tree utilities
  • Parameter
  • Variable
  • Independent Variable
  • Scalar
  • Array
  • Matrix
  • Vector
  • State Vector
  • Vector Field
  • Binary Operators
  • Unary Operators
  • Concatenations
  • Broadcasting Operators
  • Functions
  • Input Parameter
  • Interpolant
  • Operations on expression trees
• Models
  • Base Models
  • Lithium-ion Models
  • Lead Acid Models
  • Equivalent Circuit Models
  • Submodels
• Parameters
  • Parameter Values
  • Parameter Store
  • Parameter Substitutor
  • Geometric Parameters
  • Electrical Parameters
  • Thermal Parameters
  • Lithium-ion Parameters
  • Lead-Acid Parameters
  • Parameters Sets
  • Process Parameter Data
• Geometry
  • Geometry
  • Battery Geometry
• Meshes
  • Meshes
  • 0D Sub Mesh
  • 1D Sub Meshes
  • 2D Sub Meshes
  • 3D Sub Meshes
  • Unstructured Sub Meshes
• Discretisation and spatial methods
  • Discretisation
  • Spatial Method
  • Finite Volume
  • Spectral Volume
  • Scikit Finite Elements
  • Zero Dimensional Spatial Method
  • Scikit Finite Elements 3D
  • Unstructured Finite Volume
• Solvers
  • Base Solver
  • Dummy Solver
  • Scipy Solver
  • JAX Solver
  • IDAKLU Solver
  • IDAKLU-JAX Interface
  • Casadi Solver
  • Algebraic Solvers
  • Solutions
  • Post-Process Variables
  • Summary Variables
• Code generation
  • AOT compilation
• Experiments
  • Base Experiment Class
  • Experiment step functions
• Simulation
  • Base Simulation
  • Simulation
  • EIS Simulation
• Plotting
  • Quick Plot
  • Plot
  • Plot 2D
  • Plot Voltage Components
  • Plot Summary Variables
  • Plot Cross Section
  • Plot 3D Heatmap
  • VTK Quick Plot
  • Unstructured plot sampling
• Utility functions
  • root_dir()
  • Timer
  • TimerTime
  • FuzzyDict
  • load()
  • has_jax()
  • set_logging_level()
• Callbacks
  • Callback
  • CallbackList
  • LoggingCallback
  • setup_callbacks()
• Citations
  • Citations
  • print_citations()
• Batch Study
  • BatchStudy
• PyBaMM Data
  • DataLoader