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

Adds EIS prediction methods #405

Merged
merged 39 commits into from
Aug 22, 2024

Conversation

BradyPlanden
Copy link
Member

@BradyPlanden BradyPlanden commented Jul 11, 2024

Description

This PR adds EIS prediction methods as presented in https://github.com/rish31415/pybamm-eis and https://github.com/pybamm-team/pybamm-eis. These methods are reimplemented into pybop to align with our model and problem classes. This PR also aligns the dataset requirements for "Time" across the codebase, as the EIS problem is in the frequency domain.

To be completed:

  • EIS model construction should happen alongside the conventional pybop model
  • Add "Contact resistance [Ohm]" addition to the terminal voltage variable
  • Add plotting methods
  • Improve the integration with conventional model call structure problem.evaluate-> model.simulate (i.e. do we need the additional class EISProblem and method model.simulateEIS())
  • Add model.simulateEIS_S1 method w/ new name This requires reconstructing the sensitivities, as such is left for a future PR.
  • Add eis functionality to model.predict()
  • Add unit and integration tests
  • Add fitting examples

This PR needs to be merged after PyBaMM v24.5 is released, as well as after #313

Issue reference

Fixes #269

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.

@BradyPlanden BradyPlanden linked an issue Jul 11, 2024 that may be closed by this pull request
@BradyPlanden BradyPlanden force-pushed the 269-add-eis-parameter-identification-methods branch from f1bd83d to 3c9ce9a Compare July 11, 2024 11:12
Copy link

codecov bot commented Jul 11, 2024

Codecov Report

Attention: Patch coverage is 99.18699% with 2 lines in your changes missing coverage. Please review.

Project coverage is 98.76%. Comparing base (4bf4e76) to head (6a6b7dd).
Report is 433 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/_utils.py 98.61% 1 Missing ⚠️
pybop/plotting/nyquist.py 96.29% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #405      +/-   ##
===========================================
- Coverage    98.77%   98.76%   -0.02%     
===========================================
  Files           48       48              
  Lines         3193     3153      -40     
===========================================
- Hits          3154     3114      -40     
  Misses          39       39              

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


🚨 Try these New Features:

Copy link
Member

@NicolaCourtier NicolaCourtier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks @BradyPlanden !

@BradyPlanden BradyPlanden merged commit d414460 into develop Aug 22, 2024
31 checks passed
@BradyPlanden BradyPlanden deleted the 269-add-eis-parameter-identification-methods branch August 22, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add EIS parameter identification methods
2 participants