-
Notifications
You must be signed in to change notification settings - Fork 24
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
Conversation
Codecov ReportAttention: Patch coverage is
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. |
TODO: Re-run all notebooks after #428 and check output. |
There was a problem hiding this 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.
There was a problem hiding this 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!
…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>
Description
Remove the
init_soc
option from BaseProblem, keep theinit_soc
option for DesignProblem and replace it with aninit_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:
Type of change
Key checklist:
$ 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)$ nox -s tests
$ nox -s doctest
You can run integration tests, unit tests, and doctests together at once, using
$ nox -s quick
.Further checks:
Thank you for contributing to our project! Your efforts help us to deliver great software.