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

Basic lead acid model #932

Merged
merged 9 commits into from
Apr 7, 2020
Merged

Basic lead acid model #932

merged 9 commits into from
Apr 7, 2020

Conversation

valentinsulzer
Copy link
Member

Description

Add basic lead-acid model (with convection)

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 2, 2020

Codecov Report

Merging #932 into develop will increase coverage by 0.05%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #932      +/-   ##
===========================================
+ Coverage    98.09%   98.14%   +0.05%     
===========================================
  Files          222      223       +1     
  Lines        11176    11594     +418     
===========================================
+ Hits         10963    11379     +416     
- Misses         213      215       +2     
Impacted Files Coverage Δ
...l_battery_models/lead_acid/base_lead_acid_model.py 100.00% <ø> (ø)
...ybamm/models/full_battery_models/lead_acid/full.py 100.00% <ø> (ø)
...m/models/full_battery_models/lead_acid/__init__.py 100.00% <100.00%> (ø)
...models/full_battery_models/lead_acid/basic_full.py 100.00% <100.00%> (ø)
pybamm/parameters/standard_parameters_lead_acid.py 98.97% <0.00%> (-0.31%) ⬇️
pybamm/solvers/base_solver.py 99.72% <0.00%> (-0.01%) ⬇️
pybamm/parameters/thermal_parameters.py 100.00% <0.00%> (ø)
...bamm/parameters/standard_parameters_lithium_ion.py 100.00% <0.00%> (ø)
...on/cathodes/nca_Kim2011/nca_diffusivity_Kim2011.py 100.00% <0.00%> (ø)
...s/graphite_Kim2011/graphite_diffusivity_Kim2011.py 100.00% <0.00%> (ø)
... and 27 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 96e7811...6e29970. Read the comment docs.

Copy link
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 Tino, thanks! Just two minor comments with the references that might be typos.


References
----------
.. [2] V Sulzer, SJ Chapman, CP Please, DA Howey, and CW Monroe. Faster lead-acid
Copy link
Member

Choose a reason for hiding this comment

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

Minor typo: should the reference be [1]?

Copy link
Member Author

Choose a reason for hiding this comment

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

It has to be a different number because "full" and "basicfull" are in the same doc file and sphinx doesn't like it if the same ref number is used twice

@@ -6,7 +6,7 @@


class Full(BaseModel):
"""Porous electrode model for lead-acid, from [1]_, based on the Full
"""Porous electrode model for lead-acid, from [1]_, based on the Newman-Tiedemann
Copy link
Member

Choose a reason for hiding this comment

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

Minor typo: should the underscore be removed?

Copy link
Member Author

Choose a reason for hiding this comment

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

this is for sphinx cross-ref

Copy link
Contributor

@TomTranter TomTranter left a comment

Choose a reason for hiding this comment

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

All looks good to me - thanks

@valentinsulzer valentinsulzer merged commit eae95f8 into develop Apr 7, 2020
@valentinsulzer valentinsulzer deleted the basic-lead_acid branch April 7, 2020 20:46
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.

3 participants