Skip to main content

Python Battery Mathematical Modelling.

Project description


travis Build status readthedocs codecov Binder black_code_style

Python Battery Mathematical Modelling solves continuum models for batteries, using both numerical methods and asymptotic analysis.

How do I use PyBaMM?

The easiest way to use PyBaMM is to run a 1C constant-current discharge with a model of your choice with all the default settings:

import pybamm
model = pybamm.lithium_ion.DFN() # Doyle-Fuller-Newman model
sim = pybamm.Simulation(model)

However, much greater customisation is available. It is possible to change the physics, parameter values, geometry, submesh type, number of submesh points, methods for spatial discretisation and solver for integration (see DFN script or notebook).

For new users we recommend the Getting Started guides. These are intended to be very simple step-by-step guides to show the basic functionality of PyBaMM.

Further details can be found in a number of detailed examples, hosted here on github. In addition, there is a full API documentation, hosted on Read The Docs. A set of slides giving an overview of PyBaMM can be found here.

For further examples, see the list of repositories that use PyBaMM here

How can I obtain & install PyBaMM?


For instructions on installing PyBaMM on Debian-based distributions, please see here


We recommend using Windows Subsystem for Linux to install PyBaMM on a Windows OS, for instructions please see here

How can I contribute to PyBaMM?

If you'd like to help us develop PyBaMM by adding new methods, writing documentation, or fixing embarrassing bugs, please have a look at these guidelines first.


PyBaMM is fully open source. For more information about its license, see LICENSE.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pybamm, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pybamm-0.1.0-py3-none-any.whl (310.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pybamm-0.1.0.tar.gz (186.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page