Skip to content

Add BatchStudy examples #1747

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

Merged

Conversation

Saransh-cpp
Copy link
Member

@Saransh-cpp Saransh-cpp commented Oct 15, 2021

Description

Added an example notebook describing pybamm.BatchStudy. The notebook compares models, parameter values, and summary variables. Please let me know if there are some other interesting comparisons that I should add in here.

Fixes #1492
Fixes #1745

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 Oct 15, 2021

Codecov Report

Merging #1747 (da05ff8) into develop (9b5d303) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1747   +/-   ##
========================================
  Coverage    99.28%   99.28%           
========================================
  Files          343      343           
  Lines        18864    18868    +4     
========================================
+ Hits         18729    18733    +4     
  Misses         135      135           
Impacted Files Coverage Δ
pybamm/plotting/quick_plot.py 99.71% <100.00%> (+<0.01%) ⬆️

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 9b5d303...da05ff8. Read the comment docs.

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.

Awesome, thanks! I think you can also do the quick fix for #1745 ?

@Saransh-cpp
Copy link
Member Author

Saransh-cpp commented Oct 15, 2021

Awesome, thanks! I think you can also do the quick fix for #1745 ?

Yes, should I add a "breaking change" for renaming solutions to input_solutions?

@valentinsulzer
Copy link
Member

Yes, should I add a "breaking change" for renaming solutions to input_solutions?
solutions doesn't need to be renamed to input_solutions, as far as the user is concerned nothing is changing. If you do

input_solutions = solutions
solutions = []

then input_solutions will still be the original solutions and solutions will become []

@valentinsulzer
Copy link
Member

thanks for fixing my mess haha

@valentinsulzer valentinsulzer merged commit 4ece786 into pybamm-team:develop Oct 21, 2021
@Saransh-cpp Saransh-cpp deleted the issue-1492-BatchStudy-examples branch October 23, 2021 07:39
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.

Running plot method of BatchStudy replaces self.sims's elements with pybamm.Solution objects BatchStudy example
2 participants