Skip to content

add BatchStudy class - #1455

Merged
valentinsulzer merged 14 commits into
pybamm-team:developfrom
actualpriyanshu:comparison-class
Apr 9, 2021
Merged

add BatchStudy class#1455
valentinsulzer merged 14 commits into
pybamm-team:developfrom
actualpriyanshu:comparison-class

Conversation

@actualpriyanshu

@actualpriyanshu actualpriyanshu commented Apr 2, 2021

Copy link
Copy Markdown
Member

Description

Add class to compare different models and conditions

Fixes #906

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

@actualpriyanshu

Copy link
Copy Markdown
Member Author

What does solver_stats and export_data do?

Could you please check it? You can run this code here
https://colab.research.google.com/drive/109KJSumPxzxi3OToN6N8g6wjuD5Yb2oe?usp=sharing

@valentinsulzer valentinsulzer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @priyanshuone6 , on the right track. See comments, and needs a unit test

Comment thread pybamm/batch_study.py Outdated
Comment thread pybamm/batch_study.py Outdated
Comment thread pybamm/batch_study.py Outdated
Comment thread pybamm/batch_study.py Outdated
@actualpriyanshu

Copy link
Copy Markdown
Member Author

Thanks @tinosulzer
I am working on the unit tests, will add them soon. I have also fixed few other things I found and pushed them in the same PR rather than making a new one, hope you don't mind 😃

@codecov

codecov Bot commented Apr 4, 2021

Copy link
Copy Markdown

Codecov Report

Merging #1455 (6529de7) into develop (4205951) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 6529de7 differs from pull request most recent head 7edf780. Consider uploading reports for the commit 7edf780 to get more accurate results
Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1455   +/-   ##
========================================
  Coverage    98.34%   98.34%           
========================================
  Files          281      282    +1     
  Lines        16516    16563   +47     
========================================
+ Hits         16242    16289   +47     
  Misses         274      274           
Impacted Files Coverage Δ
...m/models/full_battery_models/base_battery_model.py 99.67% <ø> (ø)
pybamm/__init__.py 94.95% <100.00%> (+0.04%) ⬆️
pybamm/batch_study.py 100.00% <100.00%> (ø)

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 4205951...7edf780. Read the comment docs.

@valentinsulzer valentinsulzer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks @priyanshuone6 , can you just add the other options for the Simulation? parameter_values, var_pts, etc
Also add the options for solve

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

Comparison class

2 participants