kvnoct / PyBaMM Public

forked from pybamm-team/PyBaMM

Notifications You must be signed in to change notification settings
Fork 0
Star 0

Fast and flexible physics-based battery models in Python

www.pybamm.org/

BSD-3-Clause license

0 stars 565 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 3,625 Commits
.github		.github
docs		docs
examples		examples
input		input
pybamm		pybamm
results		results
scripts		scripts
tests		tests
.appveyor.yml		.appveyor.yml
.bettercodehub.yml		.bettercodehub.yml
.clang-format		.clang-format
.coveragerc		.coveragerc
.flake8		.flake8
.gitignore		.gitignore
.gitmodules		.gitmodules
.requirements-docs.txt		.requirements-docs.txt
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
CMakeLists.txt		CMakeLists.txt
CONTRIBUTING.md		CONTRIBUTING.md
FindSuiteSparse.cmake		FindSuiteSparse.cmake
INSTALL-LINUX.md		INSTALL-LINUX.md
INSTALL-WINDOWS.md		INSTALL-WINDOWS.md
LICENSE.txt		LICENSE.txt
README.md		README.md
postBuild		postBuild
run-tests.py		run-tests.py
setup.py		setup.py

Repository files navigation

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. 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.