Jupyter Example Profile

Introduction

This repository contains an exemplary Jupyter profile which works with the RWTH Jupyter server. To be more specific, it includes the following files

• Quickstart.ipynb which is an exemplary Jupyter notebook file.
• environment.yml which specifies the required Python packages needed to run Quickstart.ipynb. This file is used by Anaconda or conda.
• Dockerfile which defines the linux environment. In the end, the packages in environment.yml are installed and a postBuild script is executed afterwards.
• .gitlab-ci.yml which specifies the necessary Docker build commands (which are executed every time Dockerfile changes in Git).

Run the notebook directly online (the starting process of the session may take up to one minute).

Installation

Installation on RWTH Jupyter Server

TBD

Docker

For advanced users only: If you happen to have Docker installed, you can start a local dockerized JupyterLab with

docker run --name='jupyter-example-profile' --rm -it -p 8888:8888 -e JUPYTER_ENABLE_LAB=yes registry.git-ce.rwth-aachen.de/jupyter/example-profile:master

Copy and paste the displayed link to your favorite browser.

Local Installation

To run the notebooks on your local machine, you may use Anaconda (using pip is also possible for experienced users. You have to install all the requirements listed in environment.yml and install the commands listed in binder/postBuild).

• Install Anaconda.

• Download this repository to your local disk. You can download it as a zip-File or use git:

  git clone --recurse-submodules git@git-ce.rwth-aachen.de:jupyter/example-profile.git

• It is highly recommended to run the notebooks in an isolated Anaconda environment. You can create a new environment called jupyter-example-profile from the provided environment.yml by running the following command in the Anaconda prompt

  conda env create -f environment.yml

  This makes sure that all required packages are installed amd don't interfere with the packages in your base environment.

• Activate this environment with

  conda activate jupyter-example-profile

• Run two final commands in the Anaconda prompt (with activated jupyter-example-profile environment):

  chmod +x binder/postBuild
  binder/postBuild

  If the latter command fails, please open postBuild and execute the commands listed there manually.

Local Run

• Activate the environment with conda activate jupyter-example-profile.
• Run JupyterLab jupyter lab. In your browser, JupyterLab should start. You can then open index.ipynb for an overview over all notebooks.
• You can deactivate the environment with conda deactivate.

Contact

• If you found a bug, please use the issue tracker.
• In all other cases, please contact Christian Rohlfing.

The code is licensed under the MIT license.