Skip to content

Rename cathode and anode - #1337

Merged
brosaplanella merged 17 commits into
pybamm-team:developfrom
brosaplanella:issue-1333-rename-cathode-anode
Jan 27, 2021
Merged

Rename cathode and anode#1337
brosaplanella merged 17 commits into
pybamm-team:developfrom
brosaplanella:issue-1333-rename-cathode-anode

Conversation

@brosaplanella

@brosaplanella brosaplanella commented Jan 23, 2021

Copy link
Copy Markdown
Member

Description

Notation has been homogenised to use positive and negative electrode (instead of cathode and anode). This applies to the options in the cracking model and lost of active material and the parameter folders.

Fixes #1333

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.

  • 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:

  • No style issues: $ flake8
  • All tests pass: $ python run-tests.py --unit
  • The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

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

@brosaplanella brosaplanella changed the title Rename cathode anode anode Rename cathode andanode Jan 23, 2021
@brosaplanella brosaplanella changed the title Rename cathode andanode Rename cathode and anode Jan 23, 2021
@codecov

codecov Bot commented Jan 23, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1337 (1a8b373) into develop (57ab11d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1337   +/-   ##
========================================
  Coverage    98.14%   98.15%           
========================================
  Files          272      272           
  Lines        15561    15572   +11     
========================================
+ Hits         15273    15284   +11     
  Misses         288      288           
Impacted Files Coverage Δ
...er2019/lead_exchange_current_density_Sulzer2019.py 100.00% <ø> (ø)
...ve_electrodes/lead_Sulzer2019/lead_ocp_Bode1977.py 100.00% <ø> (ø)
...ead_dioxide_exchange_current_density_Sulzer2019.py 100.00% <ø> (ø)
...ad_dioxide_Sulzer2019/lead_dioxide_ocp_Bode1977.py 100.00% <ø> (ø)
...2019/oxygen_exchange_current_density_Sulzer2019.py 100.00% <ø> (ø)
...s/graphite_Ai2020/graphite_cracking_rate_Ai2020.py 100.00% <ø> (ø)
...aphite_Ai2020/graphite_diffusivity_Dualfoil1998.py 100.00% <ø> (ø)
...i2020/graphite_entropy_Enertech_Ai2020_function.py 100.00% <ø> (ø)
...s/graphite_Ai2020/graphite_volume_change_Ai2020.py 100.00% <ø> (ø)
...0_electrolyte_exchange_current_density_Chen2020.py 100.00% <ø> (ø)
... and 42 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 57ab11d...1a8b373. Read the comment docs.

@valentinsulzer valentinsulzer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should discuss in the meeting that this is not too much of a breaking change. But the changes themselves are all good

Comment thread pybamm/parameters/parameter_values.py

@valentinsulzer valentinsulzer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good, just a suggestion for an extra error check

Comment thread examples/notebooks/parameter-management.ipynb
Comment thread pybamm/parameters/parameter_values.py Outdated
if "sei" in chemistry:
component_groups += ["sei"]

if "anode" in chemistry.keys():

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@tinosulzer @tlestang here are the warnings/errors you suggested, in case you want to take a look. Otherwise, let me know and I will merge the branch.

@brosaplanella
brosaplanella merged commit 2d179f0 into pybamm-team:develop Jan 27, 2021
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.

Remove cathode and anode notation

2 participants