Environment to build jupyter RISE slides

In this repo, you find a RISE template consisting of

• two columns
• lists
• manim animation
• fragments
• subslides
• notes
• hidden input cells
• highlights

Please find more slide examples at my lecture notes repo

Starting with Vagrant

Initialization

Build virtual machine

vagrant up

Take snapshot of the virtual machine

vagrant snapshot save jupyter

Start of the Session

vagrant snapshot restore jupyter

• point your browser to http://localhost:8000/ or http://localhost:8000/notebooks/Template.ipynb for a slide template to get started

End of the Session

vagrant halt

Reprovision (In case something went wrong)

vagrant provision

Starting with Docker

This repo includes a Dockerfile, wich builds the image to run jupyter notebook with all slide extensions described earlier. Additionally, it contains a docker-compose.yml file, which allows easy starting and stopping of the container.

Prerequisites

1. Docker needs to be installed and running
2. Docker-Compose needs to be installed, if it is not shipped with the Docker install.
3. The host machine needs to have an open port on 8000 for accessing the jupyter notebook interface in a browser. If the port is not available, you can change it in the docker-compose.yml file.

Starting

You need to start a terminal with RISE-Environment as the current working directory. The first startup can take some time, since the image needs to be built first. Afterwards, each startup should take less than 10 seconds. To start the application simply run:

docker-compose up -d

Stopping

To stop the application simply run:

docker-compose stop

The current state of the notebook will be automatically persisted in the notebooks folder of this repository.

Removal of the image

To remove the image completely from the disk, simply run:

docker-compose down