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

Issue 658 experiment #807

Merged
merged 37 commits into from
Feb 10, 2020
Merged

Issue 658 experiment #807

merged 37 commits into from
Feb 10, 2020

Conversation

valentinsulzer
Copy link
Member

Description

Added experiment class and integration with the simulation class
Fixes #658

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

@valentinsulzer valentinsulzer changed the base branch from master to 2plus1D-paper-plots February 6, 2020 04:38
@valentinsulzer valentinsulzer changed the base branch from 2plus1D-paper-plots to master February 6, 2020 04:38
@codecov
Copy link

codecov bot commented Feb 6, 2020

Codecov Report

Merging #807 into master will increase coverage by <.01%.
The diff coverage is 97.2%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #807      +/-   ##
==========================================
+ Coverage    98.2%   98.21%   +<.01%     
==========================================
  Files         180      181       +1     
  Lines       10110    10405     +295     
==========================================
+ Hits         9929    10219     +290     
- Misses        181      186       +5
Impacted Files Coverage Δ
pybamm/expression_tree/binary_operators.py 93.41% <ø> (ø) ⬆️
pybamm/parameters/parameter_values.py 100% <100%> (ø) ⬆️
pybamm/solvers/casadi_solver.py 100% <100%> (ø) ⬆️
...m/models/full_battery_models/base_battery_model.py 100% <100%> (ø) ⬆️
pybamm/solvers/idaklu_solver.py 89.21% <100%> (ø) ⬆️
...ubmodels/electrolyte/base_electrolyte_diffusion.py 100% <100%> (ø) ⬆️
pybamm/solvers/scikits_ode_solver.py 85.48% <100%> (ø) ⬆️
pybamm/models/submodels/base_submodel.py 92.64% <100%> (ø) ⬆️
pybamm/models/submodels/particle/base_particle.py 97.43% <100%> (+0.13%) ⬆️
...odels/full_battery_models/lithium_ion/basic_dfn.py 100% <100%> (ø) ⬆️
... and 24 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 3c6dda7...0a3517f. Read the comment docs.

Copy link
Contributor

@rtimms rtimms left a comment

Choose a reason for hiding this comment

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

this looks great thanks @tinosulzer ! very user-friendly input for the experiments. it might be good if we could add some documentation detailing the structure of the strings and explicitly highlighting the different keywords that can be used

pybamm/experiments/experiment.py Show resolved Hide resolved
pybamm/simulation.py Outdated Show resolved Hide resolved
pybamm/simulation.py Show resolved Hide resolved
pybamm/simulation.py Outdated Show resolved Hide resolved
pybamm/solvers/solution.py Outdated Show resolved Hide resolved
tests/unit/test_experiments/test_experiment.py Outdated Show resolved Hide resolved
@valentinsulzer valentinsulzer merged commit d3f8268 into master Feb 10, 2020
@valentinsulzer valentinsulzer deleted the issue-658-experiment branch February 10, 2020 23:58
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.

Add an Experiment class
2 participants