PyBaMM

PyBaMM (Python Battery Mathematical Modelling) solves physics-based electrochemical DAE models by using state-of-the-art automatic differentiation and numerical solvers. The Doyle-Fuller-Newman model can be solved in under 0.1 seconds, while the reduced-order Single Particle Model and Single Particle Model with electrolyte can be solved in just a few milliseconds. Additional physics can easily be included such as thermal effects, fast particle diffusion, 3D effects, and more. All models are implemented in a flexible manner, and a wide range of models and parameter sets (NCA, NMC, LiCoO2, ...) are available. There is also functionality to simulate any set of experimental instructions, such as CCCV or GITT, or specify drive cycles.

💻 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 CCCV:

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.

🚀 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

pip install pybamm

Using conda

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

conda install -c conda-forge pybamm

Optional solvers

Following GNU/Linux and macOS solvers are optionally available:

• scikits.odes-based solver, see the documentation.
• jax-based solver, see the documentation.

📖 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 🐛 💻 📖 💡 🤔 🚧 👀 ⚠️ ✅ 📝	Robert Timms 🐛 💻 📖 💡 🤔 🚧 👀 ⚠️ ✅	Scott Marquis 🐛 💻 📖 💡 🤔 🚧 👀 ⚠️ ✅	Martin Robinson 🐛 💻 📖 💡 🤔 👀 ⚠️ ✅	Ferran Brosa Planella 👀 🐛 💻 📖 💡 🤔 🚧 ⚠️ ✅ 📝	Tom Tranter 🐛 💻 📖 💡 🤔 👀 ⚠️ ✅	Thibault Lestang 🐛 💻 📖 💡 🤔 👀 ⚠️ 🚇
Diego 🐛 👀 💻 🚇	felipe-salinas 💻 ⚠️	suhaklee 💻 ⚠️	viviantran27 💻 ⚠️	gyouhoc 🐛 💻 ⚠️	Yannick Kuhn 💻 ⚠️	Jacqueline Edge 🤔 📋 🔍
Fergus Cooper 💻 ⚠️	jonchapman1 🤔 🔍	Colin Please 🤔 🔍	cwmonroe 🤔 🔍	Greg 🤔 🔍	Faraday Institution 💵	Alexander Bessman 🐛 💡
dalbamont 💻	Anand Mohan Yadav 📖	WEILONG AI 💻 💡 ⚠️	lonnbornj 💻 ⚠️ 💡	Priyanshu Agarwal ⚠️ 💻 🐛 👀 🚧 ✅	DrSOKane 💻 💡 📖 ⚠️ ✅	Saransh Chopra 💻 ⚠️ 📖 ✅
David Straub 🐛 💻	maurosgroi 🤔	Amarjit Singh Gaba 💻	KennethNwanoro 💻 ⚠️	Ali Hussain Umar Bhatti 💻 ⚠️	Leshinka Molel 💻 🤔	tobykirk 🤔 💻 ⚠️ ✅
Chuck Liu 🐛 💻	partben 📖	Gavin Wiggins 🐛 💻

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