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

Rename "positive electrode diffusivity" to "positive particle diffusivity" #3624

Merged
merged 16 commits into from
Jan 27, 2024

Conversation

julian-evers
Copy link
Contributor

Description

The "electrode diffusivity" parameter have been renamed to "particle diffusivity". parameter_values["Positive electrode diffusivity"] returns "Positive particle diffusivity" with a deprecation warning.

Fixes #3229

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.

  • [ x] New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • [ x] 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)
  • [ x] All tests pass: $ python run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ 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:

  • Code is commented, particularly in hard-to-understand areas
  • [ x] Tests added that prove fix is effective or that feature works

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link

codecov bot commented Dec 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (3f504b8) 99.59% compared to head (c8261ab) 99.59%.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3624   +/-   ##
========================================
  Coverage    99.59%   99.59%           
========================================
  Files          257      257           
  Lines        20796    20802    +6     
========================================
+ Hits         20712    20718    +6     
  Misses          84       84           

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

Copy link
Sponsor Member

@brosaplanella brosaplanella 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 to me, just a small comment on the CHANGELOG. You should probably add a line in the breaking changes too.

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kratman kratman left a comment

Choose a reason for hiding this comment

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

Duplicate change log entry

CHANGELOG.md Outdated Show resolved Hide resolved
@kratman kratman merged commit f23c3d4 into pybamm-team:develop Jan 27, 2024
40 of 41 checks passed
kratman added a commit that referenced this pull request May 22, 2024
* removes breaking change from electrode diffusivity -> particle diffusivity

* Add conditional entry for base_solver inputs recreation

* fix: incorrect depreciated parameter translation, moves conversion to ParameterValues staticmethod

Fixes an incorrect conversion of electrode diffusivity to particle diffusivity,
Updates the corresponding test to ensure FuzzyDict.__getitem__ functions correctly,
Adds conversion and checks to BaseSolver inputs object,

* Add changelog entry

---------

Co-authored-by: Eric G. Kratz <kratman@users.noreply.github.com>
js1tr3 pushed a commit to js1tr3/PyBaMM that referenced this pull request Aug 12, 2024
…vity" (pybamm-team#3624)

* merge_conflicts

* merge_conflicts_

* update_pr_number

* rename_empirical_hysteresis

* style: pre-commit fixes

* style: pre-commit fixes

* update changelog

* fix bpx

* style: pre-commit fixes

* update changelog

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Ferran Brosa Planella <Ferran.Brosa-Planella@warwick.ac.uk>
js1tr3 pushed a commit to js1tr3/PyBaMM that referenced this pull request Aug 12, 2024
* removes breaking change from electrode diffusivity -> particle diffusivity

* Add conditional entry for base_solver inputs recreation

* fix: incorrect depreciated parameter translation, moves conversion to ParameterValues staticmethod

Fixes an incorrect conversion of electrode diffusivity to particle diffusivity,
Updates the corresponding test to ensure FuzzyDict.__getitem__ functions correctly,
Adds conversion and checks to BaseSolver inputs object,

* Add changelog entry

---------

Co-authored-by: Eric G. Kratz <kratman@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.

Rename "positive electrode diffusivity" to "positive particle diffusivity"?
4 participants