Public Repository

Last pushed: 2 years ago
Short Description
Template for creating a web + jupyter server in a container - aimed at using Kinematic for teaching
Full Description

Docker container with static website / jupyter notebook server

This is a collection of tools to set up a web server in a docker container that mixes static html content and dynamic "literate-programming" content via jupyter notebooks.

Introduction

Jupyter notebooks blend well-formatted documentation with executable programming content. Notebooks not only provide a development environment for exploring new algorithms and implementation, they are an excellent way to introduce new software concepts through live demonstrations and example code.

Docker is a mechanism for deploying complex software stacks as lightweight "apps" and managing software dependencies in a consistent, reproducible manner. Docker guarantees the user experience will be identical to that shipped by the developer and eliminates installation inconsistencies.

These characteristics of Docker allow us to create complex software bundles and focus on the explanation of how they work, demonstrate the in-built algorithms, and provide tutorials that can be reused on new problems. We think this opens many doors for teaching basic computational methods as well as documenting technical software.

Under Windows and Macintosh, you can use the Kitematic gui to locate, download and run docker images.

What have we here ?

This is a demonstration of how to bundle python software into a Docker image and provide a simple user interface in the form of a static website and live jupyter notebooks.

The web pages are built from a simple script that converts a small collection of markdown files (which is also used in the notebooks to format content) into web pages via templates. These templates make it easier to modify the content without damaging the pieces that interact with the jupyter notebook server.

It should be possible to navigate freely between the web content and the live notebooks.

What is this for ?

You can fork this project on github and use it to build your own docker image. I think you can use this template to make live manuals and courses for interactive content - especially when you need to control the installation and ensure a uniform environment for your users. In the classroom, perhaps, where you only need to install docker itself and then you can be sure your students will all see the same thing !

Another use for this project is as a mechanism for distributing code for review, snapshot a version of your code to distribute as part of a publication, or for the purposes of benchmarking.

Getting help

I can't promise much help, but you can contact me by email

Credits

I based the web template on the elegant and simple 'Leap-Day' theme by Matt Graham with just minor changes to keep the presentation very low key for a teaching environment.

Docker Pull Command
Owner
lmoresi

Comments (0)