alexander/intro-to-python
1
1
Fork 0
Code Issues Pull requests Releases Activity

Add notes for instructors

Browse source 
- use jupyter notebook and not jupyter lab
- do not use RISE with Collabsible Headings extension
This commit is contained in:
Alexander Hess 2020-02-02 17:24:06 +01:00
parent d372b4d589
commit 2f5ee9a8da
1 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -181,13 +181,6 @@ if you have poetry installed, you may just type `poetry install` instead).
- `python -m pip install -r requirements.txt`
The *requirements.txt* file also installs the [black](https://github.com/psf/black)
tool (incl. the [blackcellmagic](https://github.com/csurfer/blackcellmagic)
extension) and the [RISE](https://github.com/damianavila/RISE) extension.
With them, the instructor can easily re-format code in a class session and
execute code in presentation mode (currently RISE only works with the
older `jupyter notebook` command).
With everything installed, you can now do the equivalent of clicking the
"JupyterLab" entry in the Anaconda Navigator.
@ -196,6 +189,33 @@ With everything installed, you can now do the equivalent of clicking the
This opens a new tab in your web browser just as above.
#### Interactive Presentation Mode & Live Coding
The *requirements.txt* file also installs the [nbextensions](https://github.com/ipython-contrib/jupyter_contrib_nbextensions)
for Jupyter notebooks, the [black](https://github.com/psf/black) code
formatting tool (incl. the [blackcellmagic](https://github.com/csurfer/blackcellmagic)
Jupyter extension) and the [RISE](https://github.com/damianavila/RISE) Jupyter
extension.
With them, the instructor can easily re-format code in a class session and
execute code in presentation mode.
**Note**: Currently, the RISE extension *only* works with the older
notebook command.
- `jupyter notebook` (so, `jupyter lab` may *not* be used).
After installing the dependencies, the instructor must copy the extensions'
JavaScript and CSS files into Jupyter's search directory.
- `jupyter contrib nbextension install --user`
Now, the instructor can enable/disable the various Jupyter notebook
extensions.
**Note**: The extension "Collapsible Headings" may interfere with the
RISE presentation if hotkeys are enabled.
## About the Author
Alexander Hess is a PhD student at the Chair of Logistics Management at the