Issue 694 getting started notebooks #703
Conversation
Scottmar93
requested review from
valentinsulzer,
rtimms,
brosaplanella and
jedgedrudd
Codecov Report
@@ Coverage Diff @@
## master #703 +/- ##
==========================================
+ Coverage 98.15% 98.18% +0.02%
==========================================
Files 175 175
Lines 9264 9288 +24
==========================================
+ Hits 9093 9119 +26
+ Misses 171 169 -2
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Cheers @Scottmar93 , this is super clear. A few comments for helping to point users in the right direction:
- add links to previous and next tutorial within each tutorial
- update examples/notebooks/readme to point to the right files
- maybe add a link to this in the main readme
Also, coverage has gone down a lot in the last few PRs so it would be good to stay on top of that - this is definitely worth the upstream time investment
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "Welcome to PyBaMM! In this notebook, we will run your first PyBaMM model in just a few simple lines. We begin by importing the pybamm library into this notebook:" |
There was a problem hiding this comment.
Might also be a good idea to explain how jupyter notebooks work. e.g. refer to this cheat sheet https://www.cheatography.com/weidadeyue/cheat-sheets/jupyter-notebook/pdf_bw/ and say just do shift-enter to run cells
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 2 | ||
| } |
There was a problem hiding this comment.
refer to readthedocs for more detail?
| ], | ||
| "source": [ | ||
| "quick_plot_vars = [\"Terminal voltage [V]\"]\n", | ||
| "sim.plot(quick_plot_vars=quick_plot_vars)" |
There was a problem hiding this comment.
could do with more points here
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 2 | ||
| } |
There was a problem hiding this comment.
I got an extra cell here "type markdown and latex"
pybamm/simulation.py
Outdated
| t=widgets.FloatSlider(min=0, max=plot.max_t, step=0.05, value=0), | ||
| ) | ||
| else: | ||
| plot.dynamic_plot() |
There was a problem hiding this comment.
nice! I wonder if you could do something similar within quickplot itself
Description
Added a few simple "getting started" notebooks. We should probably iterate so that they are as clear and simple as possible and also decide what other ones should be added.
Fixes #694
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.
Key checklist:
$ flake8$ python run-tests.py --unit$ cd docsand then$ make clean; make htmlYou can run all three at once, using
$ python run-tests.py --quick.Further checks: