Data

Tools

Indexes

Applications

Experiments

Open Source Science

pybop

A parameterisation and optimisation package for battery models.

https://github.com/pybop-team/pybop

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    4 of 16 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.2%) to scientific vocabulary

Scientific Fields

Mathematics Computer Science - 39% confidence
Last synced: 6 months ago · JSON representation ·

Repository

A parameterisation and optimisation package for battery models.

Basic Info
Statistics
  • Stars: 146
  • Watchers: 5
  • Forks: 41
  • Open Issues: 77
  • Releases: 13
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

logo.svg # Python Battery Optimisation and Parameterisation [![Scheduled](https://github.com/pybop-team/PyBOP/actions/workflows/scheduled_tests.yaml/badge.svg)](https://github.com/pybop-team/PyBOP/actions/workflows/scheduled_tests.yaml) [![Contributors](https://img.shields.io/github/contributors/pybop-team/PyBOP)](https://github.com/pybop-team/PyBOP/graphs/contributors) [![Python Versions from PEP 621 TOML](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fpybop-team%2FPyBOP%2Fdevelop%2Fpyproject.toml&label=Python)](https://pypi.org/project/pybop/) [![Codecov](https://codecov.io/gh/pybop-team/PyBOP/branch/develop/graph/badge.svg)](https://codecov.io/gh/pybop-team/PyBOP) [![License](https://img.shields.io/github/license/pybop-team/PyBOP?color=blue)](https://github.com/pybop-team/PyBOP/blob/develop/LICENSE) [![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/pybop-team/PyBOP/blob/develop/) [![nbviewer](https://raw.githubusercontent.com/jupyter/design/master/logos/Badges/nbviewer_badge.svg)](https://nbviewer.org/github/pybop-team/PyBOP/tree/develop/examples/notebooks/) [![Static Badge](https://img.shields.io/badge/https%3A%2F%2Fpybop-team.github.io%2Fpybop-bench%2F?label=Benchmarks)](https://pybop-team.github.io/pybop-bench/) [![Releases](https://img.shields.io/github/v/release/pybop-team/PyBOP?color=gold)](https://github.com/pybop-team/PyBOP/releases) [Main Branch Examples](https://github.com/pybop-team/PyBOP/tree/main/examples) [Develop Branch Examples](https://github.com/pybop-team/PyBOP/tree/develop/examples)

PyBOP provides a complete set of tools for parameterisation and optimisation of battery models, using both Bayesian and frequentist approaches, with example workflows to assist the user. PyBOP can be used to parameterise various battery models, including electrochemical and equivalent circuit models available in PyBaMM. PyBOP prioritises clear and informative diagnostics for the user, while also allowing for advanced probabilistic methods.

The diagram below shows the conceptual framework of PyBOP. This package is currently under development, so users can expect the API to evolve with future releases.

pybop_arch.svg

Installation

Within your virtual environment, install PyBOP:

bash pip install pybop

To install the most recent state of PyBOP, install from the develop branch,

bash pip install git+https://github.com/pybop-team/PyBOP.git@develop

To install a previous version of PyBOP, use the following template and replace the version number:

bash pip install pybop==v24.3

To check that PyBOP is installed correctly, run one of the examples in the following section. For a development installation, see the Contribution Guide. More installation information is available in our documentation and the extended installation instructions for PyBaMM.

Using PyBOP

PyBOP has two intended uses:

  1. Parameter inference from battery test data.

  2. Design optimisation under battery manufacturing/use constraints.

These include a wide variety of optimisation problems that require careful consideration due to the choice of battery model, data availability and/or the choice of design parameters.

Jupyter Notebooks

Explore our example notebooks for hands-on demonstrations:

Python Scripts

Find additional script-based examples in the examples directory:

Supported Methods

The table below lists the currently supported models, optimisers, and cost functions in PyBOP.

| Battery Models | Cost Functions | Optimization Algorithms | |-----------------------------------------------|------------------------------------|--------------------------------------------------------------------| | Single Particle Model (SPM) | Sum of Squared Error (SSE) | Covariance Matrix Adaptation Evolution Strategy (CMA-ES) | | Single Particle Model with Electrolyte (SPMe) | Root Mean Squared Error (RMSE) | Particle Swarm Optimization (PSO) | | Doyle-Fuller-Newman (DFN) | Mean Squared Error (MSE) | Exponential Natural Evolution Strategy (xNES) | | Many Particle Model (MPM) | Mean Absolute Error (MAE) | Separable Natural Evolution Strategy (sNES) | | Multi-Species Multi-Reaction (MSMR) | Minkowski | Weight Decayed Adaptive Moment Estimation (AdamW) | | Weppner-Huggins | Sum of Power | Improved Resilient Backpropagation (iRProp-) | | Equivalent Circuit Models (ECM) | Gaussian Log Likelihood | SciPy Minimize & Differential Evolution | | Grouped-parameter SPM (GroupedSPM) | Log Posterior | Cuckoo Search | | Grouped-parameter SPMe (GroupedSPMe) | Gravimetric Energy / Power Density | Simulated Annealing | | | Volumetric Energy / Power Density | Random Search | | | | Gradient Descent | | | | Nelder Mead |

Code of Conduct

PyBOP aims to foster a broad consortium of developers and users, building on and learning from the success of the PyBaMM community. Our values are:

  • Inclusivity and fairness (those who wish to contribute may do so, and their input is appropriately recognised)

  • Interoperability (modularity for maximum impact and inclusivity)

  • User-friendliness (putting user requirements first via user-assistance & workflows)

License

PyBOP is released under the BSD 3-Clause License.

Contributors ✨

Thanks goes to these wonderful people:

Brady Planden
Brady Planden
🚇 ⚠️ 💻 💡 👀		 NicolaCourtier
NicolaCourtier
💻 👀 💡 ⚠️		 David Howey
David Howey
🤔 🧑‍🏫		 Martin Robinson
Martin Robinson
🤔 🧑‍🏫 👀 💻 ⚠️		 Ferran Brosa Planella
Ferran Brosa Planella
👀 💻 💡		 Agriya Khetarpal
Agriya Khetarpal
💻 🚇 👀		 Faraday Institution
Faraday Institution
💵
UK Research and Innovation
UK Research and Innovation
💵		 Horizon Europe IntelLiGent Consortium
Horizon Europe IntelLiGent Consortium
💵		 Muhammed Nedim Sogut
Muhammed Nedim Sogut
💻		 MarkBlyth
MarkBlyth
💻		 f-g-r-i-m-m
f-g-r-i-m-m
💡		 Dibyendu-IITKGP
Dibyendu-IITKGP
💡 ⚠️ 💻		 Noël Hallemans
Noël Hallemans
💡
Pip Liggins
Pip Liggins
💻		 Valentin Pratz
Valentin Pratz
💡

This project follows the all-contributors specifications. Contributions of any kind are welcome! See CONTRIBUTING.md for ways to get started.

Owner

  • Name: pybop-team
  • Login: pybop-team
  • Kind: organization

JOSS Publication

PyBOP: A Python package for battery model optimisation and parameterisation
Published
December 03, 2025
DOI
Volume 10, Issue 116, Page 7874
Authors
Brady Planden ORCID
Department of Engineering Science, University of Oxford, Oxford, United Kingdom
Nicola E. Courtier ORCID
Department of Engineering Science, University of Oxford, Oxford, United Kingdom, The Faraday Institution, Harwell Campus, Didcot, United Kingdom
Martin Robinson ORCID
Research Software Engineering Group, University of Oxford, Oxford, United Kingdom
Agriya Khetarpal ORCID
Quansight
Ferran Brosa Planella ORCID
The Faraday Institution, Harwell Campus, Didcot, United Kingdom, Mathematics Institute, University of Warwick, Coventry, United Kingdom
David A. Howey ORCID
Department of Engineering Science, University of Oxford, Oxford, United Kingdom, The Faraday Institution, Harwell Campus, Didcot, United Kingdom
Editor
Jeff Gostick ORCID
Tags
python battery model parameter inference design optimisation
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
title: 'PyBOP: A Python package for battery model optimisation and parameterisation'
message: >-
  If you use this software, please cite the article below.
authors:
  - given-names: Brady
    family-names: Planden
    orcid: "https://orcid.org/0000-0002-1082-9125"
  - given-names: Nicola
    family-names: Courtier
    orcid: "https://orcid.org/0000-0002-5714-1096"
  - given-names: Martin
    family-names: Robinson
    orcid: "https://orcid.org/0000-0002-1572-6782"
  - given-names: Agriya
    family-names: Khetarpal
    orcid: "https://orcid.org/0000-0002-1112-1786"
  - given-names: Ferran
    family-names: Brosa Planella
    orcid: "https://orcid.org/0000-0001-6363-2812"
  - given-names: David
    family-names: Howey
    orcid: "https://orcid.org/0000-0002-0620-3955"

keywords:
  - "python"
  - "battery models"
  - "parameter inference"
  - "optimization"

journal: "arXiv"
date-released: 2024-12-20
doi: 10.48550/arXiv.2412.15859
version: "25.6" # Update this alongside new releases
repository-code: 'https://www.github.com/pybop-team/pybop'

GitHub Events

Total
  • Create event: 142
  • Release event: 3
  • Issues event: 98
  • Watch event: 61
  • Delete event: 143
  • Issue comment event: 238
  • Push event: 864
  • Pull request event: 306
  • Pull request review comment event: 220
  • Pull request review event: 270
  • Fork event: 14
Last Year
  • Create event: 142
  • Release event: 3
  • Issues event: 98
  • Watch event: 61
  • Delete event: 143
  • Issue comment event: 238
  • Push event: 864
  • Pull request event: 306
  • Pull request review comment event: 220
  • Pull request review event: 270
  • Fork event: 14

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 1,578
  • Total Committers: 16
  • Avg Commits per committer: 98.625
  • Development Distribution Score (DDS): 0.425
Past Year
  • Commits: 455
  • Committers: 13
  • Avg Commits per committer: 35.0
  • Development Distribution Score (DDS): 0.503
Top Committers
Name Email Commits
Brady Planden b****n@g****m 908
NicolaCourtier 4****r 304
pre-commit-ci[bot] 6****] 142
Agriya Khetarpal 7****l 43
allcontributors[bot] 4****] 42
martinjrobins m****s@g****m 33
Ferran Brosa Planella F****a@w****k 31
Mark Blyth b****7@g****m 25
Dibyendu-IITKGP d****c@g****m 23
BLYTH Mark UNIVERSITE BRISTOL M****3@i****r 18
Noël Hallemans 9****s 2
Brady Planden e****0@e****l 2
Grimm f****m@i****k 2
David Howey d****y@e****k 1
Pip Liggins p****s@d****k 1
Valentin Pratz 1****z 1
Committer Domains (Top 20 + Academic)
dtc.ox.ac.uk: 1 eng.ox.ac.uk: 1 ic.ac.uk: 1 intra.cea.fr: 1 warwick.ac.uk: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 302
  • Total pull requests: 781
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 12 days
  • Total issue authors: 28
  • Total pull request authors: 16
  • Average comments per issue: 0.53
  • Average comments per pull request: 1.43
  • Merged pull requests: 641
  • Bot issues: 1
  • Bot pull requests: 162
Past Year
  • Issues: 94
  • Pull requests: 380
  • Average time to close issues: 13 days
  • Average time to close pull requests: 8 days
  • Issue authors: 17
  • Pull request authors: 15
  • Average comments per issue: 0.3
  • Average comments per pull request: 1.04
  • Merged pull requests: 296
  • Bot issues: 1
  • Bot pull requests: 79
View more stats
Top Authors
Issue Authors
  • BradyPlanden (195)
  • NicolaCourtier (46)
  • martinjrobins (9)
  • Dibyendu-IITKGP (8)
  • MarkBlyth (6)
  • davidhowey (5)
  • noelhallemans (4)
  • Santiagopeacely (3)
  • YannickNoelStephanKuhn (3)
  • brosaplanella (2)
  • L0tusC00kie (2)
  • mleot (2)
  • agriyakhetarpal (2)
  • vpratz (1)
  • pghege (1)
Pull Request Authors
  • BradyPlanden (346)
  • NicolaCourtier (179)
  • pre-commit-ci[bot] (133)
  • allcontributors[bot] (29)
  • martinjrobins (23)
  • agriyakhetarpal (16)
  • Dibyendu-IITKGP (16)
  • MarkBlyth (8)
  • brosaplanella (8)
  • noelhallemans (7)
  • YannickNoelStephanKuhn (5)
  • f-g-r-i-m-m (4)
  • arjxn-py (2)
  • pipliggins (2)
  • herzphi (2)
Top Labels
Issue Labels
enhancement (155) bug (77) priority:high (13) good first issue (7) difficulty:easy (4) difficulty:hard (2) priority:medium (2) difficulty:medium (2) documentation (2) blocked (2) blocker (1) release blocker (1)
Pull Request Labels
show (45) blocker (6) ask (3) release blocker (2) bug (1) blocked (1)

Packages

  • Total packages: 3
  • Total downloads:
    • pypi 305 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 20
  • Total maintainers: 1
proxy.golang.org: github.com/pybop-team/PyBOP
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
proxy.golang.org: github.com/pybop-team/pybop
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
pypi.org: pybop

Python Battery Optimisation and Parameterisation

  • Homepage: https://github.com/pybop-team/PyBOP
  • Documentation: https://pybop-docs.readthedocs.io
  • License: BSD 3-Clause License Copyright (c) 2023, pybop-team Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 24.9.1
    published over 1 year ago
  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 305 Last month
Rankings
Dependent packages count: 10.0%
Stargazers count: 17.1%
Forks count: 22.6%
Average: 29.3%
Dependent repos count: 67.6%
Maintainers (1)
bplanden
Last synced: 6 months ago

Dependencies

.github/workflows/scheduled_tests.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/release_action.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
  • sigstore/gh-action-sigstore-python v1.2.3 composite
pyproject.toml pypi
  • numpy >=1.16
  • pandas >=1.0
  • pints >=0.5
  • pybamm >=23.5
  • scipy >=1.3
.github/workflows/periodic_benchmarks.yaml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-python v5 composite
  • actions/upload-artifact v4 composite
.github/workflows/lychee_links.yaml actions
  • actions/cache v4 composite
  • actions/checkout v4 composite
  • lycheeverse/lychee-action v1.10.0 composite
.github/workflows/nightly_dependency_tests.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
.github/workflows/test_on_pull_request.yaml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v4 composite