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

Update default init_soc for DesignProblem #422

Merged
merged 17 commits into from
Aug 5, 2024

Conversation

NicolaCourtier
Copy link
Member

Description

Update the default value of the init_soc parameter of DesignProblem.

Issue reference

Fixes #421

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 linked an issue Jul 24, 2024 that may be closed by this pull request
Copy link

codecov bot commented Jul 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.52%. Comparing base (1bedcd7) to head (dcabe89).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #422      +/-   ##
===========================================
+ Coverage    98.24%   98.52%   +0.28%     
===========================================
  Files           46       46              
  Lines         2910     2923      +13     
===========================================
+ Hits          2859     2880      +21     
+ Misses          51       43       -8     

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

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.

Looks good - thanks! Just a few comments.

pybop/models/base_model.py Show resolved Hide resolved
pybop/models/base_model.py Show resolved Hide resolved
]

if init_soc is None:
if "Initial SoC" in model._parameter_set.keys():
Copy link
Member

Choose a reason for hiding this comment

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

We should use the property for this private attribute instead of directly accessing it:

(throughout PR)

Copy link
Member Author

@NicolaCourtier NicolaCourtier Aug 5, 2024

Choose a reason for hiding this comment

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

It would be easier for me to do this in #425 - where some of the logic regarding modification of the parameter sets is fixed. We can merge this PR into #425 and then into develop if you prefer.

pybop/parameters/parameter.py Show resolved Hide resolved
@NicolaCourtier
Copy link
Member Author

@BradyPlanden shall I merge this one into #425 or develop?

@BradyPlanden
Copy link
Member

Either is fine with me, although if it merges into develop, the private attributes will need the be fixed in #435 before that can be merged.

@NicolaCourtier NicolaCourtier merged commit 9e15f90 into develop Aug 5, 2024
30 checks passed
@NicolaCourtier NicolaCourtier deleted the 421-design_init_soc branch August 5, 2024 11:11
BradyPlanden pushed a commit that referenced this pull request Aug 8, 2024
* Update default init_soc

* Update CHANGELOG.md

* Update check_params

* Add pybamm_model as default attribute

* Ensure predict uses unprocessed_model

* Remove unused store_optimised_parameters

* Update parameters.initial_value

* Use any Initial SoC from parameter_set

* Update spm_electrode_design.ipynb

* Move Changelog entry

* Fix merge mistake

* Add tests

* Update description

* Update check for ECM init_soc

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
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.

Design problems should have a default init_soc
2 participants