fscm/jupyter repository overview

⁠Jupyter for Docker

A small Jupyter image that can be used for either Jupyter Notebook or JupyterLab.

⁠Supported tags

• centos
• debian, latest

⁠What is Jupyter Notebook?

from jupyter.org⁠

⁠What is JupyterLab?

from jupyter.org⁠

⁠Getting Started

There are a couple of things needed for the script to work.

⁠Prerequisites

Docker, either the Community Edition (CE) or Enterprise Edition (EE), needs to be installed on your local computer.

⁠Docker

Docker installation instructions can be found here⁠.

⁠Usage

In order to end up with a functional Jupyter notebook - after having build the container - some configurations have to be performed.

To help perform those configurations a small set of commands is included on the Docker container.

• help - Usage help.
• init - Configure the Jupyter service (Not required in this image).
• start - Start the Jupyter service.

To store the documents created in Jupyter a volume should be created and added to the container when running the same.

⁠Creating Volumes

To be able to make all of the Jupyter notebooks persistent, the same will have to be stored on a different volume.

Creating volumes can be done using the docker tool. To create a volume use the following command:

docker volume create --name VOLUME_NAME

Two create the required volume the following command can be used:

docker volume create --name my_notebooks

Note: A local folder can also be used instead of a volume. Use the path of the folder in place of the volume name.

⁠Configuring the Jupyter Application

This step is not required for this Jupyter Docker image.

⁠Start the Jupyter Application

After configuring the Jupyter application the same can now be started.

Starting the Jupyter application can be done with the start command.

docker container run --volume VOLUME_NAME:/work:rw --detach --publish 8888:8888/tcp fscm/jupyter:latest [options] start

• -l - Starts the JypiterLab environment.
• -n - Start the Jupyter Notebook environment (default).

An example on how the Jupyter application can be started:

docker container run --volume my_notebooks:/work:rw --detach --publish 8888:8888/tcp --name my_jupyter fscm/jupyter:latest start

To see the output of the container that was started use the following command:

docker container attach CONTAINER_ID

Use the ctrl+p ctrl+q command sequence to detach from the container.

⁠Open the Jupyter Application

After starting the Jupyter container, open a new browser tab and type in the address http://localhost:8888.

The Jupyter application, either the Jupyter Notebook or the JupyterLab depending on which one was started, should now be visible on your browser tab.

⁠Install Python Modules

To install Python modules inside the Docker container, open a terminal from within the Jupyter application. This will provide a fully functional terminal shell from which the pip install command can be run.

⁠Stop the Jupyter Application

If needed the Jupyter application can be stoped and later started again (as long as the command used to perform the initial start was as indicated before).

To stop the container use the following command:

docker container stop CONTAINER_ID

To start the server again use the following command:

docker container start CONTAINER_ID

⁠Jupyter Status

The Jupyter application status can be check by looking at the Jupyter application output data using the docker command:

docker container logs CONTAINER_ID

⁠Build

Build instructions can be found here⁠.

⁠Versioning

This project uses SemVer⁠ for versioning. For the versions available, see the tags on this repository⁠.

⁠Authors

• Frederico Martins - fscm⁠

See also the list of contributors⁠ who participated in this project.