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

Composite release parameters #2248

Merged
merged 75 commits into from
Aug 24, 2022
Merged

Conversation

valentinsulzer
Copy link
Member

Description

Some changes in preparation for the composite release.

  • introduces phase dependency (the "phase_name" in a lot of the variable names, which is empty by default and primary/secondary if there are multiple phases)
  • introduces the "particle phases" option

No silicon parameters are added, this PR just tests with a two phase graphite/graphite system

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

@valentinsulzer valentinsulzer changed the base branch from develop to variable-renaming-for-composite-release August 18, 2022 16:13
@valentinsulzer valentinsulzer changed the base branch from variable-renaming-for-composite-release to develop August 19, 2022 00:05
@codecov
Copy link

codecov bot commented Aug 19, 2022

Codecov Report

Merging #2248 (0c4b972) into develop (1472d97) will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           develop    #2248      +/-   ##
===========================================
+ Coverage    99.36%   99.38%   +0.01%     
===========================================
  Files          357      359       +2     
  Lines        19514    19821     +307     
===========================================
+ Hits         19391    19699     +308     
+ Misses         123      122       -1     
Impacted Files Coverage Δ
...bamm/models/full_battery_models/lithium_ion/mpm.py 100.00% <ø> (ø)
...els/submodels/interface/lithium_plating/plating.py 100.00% <ø> (ø)
pybamm/expression_tree/averages.py 100.00% <100.00%> (ø)
pybamm/expression_tree/broadcasts.py 100.00% <100.00%> (ø)
pybamm/expression_tree/independent_variable.py 100.00% <100.00%> (ø)
pybamm/expression_tree/parameter.py 100.00% <100.00%> (ø)
pybamm/expression_tree/printing/print_name.py 100.00% <100.00%> (ø)
pybamm/geometry/battery_geometry.py 100.00% <100.00%> (ø)
pybamm/geometry/standard_spatial_vars.py 100.00% <100.00%> (ø)
...m/models/full_battery_models/base_battery_model.py 99.78% <100.00%> (+0.02%) ⬆️
... and 67 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? 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 great, thanks @tinosulzer! Just a few minor questions and comments

@valentinsulzer valentinsulzer merged commit 4a8a221 into develop Aug 24, 2022
@valentinsulzer valentinsulzer deleted the composite-release-parameters branch August 24, 2022 07:07
@brosaplanella brosaplanella mentioned this pull request Sep 5, 2022
8 tasks
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