Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

PyBOP

Provides a comprehensive suite of tools for parameterisation and optimisation of battery models.
https://github.com/pybop-team/pybop

Category: Energy Storage
Sub Category: Battery

Keywords from Contributors

batteries battery-models pybamm solvers

Last synced: about 22 hours ago
JSON representation

Repository metadata

A parameterisation and optimisation package for battery models.

README.md

Python Battery Optimisation and Parameterisation

Scheduled
Contributors
Python Versions from PEP 621 TOML
Codecov
License
Open in Colab
nbviewer
Static Badge
Releases
DOI

Main Branch Examples Develop Branch Examples

PyBOP provides tools for the 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 the electrochemical and equivalent circuit models available in PyBaMM.

📌 PyBOP v25.10 presents a major restructure of PyBOP's base classes. We move from setting up
a model, problem, cost, then optimiser to defining a simulator, cost, problem, and then optimiser. A pybop.pybamm.Simulator is designed to simulate a
pybamm.BaseModel. Optimisation parameters can be passed through a pybamm.ParameterValues class.
To understand how to update your use of PyBOP, please take a look at the example notebooks and scripts.

💻 Installation

Within your virtual environment, install PyBOP:

pip install pybop

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

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:

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.

💡 Use Cases

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.

Publications

Please take inspiration from the following journal articles which show how PyBOP is being used for research:

Jupyter Notebooks

Explore our example notebooks for hands-on demonstrations:

Python Scripts

Find additional script-based examples in the examples directory:

Grouped Models

In addition to the models available in PyBaMM, PyBOP currently hosts some grouped-parameter versions of common battery models which are
purpose-built for parameter esimation and can be found under models.

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

🌟 Contributing

We would like to thank all contributors to PyBOP. Contributions are welcome! See CONTRIBUTING.md for ways to get started.

The original PyBOP developers were supported by research funding from the Faraday Institution,
UK Research and Innovation,
and Horizon Europe IntelLiGent Consortium.

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Planden
  given-names: Brady
  orcid: "https://orcid.org/0000-0002-1082-9125"
- family-names: Courtier
  given-names: Nicola E.
  orcid: "https://orcid.org/0000-0002-5714-1096"
- family-names: Robinson
  given-names: Martin
  orcid: "https://orcid.org/0000-0002-1572-6782"
- family-names: Khetarpal
  given-names: Agriya
  orcid: "https://orcid.org/0000-0002-1112-1786"
- family-names: Planella
  given-names: Ferran Brosa
  orcid: "https://orcid.org/0000-0001-6363-2812"
- family-names: Howey
  given-names: David A.
  orcid: "https://orcid.org/0000-0002-0620-3955"
contact:
- family-names: Howey
  given-names: David A.
  orcid: "https://orcid.org/0000-0002-0620-3955"
doi: 10.5281/zenodo.17711656
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Planden
    given-names: Brady
    orcid: "https://orcid.org/0000-0002-1082-9125"
  - family-names: Courtier
    given-names: Nicola E.
    orcid: "https://orcid.org/0000-0002-5714-1096"
  - family-names: Robinson
    given-names: Martin
    orcid: "https://orcid.org/0000-0002-1572-6782"
  - family-names: Khetarpal
    given-names: Agriya
    orcid: "https://orcid.org/0000-0002-1112-1786"
  - family-names: Planella
    given-names: Ferran Brosa
    orcid: "https://orcid.org/0000-0001-6363-2812"
  - family-names: Howey
    given-names: David A.
    orcid: "https://orcid.org/0000-0002-0620-3955"
  date-published: 2025-12-03
  doi: 10.21105/joss.07874
  issn: 2475-9066
  issue: 116
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7874
  title: "PyBOP: A Python package for battery model optimisation and
    parameterisation"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07874"
  volume: 10
title: "PyBOP: A Python package for battery model optimisation and
  parameterisation"

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 17 days ago

Total Commits: 1,665
Total Committers: 18
Avg Commits per committer: 92.5
Development Distribution Score (DDS): 0.455

Commits in past year: 193
Committers in past year: 10
Avg Commits per committer in past year: 19.3
Development Distribution Score (DDS) in past year: 0.461

Name Email Commits
Brady Planden b****n@g****m 908
NicolaCourtier 4****r 378
pre-commit-ci[bot] 6****] 149
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 24
BLYTH Mark UNIVERSITE BRISTOL M****3@i****r 18
Sarah Roggendorf 3****o 4
Noël Hallemans 9****s 2
Grimm f****m@i****k 2
Brady Planden e****0@e****l 2
David Howey d****y@e****k 1
Pip Liggins p****s@d****k 1
Valentin Pratz 1****z 1
Yannick Kuhn 6****n 1

Committer domains:

Issue and Pull Request metadata

Last synced: 13 days ago

Total issues: 306
Total pull requests: 805
Average time to close issues: about 1 month
Average time to close pull requests: 12 days
Total issue authors: 29
Total pull request authors: 17
Average comments per issue: 0.54
Average comments per pull request: 1.45
Merged pull request: 658
Bot issues: 1
Bot pull requests: 165

Past year issues: 57
Past year pull requests: 267
Past year average time to close issues: 25 days
Past year average time to close pull requests: 8 days
Past year issue authors: 12
Past year pull request authors: 14
Past year average comments per issue: 0.3
Past year average comments per pull request: 0.99
Past year merged pull request: 197
Past year bot issues: 0
Past year bot pull requests: 53

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/pybop-team/pybop

Top Issue Authors

  • BradyPlanden (195)
  • NicolaCourtier (48)
  • martinjrobins (10)
  • Dibyendu-IITKGP (8)
  • MarkBlyth (6)
  • davidhowey (5)
  • noelhallemans (4)
  • Santiagopeacely (3)
  • YannickNoelStephanKuhn (3)
  • brosaplanella (2)
  • L0tusC00kie (2)
  • agriyakhetarpal (2)
  • mleot (2)
  • vpratz (1)
  • pghege (1)

Top Pull Request Authors

  • BradyPlanden (345)
  • NicolaCourtier (197)
  • pre-commit-ci[bot] (135)
  • allcontributors[bot] (30)
  • martinjrobins (23)
  • agriyakhetarpal (16)
  • Dibyendu-IITKGP (16)
  • MarkBlyth (8)
  • brosaplanella (8)
  • noelhallemans (7)
  • YannickNoelStephanKuhn (6)
  • f-g-r-i-m-m (4)
  • SarahRo (3)
  • arjxn-py (2)
  • pipliggins (2)

Top Issue Labels

  • enhancement (156)
  • bug (78)
  • 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)

Top Pull Request Labels

  • show (44)
  • blocker (5)
  • ask (3)
  • release blocker (2)
  • bug (1)
  • blocked (1)

Package metadata

proxy.golang.org: github.com/pybop-team/PyBOP

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/pybop-team/PyBOP#section-documentation
  • Licenses: bsd-3-clause
  • Latest release: v24.9.1+incompatible (published over 1 year ago)
  • Last Synced: 2025-12-14T19:08:08.441Z (11 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
proxy.golang.org: github.com/pybop-team/pybop

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/pybop-team/pybop#section-documentation
  • Licenses: bsd-3-clause
  • Latest release: v24.9.1+incompatible (published over 1 year ago)
  • Last Synced: 2025-12-14T19:08:08.420Z (11 days ago)
  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.395%
    • Average: 5.576%
    • Dependent repos count: 5.758%
pypi.org: pybop

Python Battery Optimisation and Parameterisation

  • Homepage: https://github.com/pybop-team/PyBOP
  • Documentation: https://pybop-docs.readthedocs.io
  • Licenses: 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)
  • Last Synced: 2025-12-14T19:08:07.616Z (11 days ago)
  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 621 Last month
  • Rankings:
    • Dependent packages count: 10.002%
    • Stargazers count: 17.078%
    • Forks count: 22.629%
    • Average: 29.315%
    • Dependent repos count: 67.55%
  • Maintainers (1)

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

Score: 14.721474552153097