Skip to content

suhaklee/PyBaMM

 
 

Repository files navigation

PyBaMM

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?

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. A set of slides giving an overview of PyBaMM can be found here.

How can I obtain & install PyBaMM?

Linux

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

Windows

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.

Licensing

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

Packages

No packages published

Languages

  • Python 96.4%
  • CMake 2.9%
  • Other 0.7%