Skip to content

Create battery benchmark methods#644

Merged
NicolaCourtier merged 133 commits into
developfrom
124-battery-benchmarks
May 6, 2025
Merged

Create battery benchmark methods#644
NicolaCourtier merged 133 commits into
developfrom
124-battery-benchmarks

Conversation

@NicolaCourtier

Copy link
Copy Markdown
Member

Description

Create some high-level classes to enable new users to get started with common battery parameterisation tasks.

Issue reference

Fixes #124

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 Bot commented Jan 28, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.28401% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 99.24%. Comparing base (0a55c30) to head (d13b43b).
⚠️ Report is 27 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/applications/gitt_methods.py 96.49% 2 Missing ⚠️
pybop/models/lithium_ion/basic_SPMe.py 98.36% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #644      +/-   ##
===========================================
+ Coverage    99.22%   99.24%   +0.01%     
===========================================
  Files           68       72       +4     
  Lines         4922     5265     +343     
===========================================
+ Hits          4884     5225     +341     
- Misses          38       40       +2     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Base automatically changed from non-uniform-mean to develop March 25, 2025 15:12
@NicolaCourtier
NicolaCourtier marked this pull request as ready for review March 26, 2025 10:52

@brosaplanella brosaplanella left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great, thanks!

@BradyPlanden BradyPlanden left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is looking great @NicolaCourtier. I've left some comments, I think most of them are smaller updates with one or two requesting a bit of refactoring.

Comment thread pybop/applications/ocp_methods.py Outdated
Comment thread examples/scripts/battery_parameterisation/gitt_fitting.py Outdated
Comment thread pybop/applications/base_method.py
Comment thread pybop/applications/base_method.py
Comment thread pybop/applications/base_method.py
Comment thread pybop/applications/ocp_methods.py
Comment thread pybop/models/lithium_ion/weppner_huggins.py
Comment thread pybop/models/lithium_ion/weppner_huggins.py Outdated
Comment thread pybop/models/lithium_ion/basic_SP_diffusion.py Outdated
Comment thread pybop/models/lithium_ion/weppner_huggins.py Outdated
@NicolaCourtier

Copy link
Copy Markdown
Member Author

The benchmarks are failing for an unrelated reason, so this PR is now passing the tests.

@NicolaCourtier
NicolaCourtier merged commit dc30f5c into develop May 6, 2025
@NicolaCourtier
NicolaCourtier deleted the 124-battery-benchmarks branch May 6, 2025 09:43
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.

Experimental classes in high-level package

3 participants