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

remove FOQS and Composite lead-acid models #2431

Merged
merged 10 commits into from
Nov 7, 2022

Conversation

valentinsulzer
Copy link
Member

Description

I don't think anyone is using these models, and they aren't much faster than the full model anyway. They are very different from the other models which makes them hard to maintain / large technical debt.

Let me know if you don't want these models removed (or you find this PR in future and want them added back in)

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

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Nov 5, 2022

Codecov Report

Base: 99.71% // Head: 99.72% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (5474f6e) compared to base (2b882d2).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #2431      +/-   ##
===========================================
+ Coverage    99.71%   99.72%   +0.01%     
===========================================
  Files          267      258       -9     
  Lines        20044    19498     -546     
===========================================
- Hits         19987    19445     -542     
+ Misses          57       53       -4     
Impacted Files Coverage Δ
pybamm/models/base_model.py 98.52% <ø> (ø)
...m/models/full_battery_models/lead_acid/__init__.py 100.00% <ø> (ø)
...ybamm/models/full_battery_models/lead_acid/loqs.py 100.00% <ø> (ø)
...bamm/models/full_battery_models/lithium_ion/dfn.py 100.00% <ø> (ø)
...bamm/models/full_battery_models/lithium_ion/spm.py 100.00% <ø> (ø)
...amm/models/full_battery_models/lithium_ion/spme.py 100.00% <ø> (ø)
...amm/models/submodels/current_collector/__init__.py 100.00% <ø> (ø)
...current_collector/homogeneous_current_collector.py 100.00% <ø> (ø)
...dels/submodels/current_collector/potential_pair.py 100.00% <ø> (ø)
...models/submodels/electrolyte_diffusion/__init__.py 100.00% <ø> (ø)
... and 25 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

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, thanks!

@@ -1,5 +1,9 @@
# [Unreleased](https://github.com/pybamm-team/PyBaMM/)

## Breaking changes

Copy link
Sponsor Member

Choose a reason for hiding this comment

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

I just realised that I placed the asymmetric SEI line of the CHANGELOG in the 22.10 release. Can you move it to the unreleased? Sorry!

Copy link
Member Author

Choose a reason for hiding this comment

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

will do it in the other PR which needs a changelog

@valentinsulzer valentinsulzer merged commit cf86a39 into develop Nov 7, 2022
@valentinsulzer valentinsulzer deleted the remove-first-order-lead-acid branch November 7, 2022 12:56
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.

None yet

2 participants