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

Fix parameter set logic and allow FittingProblem to take init_ocv rather than init_soc #425

Merged
merged 105 commits into from
Aug 7, 2024

Conversation

NicolaCourtier
Copy link
Member

Description

Remove the init_soc option from BaseProblem, keep the init_soc option for DesignProblem and replace it with an init_ocv option for FittingProblem and Observers. This change is to ensure consistency in problems with parameters that affect the calculation of the initial concentrations from SOC.

Issue reference

Fixes #424

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 Jul 25, 2024

Codecov Report

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

Project coverage is 98.68%. Comparing base (d68a70d) to head (db09455).
Report is 494 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/problems/fitting_problem.py 96.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #425      +/-   ##
===========================================
+ Coverage    98.51%   98.68%   +0.16%     
===========================================
  Files           46       46              
  Lines         2960     2961       +1     
===========================================
+ Hits          2916     2922       +6     
+ Misses          44       39       -5     

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

@NicolaCourtier
Copy link
Member Author

TODO: Re-run all notebooks after #428 and check output.

Copy link
Contributor

@MarkBlyth MarkBlyth left a comment

Choose a reason for hiding this comment

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

I'm happy with all this. Since initial_state can be an OCV or SOC, it won't break any of the functionality needed for typical cell-cycling tests.

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 for the additions @NicolaCourtier!

tests/unit/test_models.py Show resolved Hide resolved
pybop/problems/fitting_problem.py Show resolved Hide resolved
@NicolaCourtier NicolaCourtier merged commit 15d21b1 into develop Aug 7, 2024
30 checks passed
@NicolaCourtier NicolaCourtier deleted the 424-fitting-ocv branch August 7, 2024 16:23
BradyPlanden added a commit that referenced this pull request Aug 8, 2024
…her than init_soc (#425)

* Update default init_soc

* Update CHANGELOG.md

* Update check_params

* Add pybamm_model as default attribute

* Ensure predict uses unprocessed_model

* Move rebuild check to model.simulate

* Align simulate output with predict

* Replace init_soc with init_ocv for FittingProblem

* Update notebooks

* Update test_observers.py

* Update descriptions and simplify

* Add test_set_initial_state

* Update test_problem.py

* Break connection between parameter_sets

* Allow predict to update initial state

* Add nbstripout pre-commit hook

* Add -q and re-run all notebooks

* Copy parameter sets and remove model.initial_state

* Reset spm_NelderMead.py

* Update CHANGELOG.md

* Allow parameter_set is None

* Re-run notebooks

* Update bounds

* Update notebooks

* Set numpy random seed in notebooks

* Re-run with fixed seed

* Update bounds

* Update notebooks to initial_state

* Add set_initial_state for ECMs

* Add init_ocv setter

* Add init_ocv values

* Re-run notebooks

* Add tests for ECM get_initial_state

* Add ECM initial state error tests

* Remove unused store_optimised_parameters

* Update parameters.initial_value

* Use any Initial SoC from parameter_set

* Update bounds again

* Update init_soc in notebooks

* Move dataset check within unscented_kalman

* Remove unnecessary lines from spm_UKF

* Update all parameters for rebuild

* Ensure value updates alongside initial_value

* Update multi_model_identification

* Update spm_electrode_design.ipynb

* Fix test_plots design problem

* Move Changelog entry to breaking changes

* Add tests

* Update integration tests

* Update spm_weighted_cost.py

* Fix tests

* Fix model type check

* Update _parameter_set to parameter_set

* Update tests with parameter set

* Add model build description

* Revert to _parameter_set

* Apply suggestions from code review

Co-authored-by: Brady Planden <55357039+BradyPlanden@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Brady Planden <55357039+BradyPlanden@users.noreply.github.com>

* Fix syntax

* Fix variable name

* Update model type check

* Update parameter_set setter

* Add parameters.reset_initial_value

* Add n_outputs property

* Remove public parameter_set setter

* Correct integer to float

* Convert initial_state to dict

* Add guidance

* Remove empty dictionary defaults

* Add warning stacklevels

* Catch simulation errors in problem evaluation

* Add pybamm version comment

* Add set initial ocv check

* Add model.clear and remove setters

* Update unscented_kalman.py

* Update test_models.py

* Update test_set_initial_state

---------

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

Compute initial concentrations from initial OCV
3 participants