korniichuk/scipy-k3d-notebook

The scipy-k3d-notebook stack of ready-to-run "Jupyter Notebook Scientific Python with K3D" application in Docker

Table of contents

• Full description
• Docker Hub
• Quickstart
• User guide
  • Detached
  • Ports
  • Users
  • Interactive processes
• Own try.jupyter.org

Full description

The korniichuk/scipy-notebook Docker image with K3D.

Docker Hub

The korniichuk/scipy-k3d-notebook repo.

Quickstart

The following command starts a container with the Notebook server listening for HTTP connections on port 8888 without authentication configured:

$ docker run -d -p 8888:8888 -u root korniichuk/scipy-k3d-notebook

User guide

Detached

To start a container in detached mode, you use -d or --detach option. By design, containers started in detached mode exit when the root process used to run the container exits. A container in detached mode cannot be automatically removed when it stops, this means you cannot use the --rm option with -d option.

$ docker run -d -p HOST_PORT:CONTAINER_PORT -u USERNAME IMAGE
$ docker run -d -p 8888:8888 -u root korniichuk/scipy-k3d-notebook

or:

$ docker run --detach -p HOST_PORT:CONTAINER_PORT -u USERNAME IMAGE
$ docker run --detach -p 8888:8888 -u root korniichuk/scipy-k3d-notebook

Where:

• -d or --detach -- run container in background and print container ID.

Ports

You can bind Docker containers to specific ports using the -p or --publish option, for example:

$ docker run -d -p HOST_PORT:CONTAINER_PORT -u USERNAME IMAGE
$ docker run -d -p 8888:8888 -u root korniichuk/scipy-k3d-notebook

or:

$ docker run -d --publish HOST_PORT:CONTAINER_PORT -u USERNAME IMAGE
$ docker run -d --publish 8888:8888 -u root korniichuk/scipy-k3d-notebook

Where:

• -p or --publish -- publish a container's port(s) to the host.

Users

You can start a container with root user by passing the -u option:

$ docker run -d -p HOST_PORT:CONTAINER_PORT -u USERNAME IMAGE
$ docker run -d -p 8888:8888 -u root korniichuk/scipy-k3d-notebook

or:

$ docker run -d -p HOST_PORT:CONTAINER_PORT --user USERNAME IMAGE
$ docker run -d -p 8888:8888 --user root korniichuk/scipy-k3d-notebook

Where:

• -u or --user -- username or UID (format: <name|uid>[:<group|gid>]).

Interactive processes

For interactive processes (like a shell), you must use -i -t together in order to allocate a tty for the container process. -i -t is often written -it:

$ docker run -it IMAGE COMMAND
$ docker run -it korniichuk/scipy-k3d-notebook bash

Where:

• -i or --interactive -- keep STDIN open even if not attached,
• -t or --tty -- allocate a pseudo-TTY.

Own try.jupyter.org

First, the following commands launches a docker container for each user that requests one:

$ export TOKEN=$( head -c 30 /dev/urandom | xxd -p )
$ docker run --net=host -d -e CONFIGPROXY_AUTH_TOKEN=$TOKEN \
--name=proxy jupyter/configurable-http-proxy \
--default-target http://127.0.0.1:9999
$ docker run --net=host -d -e CONFIGPROXY_AUTH_TOKEN=$TOKEN \
-v /var/run/docker.sock:/docker.sock jupyter/tmpnb python orchestrate.py \
--image='korniichuk/scipy-k3d-notebook' --command="ipython notebook \
--NotebookApp.base_url={base_path} --ip=0.0.0.0 --port {port}"

Second, visit your host on port 8000.