From 2f5ee9a8da6ac636ce8be79dbf0d044b58df2cb6 Mon Sep 17 00:00:00 2001 From: Alexander Hess Date: Sun, 2 Feb 2020 17:24:06 +0100 Subject: [PATCH] Add notes for instructors - use jupyter notebook and not jupyter lab - do not use RISE with Collabsible Headings extension --- README.md | 34 +++++++++++++++++++++++++++------- 1 file changed, 27 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b6b1b9d..e64527c 100644 --- a/README.md +++ b/README.md @@ -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