PyBaMM

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

How do I use PyBaMM?

PyBaMM comes with a number of detailed examples, hosted here on github. In addition, there is a full API documentation, hosted on Read The Docs.

How can I install PyBaMM?

You'll need the following requirements:

• Python 2.7 or Python 3.4+
• Python libraries: numpy scipy pandas matplotlib

These can easily be installed using pip. To do this, first make sure you have the latest version of pip installed:

$ pip install --upgrade pip

Then navigate to the path where you downloaded PyBaMM to, and install both PyBaMM and its dependencies by typing:

$ pip install .

Or, if you want to install PyBaMM as a developer, use

$ pip install -e .[dev,docs]

To uninstall again, type

$ pip uninstall pybamm

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.

Licensing

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