[REVIEW]: PyBOP: A Python package for battery model optimisation and parameterisation

[editorialbot]

Submitting author: @BradyPlanden (Brady Planden)
Repository: https://github.com/pybop-team/PyBOP
Branch with paper.md (empty if default branch): joss
Version: v24.12
Editor: @jgostick
Reviewers: @leeberty84, @nickbrady
Archive: Pending

Status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/8e75852231729446406eeb105645bd00"><img src="https://joss.theoj.org/papers/8e75852231729446406eeb105645bd00/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/8e75852231729446406eeb105645bd00/status.svg)](https://joss.theoj.org/papers/8e75852231729446406eeb105645bd00)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@leeberty84 & @nickbrady, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@editorialbot generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @jgostick know.

✨ Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest ✨

Checklists

@leeberty84, please create your checklist typing: @editorialbot generate my checklist

@nickbrady, please create your checklist typing: @editorialbot generate my checklist

[editorialbot]

Hello humans, I'm @editorialbot, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@editorialbot commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@editorialbot generate pdf

[editorialbot]

Software report:

github.com/AlDanial/cloc v 1.98  T=0.70 s (291.1 files/s, 390611.7 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Text                             2              0              0         223970
Python                         131           3679           6304          14716
SVG                             14             26              1           6701
Jupyter Notebook                20              0          12769           1570
CSV                              1              0              0           1389
TeX                              2            123             26           1232
Markdown                        11            367              9            841
YAML                            11             92             48            658
JSON                             4              0              0            149
TOML                             1             10              0             94
reStructuredText                 3             72             30             69
Bourne Shell                     2             14             16             28
DOS Batch                        1              8              1             26
JavaScript                       1              0              4             13
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                           205           4395          19215         251465
-------------------------------------------------------------------------------

Commit count by author:

   884	Brady Planden
   297	NicolaCourtier
   111	pre-commit-ci[bot]
    43	Agriya Khetarpal
    38	allcontributors[bot]
    31	Ferran Brosa Planella
    26	martinjrobins
    19	Dibyendu-IITKGP
    18	BLYTH Mark UNIVERSITE BRISTOL
    17	Mark Blyth
     9	David Howey
     8	MarkBlyth
     7	Martin Robinson
     2	Grimm

[editorialbot]

Paper file info:

🚨 Wordcount for paper.md is 3053

✅ The paper includes a Statement of need section

[editorialbot]

License info:

✅ License found: BSD 3-Clause "New" or "Revised" License (Valid open source OSI approved license)

[editorialbot]

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

✅ OK DOIs

- 10.5334/jors.309 is OK
- 10.5334/jors.252 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1149/1.2221597 is OK
- 10.1149/1.2054684 is OK
- 10.1088/2516-1083/ac7d31 is OK
- 10.1149/2.0341708jes is OK
- 10.21105/joss.04051 is OK
- 10.1088/2516-1083/ac692c is OK
- 10.1016/j.jpowsour.2021.230859 is OK
- 10.1016/j.est.2021.103388 is OK
- 10.1016/j.est.2019.100828 is OK
- 10.1149/1945-7111/ab9050 is OK
- 10.1149/1945-7111/acada7 is OK
- 10.1016/j.energy.2022.125966 is OK
- 10.1201/b10905 is OK
- 10.2307/3318737 is OK
- 10.1007/s11222-006-8769-1 is OK
- 10.1063/1.1699114 is OK
- 10.1149/1945-7111/ac11a5 is OK
- 10.48550/ARXIV.1711.05101 is OK
- 10.1109/NABIC.2009.5393690 is OK

🟡 SKIP DOIs

- No DOI given, and none found for title: Battery Parameter eXchange
- No DOI given, and none found for title: Composable Effects for Flexible and Accelerated Pr...
- No DOI given, and none found for title: JAX: composable transformations of Python+NumPy pr...
- No DOI given, and none found for title: BlackJAX: Composable Bayesian inference in JAX
- No DOI given, and none found for title: The DeepMind JAX Ecosystem
- No DOI given, and none found for title: The No-U-Turn Sampler: Adaptively Setting Path Len...
- No DOI given, and none found for title: PyBaMM EIS: Efficient Linear Algebra Methods to De...
- No DOI given, and none found for title: Méthode générale pour la résolution des systemes d...

❌ MISSING DOIs

- None

❌ INVALID DOIs

- https://doi.org/10.1016/j.ifacol.2020.12.1770 is INVALID because of 'https://doi.org/' prefix

[editorialbot]

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

[jgostick]

Hi @nickbrady and @leeberty84, thanks very much for agreeing to review this package. There is a link to reviewer guidelines at the top of this thread but here is the short version:

• Create a 'reviewer checklist' for yourself
• Start playing with the package and checking off the boxes
• As you find issues or problems, open issues on the PyBOP repo
• Once you've ticked all the boxes, then your job in done!