Rename MSMR parameters from symbols to plain English names with units
#5027
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5027 +/- ##
========================================
Coverage 98.57% 98.58%
========================================
Files 304 304
Lines 23661 23689 +28
========================================
+ Hits 23325 23353 +28
Misses 336 336 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The MSMR parameter names used symbols instead of following the standard pybamm convention of having a fully spelled-out name. This PR standardizes the MSMR parameter names in a non-breaking way, following the renaming of
"electrode diffusivity"to"particle diffusivity"in #3624Examples:
"X_n_5"->"Negative electrode host site occupancy fraction (5)""X_p_l_3"->"Positive electrode host site occupancy fraction (lithiation) (3)""X_n_d_5"->"Negative electrode host site occupancy fraction (delithiation) (5)""Q_p_3"->"Positive electrode host site occupancy capacity (3) [A.h]""w_n_2"->"Negative electrode host site ideality factor (2)""U0_p_d_4"->"Positive electrode host site standard potential (delithiation) (4) [V]""a_p_d_5"->"Positive electrode host site charge transfer coefficient (delithiation) (5)""j0_ref_n_0"->"Negative electrode host site reference exchange-current density (0) [A.m-2]"Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #)
Important checks:
Please confirm the following before marking the PR as ready for review:
nox -s pre-commitnox -s testsnox -s doctests