-
-
Notifications
You must be signed in to change notification settings - Fork 563
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
Fixes #4176 electrode diffusivity rename #4179
Fixes #4176 electrode diffusivity rename #4179
Conversation
…. check_parameter_values to rename depreciated key
…' without destroying 'electrode diffusivity', updts tests to verify functionality
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #4179 +/- ##
========================================
Coverage 99.58% 99.58%
========================================
Files 288 288
Lines 21799 21800 +1
========================================
+ Hits 21708 21709 +1
Misses 91 91 ☔ View full report in Codecov by Sentry. |
Hi @ejfdickinson, would be able to try these changes out? Also, thanks for flagging this at a reasonable time before the release and thank you @BradyPlanden for taking it! |
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.
Just one nitpicky typo suggestion – I don't understand the BPX code enough so I will leave it to someone else to approve but the rest of the changes look good to me, thanks!
@agriyakhetarpal @BradyPlanden The test I made is passing with these changes, so seems ok to me. Note also typoes in the changelog! |
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 to me, especially if it fixes @ejfdickinson example.
Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]>
* fix: revert logic change for failing 'particle diffusivity' key, updt. check_parameter_values to rename depreciated key * fix: removes bpx remapping requirement, creates 'particle diffusivity' without destroying 'electrode diffusivity', updts tests to verify functionality * Add changelog * Apply suggestions from code review Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]> --------- Co-authored-by: Ferran Brosa Planella <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]>
Description
Fixes #4176. In addition to this issue, in the
develop
implementation changes toelectrode diffusivity
viaparameter_values.update()
will not be captured. To account for this, the I've taken the depreciated key and appended the new key into parameter_set dictionary in the event that the depreciated parameter is supplied. This also cleans up thebpx.py
implementation since the logic for changing the key is moved into the parameters class.Fixes # (issue)
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
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)$ python run-tests.py --all
(or$ nox -s tests
)$ python run-tests.py --doctest
(or$ nox -s doctests
)You can run integration tests, unit tests, and doctests together at once, using
$ python run-tests.py --quick
(or$ nox -s quick
).Further checks: