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 lead-acid and lithium-ion #1464

Merged
merged 1 commit into from
Apr 28, 2021

Conversation

priyanshuone6
Copy link
Member

@priyanshuone6 priyanshuone6 commented Apr 23, 2021

Description

Renamed lead-acid to lead_acid and lithium-ion to lithium_ion as discussed over slack.
Add warnings and tests

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

@codecov
Copy link

codecov bot commented Apr 24, 2021

Codecov Report

Merging #1464 (d413205) into develop (3001577) will increase coverage by 0.00%.
The diff coverage is 83.33%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1464   +/-   ##
========================================
  Coverage    98.37%   98.37%           
========================================
  Files          282      282           
  Lines        16593    16602    +9     
========================================
+ Hits         16323    16332    +9     
  Misses         270      270           
Impacted Files Coverage Δ
...es/sulfuric_acid_Sulzer2019/conductivity_Gu1997.py 100.00% <ø> (ø)
...zer2019/darken_thermodynamic_factor_Chapman1968.py 100.00% <ø> (ø)
...tes/sulfuric_acid_Sulzer2019/diffusivity_Gu1997.py 100.00% <ø> (ø)
.../sulfuric_acid_Sulzer2019/viscosity_Chapman1968.py 100.00% <ø> (ø)
...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% <ø> (ø)
...6_Mohtat2020/electrolyte_conductivity_PeymanMPM.py 100.00% <ø> (ø)
... and 68 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 3001577...d413205. Read the comment docs.

@priyanshuone6
Copy link
Member Author

I guess I have renamed everything, @tinosulzer @rtimms could you please review it, thanks!

Copy link
Member

@valentinsulzer valentinsulzer left a comment

Choose a reason for hiding this comment

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

@@ -104,6 +104,9 @@ KLU_module_deps
# setup
setup.log

# test
test.c
Copy link
Member

Choose a reason for hiding this comment

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

why was this added?

Copy link
Member Author

@priyanshuone6 priyanshuone6 Apr 25, 2021

Choose a reason for hiding this comment

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

@tinosulzer This file is generated every time someone runs the run-tests.py, so I thought to put it in the gitignore as it is only used locally and should not be pushed. Should I undo this?

Copy link
Member

Choose a reason for hiding this comment

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

ok, no problem that's fine

@valentinsulzer valentinsulzer merged commit be327ab into pybamm-team:develop Apr 28, 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.

2 participants