Notebook example files added for ECM and folder structure updated.

[Dibyendu-IITKGP]

Description

Notebook example files are added for single pulse and multi-pulse HPPC data fitting, a thermal submodel is also added. Folder structure updated to keep data files for running example notebook files.

Issue reference

Fixes #437

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (6569eaa) to head (ed457ff).
Report is 135 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #460   +/-   ##
========================================
  Coverage    99.04%   99.04%           
========================================
  Files           52       52           
  Lines         3559     3559           
========================================
  Hits          3525     3525           
  Misses          34       34           

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

[BradyPlanden]

I thought we had a stale PR diff for examples/data/LG_M50_ECM/1-single-pulse-circuit-model.ipynb, but due to the movement of this file to data directory, the current state of it on develop is different than the state in this branch. I don't believe you changed this notebook(?), so this needs to be updated to reflect the current state in develop.

[Dibyendu-IITKGP]

Yes, I haven't changed this file. So you mean this file needs to be pushed as a commit?

[BradyPlanden]

Yes, one way is to restore the notebook to develop state and move it again before committing. The below command should restore the file to develop state.

git restore -s develop examples/notebooks/LG_M50_ECM/1-single-pulse-circuit-model.ipynb

[Dibyendu-IITKGP]

Great, thanks!

[Dibyendu-IITKGP]

Do you still want the 1-single-pulse-circuit-model.ipynb file within the LG_M50_ECM folder, or should it be under notebooks directly? I prefer the second one.

[BradyPlanden]

Agreed, let's keep it under the notebook subdirectory

[Dibyendu-IITKGP]

I think now we are good to go.

[BradyPlanden]

Thanks for these additions @Dibyendu-IITKGP - they look great! I'll merge once the tests finish.

[BradyPlanden]

@all-contributors please add @Dibyendu-IITKGP for examples

[allcontributors]

@BradyPlanden

I've put up a pull request to add @Dibyendu-IITKGP! 🎉