Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

importing cycler data to PyBOP notebook example added #522

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

Dibyendu-IITKGP
Copy link
Contributor

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:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

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

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

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

@Dibyendu-IITKGP
Copy link
Contributor Author

Dibyendu-IITKGP commented Sep 30, 2024

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

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Dibyendu-IITKGP Dibyendu-IITKGP force-pushed the 504-add-import-cycler-data-to-pybop-notebook-example branch from 80c89de to 621ffc7 Compare October 3, 2024 16:36
@Dibyendu-IITKGP Dibyendu-IITKGP force-pushed the 504-add-import-cycler-data-to-pybop-notebook-example branch from 0b2e1a4 to e58c374 Compare October 3, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add "Import Cycler Data to PyBOP" notebook example
1 participant