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

Add GroupedSPMe model #584

Merged
merged 63 commits into from
Dec 11, 2024
Merged

Add GroupedSPMe model #584

merged 63 commits into from
Dec 11, 2024

Conversation

NicolaCourtier
Copy link
Member

@NicolaCourtier NicolaCourtier commented Dec 6, 2024

Description

Add a grouped parameter version of the SPMe for parameter identification.

Issue reference

New feature

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.

@NicolaCourtier NicolaCourtier marked this pull request as ready for review December 6, 2024 12:54
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

Attention: Patch coverage is 99.59677% with 1 line in your changes missing coverage. Please review.

Project coverage is 99.22%. Comparing base (c8b00e6) to head (87abcc3).
Report is 36 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/models/lithium_ion/basic_SPMe.py 99.50% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #584      +/-   ##
===========================================
+ Coverage    99.08%   99.22%   +0.13%     
===========================================
  Files           52       57       +5     
  Lines         3605     4240     +635     
===========================================
+ Hits          3572     4207     +635     
  Misses          33       33              

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

@NicolaCourtier
Copy link
Member Author

This implementation works with input currents and EIS, but it can only reliably run an experiment without the double layer (i.e. not with {"surface form": "differential"}). We are not currently sure whether this issue is on the PyBOP or PyBaMM side.

Copy link
Contributor

@brosaplanella brosaplanella left a comment

Choose a reason for hiding this comment

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

Looks good, just some comments!

examples/scripts/comparison_examples/grouped_SPMe.py Outdated Show resolved Hide resolved
examples/scripts/comparison_examples/grouped_SPMe.py Outdated Show resolved Hide resolved
pybop/models/lithium_ion/basic_SPMe.py Show resolved Hide resolved
pybop/models/lithium_ion/basic_SPMe.py Outdated Show resolved Hide resolved
pybop/models/lithium_ion/basic_SPMe.py Show resolved Hide resolved
pybop/models/lithium_ion/basic_SPMe.py Show resolved Hide resolved
pybop/models/lithium_ion/basic_SPMe.py Outdated Show resolved Hide resolved
pybop/models/lithium_ion/echem.py Outdated Show resolved Hide resolved
@NicolaCourtier NicolaCourtier merged commit 23aa9dd into develop Dec 11, 2024
31 checks passed
@NicolaCourtier NicolaCourtier deleted the grouped-SPMe branch December 11, 2024 16:46
@NicolaCourtier NicolaCourtier self-assigned this Dec 11, 2024
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.

3 participants