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

#1084 allow kwargs to be passed to sim.plot #1099

Merged
merged 4 commits into from
Jul 8, 2020

Conversation

rtimms
Copy link
Contributor

@rtimms rtimms commented Jul 6, 2020

Description

Allows users to pass keyword arguments to Simulation.plot(). For a full list of possible keyword arguments see QuickPlot.

Also renames quick_plot_vars to output_variables in Simulation to be consistent with QuickPlot

Fixes #1084

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 Jul 6, 2020

Codecov Report

Merging #1099 into develop will increase coverage by 0.07%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1099      +/-   ##
===========================================
+ Coverage    97.76%   97.83%   +0.07%     
===========================================
  Files          243      245       +2     
  Lines        12667    13372     +705     
===========================================
+ Hits         12384    13083     +699     
- Misses         283      289       +6     
Impacted Files Coverage Δ
pybamm/simulation.py 96.81% <100.00%> (+0.02%) ⬆️
pybamm/solvers/base_solver.py 100.00% <0.00%> (ø)
pybamm/solvers/jax_bdf_solver.py 99.39% <0.00%> (ø)
pybamm/solvers/jax_solver.py 96.42% <0.00%> (ø)
pybamm/expression_tree/binary_operators.py 95.23% <0.00%> (+0.28%) ⬆️
pybamm/expression_tree/operations/evaluate.py 97.22% <0.00%> (+1.38%) ⬆️

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 56c0383...a83b2fb. 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.

Thanks @rtimms , just a comment about deprecation (maybe also add to the changelog)

**kwargs
Additional keyword arguments passed to
:meth:`pybamm.QuickPlot.dynamic_plot`.
For a list of all possible keyword arguments see :class:`pybamm.QuickPlot`.
Copy link
Member

Choose a reason for hiding this comment

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

this should still accept quick_plot_vars and raise an error if this is not None, saying to use output_variables instead

@rtimms rtimms merged commit b2488ce into develop Jul 8, 2020
@rtimms rtimms deleted the issue-1084-kwargs-sim-plot branch July 8, 2020 09:41
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.

pass keyword args to sim.plot()
2 participants