Skip to content

pybamm-team/PyBaMM

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
March 8, 2023 00:19
February 7, 2023 01:19
September 19, 2022 19:23
casadi-headers
November 23, 2022 13:20
March 12, 2023 22:00
March 21, 2023 11:24
March 8, 2023 12:31
October 26, 2022 22:27
February 28, 2023 10:12
September 19, 2022 19:23
December 13, 2022 23:55
February 18, 2023 14:22
February 18, 2023 14:04
February 18, 2023 18:53
September 19, 2022 19:23
February 28, 2023 10:12

PyBaMM_logo

Powered by NumFOCUS Build readthedocs codecov Open In Colab DOI release black code style

All Contributors

PyBaMM

PyBaMM (Python Battery Mathematical Modelling) is an open-source battery simulation package written in Python. Our mission is to accelerate battery modelling research by providing open-source tools for multi-institutional, interdisciplinary collaboration. Broadly, PyBaMM consists of (i) a framework for writing and solving systems of differential equations, (ii) a library of battery models and parameters, and (iii) specialized tools for simulating battery-specific experiments and visualizing the results. Together, these enable flexible model definitions and fast battery simulations, allowing users to explore the effect of different battery designs and modeling assumptions under a variety of operating scenarios.

PyBaMM uses an open governance model and is fiscally sponsored by NumFOCUS. Consider making a tax-deductible donation to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs.


💻 Using 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)
sim.solve([0, 3600])  # solve for 1 hour
sim.plot()

or simulate an experiment such as a constant-current discharge followed by a constant-current-constant-voltage charge:

import pybamm
experiment = pybamm.Experiment(
    [
        ("Discharge at C/10 for 10 hours or until 3.3 V",
        "Rest for 1 hour",
        "Charge at 1 A until 4.1 V",
        "Hold at 4.1 V until 50 mA",
        "Rest for 1 hour")
    ]
    * 3,
)
model = pybamm.lithium_ion.DFN()
sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
sim.solve()
sim.plot()

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, and can either be downloaded and used locally, or used online through Google Colab.

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. Additional supporting material can be found here.

Note that the examples on the default develop branch are tested on the latest develop commit. This may sometimes cause errors when running the examples on the pybamm pip package, which is synced to the main branch. You can switch to the main branch on github to see the version of the examples that is compatible with the latest pip release.

Versioning

PyBaMM uses CalVer, which means that we make new releases every month with the version number YY.MM. There is no difference between releases that increment the year and releases that increment the month; in particular, releases that increment the month may introduce breaking changes. Breaking changes for each release are communicated via the CHANGELOG, and come with deprecation warnings or errors that are kept for at least one year (12 releases). If you find a breaking change that is not documented, or think it should be undone, please open an issue on GitHub.

🚀 Installing PyBaMM

PyBaMM is available on GNU/Linux, MacOS and Windows. We strongly recommend to install PyBaMM within a python virtual environment, in order not to alter any distribution python files. For instructions on how to create a virtual environment for PyBaMM, see the documentation.

Using pip

pypi downloads

pip install pybamm

Using conda

PyBaMM is available as a conda package through the conda-forge channel.

conda_forge downloads

conda install -c conda-forge pybamm

Optional solvers

Following GNU/Linux and macOS solvers are optionally available:

📖 Citing PyBaMM

If you use PyBaMM in your work, please cite our paper

Sulzer, V., Marquis, S. G., Timms, R., Robinson, M., & Chapman, S. J. (2021). Python Battery Mathematical Modelling (PyBaMM). Journal of Open Research Software, 9(1).

You can use the BibTeX

@article{Sulzer2021,
  title = {{Python Battery Mathematical Modelling (PyBaMM)}},
  author = {Sulzer, Valentin and Marquis, Scott G. and Timms, Robert and Robinson, Martin and Chapman, S. Jon},
  doi = {10.5334/jors.309},
  journal = {Journal of Open Research Software},
  publisher = {Software Sustainability Institute},
  volume = {9},
  number = {1},
  pages = {14},
  year = {2021}
}

We would be grateful if you could also cite the relevant papers. These will change depending on what models and solvers you use. To find out which papers you should cite, add the line

pybamm.print_citations()

to the end of your script. This will print BibTeX information to the terminal; passing a filename to print_citations will print the BibTeX information to the specified file instead. A list of all citations can also be found in the citations file. In particular, PyBaMM relies heavily on CasADi. See CONTRIBUTING.md for information on how to add your own citations when you contribute.

🛠️ Contributing 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.

📫 Get in touch

For any questions, comments, suggestions or bug reports, please see the contact page.

📃 License

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

Contributors

Thanks goes to these wonderful people (emoji key):

Valentin Sulzer
Valentin Sulzer

🐛 💻 📖 💡 🤔 🚧 👀 ⚠️ 📝
Robert Timms
Robert Timms

🐛 💻 📖 💡 🤔 🚧 👀 ⚠️
Scott Marquis
Scott Marquis

🐛 💻 📖 💡 🤔 🚧 👀 ⚠️
Martin Robinson
Martin Robinson

🐛 💻 📖 💡 🤔 👀 ⚠️
Ferran Brosa Planella
Ferran Brosa Planella

👀 🐛 💻 📖 💡 🤔 🚧 ⚠️ 📝
Tom Tranter
Tom Tranter

🐛 💻 📖 💡 🤔 👀 ⚠️
Thibault Lestang
Thibault Lestang

🐛 💻 📖 💡 🤔 👀 ⚠️ 🚇
Diego
Diego

🐛 👀 💻 🚇
felipe-salinas
felipe-salinas

💻 ⚠️
suhaklee
suhaklee

💻 ⚠️
viviantran27
viviantran27

💻 ⚠️
gyouhoc
gyouhoc

🐛 💻 ⚠️
Yannick Kuhn
Yannick Kuhn

💻 ⚠️
Jacqueline Edge
Jacqueline Edge

🤔 📋 🔍
Fergus Cooper
Fergus Cooper

💻 ⚠️
jonchapman1
jonchapman1

🤔 🔍
Colin Please
Colin Please

🤔 🔍
cwmonroe
cwmonroe

🤔 🔍
Greg
Greg

🤔 🔍
Faraday Institution
Faraday Institution

💵
Alexander Bessman
Alexander Bessman

🐛 💡
dalbamont
dalbamont

💻
Anand Mohan Yadav
Anand Mohan Yadav

📖
WEILONG AI
WEILONG AI

💻 💡 ⚠️
lonnbornj
lonnbornj

💻 ⚠️ 💡
Priyanshu Agarwal
Priyanshu Agarwal

⚠️ 💻 🐛 👀 🚧
DrSOKane
DrSOKane

💻 💡 📖 ⚠️
Saransh Chopra
Saransh Chopra

💻 ⚠️ 📖 👀 🚧
David Straub
David Straub

🐛 💻
maurosgroi
maurosgroi

🤔
Amarjit Singh Gaba
Amarjit Singh Gaba

💻
KennethNwanoro
KennethNwanoro

💻 ⚠️
Ali Hussain Umar Bhatti
Ali Hussain Umar Bhatti

💻 ⚠️
Leshinka Molel
Leshinka Molel

💻 🤔
tobykirk
tobykirk

🤔 💻 ⚠️
Chuck Liu
Chuck Liu

🐛 💻
partben
partben

📖
Gavin Wiggins
Gavin Wiggins

🐛 💻
Dion Wilde
Dion Wilde

🐛 💻
Elias Hohl
Elias Hohl

💻
KAschad
KAschad

🐛
Vaibhav-Chopra-GT
Vaibhav-Chopra-GT

💻
bardsleypt
bardsleypt

🐛 💻
ndrewwang
ndrewwang

🐛 💻
MichaPhilipp
MichaPhilipp

🐛
Alec Bills
Alec Bills

💻
Agriya Khetarpal
Agriya Khetarpal

🚇 💻 📖
Alex Wadell
Alex Wadell

💻 ⚠️ 📖
iatzak
iatzak

📖 🐛 💻
Ankit Kumar
Ankit Kumar

💻
Aniket Singh Rawat
Aniket Singh Rawat

💻
Jerom Palimattom Tom
Jerom Palimattom Tom

📖 💻 ⚠️
Brady Planden
Brady Planden

💡

This project follows the all-contributors specification. Contributions of any kind welcome!