pybop-team / PyBOP

A parameterisation and optimisation package for battery models.
https://pybop-docs.readthedocs.io
BSD 3-Clause "New" or "Revised" License
73 stars 22 forks source link

importing cycler data to PyBOP notebook example added #522

Open Dibyendu-IITKGP opened 1 month ago

Dibyendu-IITKGP commented 1 month ago

Description

A example notebook file is added to demonstrate how to import battery cycler data directly to PyBOP without any pre-processing. Battery-Data-Toolkit is used for this purpose. However, a similar kind of approach can be followed for any battery cycler data converter (example: cellpy etc.). It is also shown how to use part of the cycler data to fit HPPC pulses and estimate equivalent circuit parameters.

Issue reference

Fixes #504

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

Type of change

Key checklist:

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

Thank you for contributing to our project! Your efforts help us to deliver great software.

Dibyendu-IITKGP commented 1 month ago

@BradyPlanden I think with this example, we can remove previously added equivalent_circuit_identification_hppc.ipynb and equivalent_circuit_identification_multipulse.ipynb files. This file serves all the purposes of the mentioned files. Also, I think I can add within the same file how to use cellpy (as an alternative to Battery-Data-Toolkit) for reading cycler data. Let me know your thoughts.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.05%. Comparing base (46ae507) to head (5c6c8a2). Report is 10 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #522 +/- ## ======================================== Coverage 99.04% 99.05% ======================================== Files 52 52 Lines 3578 3582 +4 ======================================== + Hits 3544 3548 +4 Misses 34 34 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.