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

Refactor update_capacity #465

Merged
merged 21 commits into from
Sep 9, 2024
Merged

Refactor update_capacity #465

merged 21 commits into from
Sep 9, 2024

Conversation

NicolaCourtier
Copy link
Member

Description

Update the order in which the parameter_set is updated during design optimisation and move update_capacity to become an attribute of the problem.

Issue reference

Fixes #464

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.

Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (6b83edc) to head (121187c).
Report is 23 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #465      +/-   ##
===========================================
+ Coverage    99.01%   99.04%   +0.02%     
===========================================
  Files           52       52              
  Lines         3555     3545      -10     
===========================================
- Hits          3520     3511       -9     
+ Misses          35       34       -1     

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

@NicolaCourtier NicolaCourtier marked this pull request as ready for review August 21, 2024 11:56
@NicolaCourtier NicolaCourtier added the release blocker Needs to be closed before a new release can be deployed label Sep 2, 2024
Copy link
Member

@BradyPlanden BradyPlanden left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @NicolaCourtier. I'll merge once #484 lands.

pybop/models/lithium_ion/base_echem.py Outdated Show resolved Hide resolved
NicolaCourtier and others added 3 commits September 6, 2024 11:05
Co-authored-by: Brady Planden <55357039+BradyPlanden@users.noreply.github.com>
# Conflicts:
#	examples/notebooks/spm_electrode_design.ipynb
@BradyPlanden BradyPlanden merged commit db00871 into develop Sep 9, 2024
30 of 31 checks passed
@BradyPlanden BradyPlanden deleted the 464-design-updating branch September 9, 2024 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release blocker Needs to be closed before a new release can be deployed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Fix design parameter set updates and refactor update_capacity
2 participants