Jupyter / JupyterHub

Die GWDG bietet JupyterHub für interessierte Benutzer*innen von Python, Julia oder R an.

Für wen ist der Dienst geeignet?

Dieser Dienst richtet sich besonders an Benutzer*innen in der Lehre zur Verwendung in Kursen, Seminaren etc. und an einzelne Benutzer*innen, die Dinge in den jeweiligen Programmiersprachen ausprobieren und testen möchten.

Für größere Einsätze, in denen mit großen Datensätzen, großen Modellen, oder parallelen Berechnungen gearbeitet wird, empfiehlt sich die Nutzung des JupyterHub des SCC.

Was ist Jupyter / Jupyter-Hub?

Juyter bietet die Möglichkeit im Browser interaktiv mit Python, Julia oder R zu arbeiten. Quellcode kann dabei in einem Editor im Browser eingegeben, ausgeführt und überarbeitet werden. Diese Schritte passieren in einem s.g. „Notebook“. Jedes Notebook hat einen s.g. „Kernel“ der den Typ des Notebooks bestimmt, also ein Python-, Julia- oder R–Notebook.

Jupyter-Hub ist das Portal, an dem sich der Benutzer anmeldet, seine laufenden Notebooks verwaltet oder neue startet.

Bitte beachten Sie, dass Jupyter auch auf dem SCC betrieben werden kann, falls höhere Berechnungsressourcen benötigt werden.

Wie wird Jupyter / Jupyter-Hub verwendet?

Voraussetzungen

Da Speicherung und Berechnung serverseitig passieren, muss der Client des Benutzers keine Software installieren oder weitere Voraussetzungen erfüllen außer über einen modernen Browser zu verfügen. Für die Anmeldung an dem Dienst wird ein gültiges GWDG-Benutzerkonto benötigt.

Starten eines Notebooks

Nach erfolgreicher Anmeldung kann auf der Übersichtsseite über das Dropdown-Menü oben links unter „File - New“ ein neues Notebook gestartet werden. Früher genutzte oder bereits gestartete Notebooks und ihre zugehörigen Dateien finden sich in der Liste linkerhand.

Detaillierte Informationen zur Benutzeroberfläche: https://jupyterlab.readthedocs.io/en/stable/index.html

Beenden und Verwalten von Notebooks

Ein aktives Notebook kann über das Menü „File - Close and shutdown notebook“ oder durch schließen des Browser-Fensters/Tabs geschlossen werden. Das eigentliche Notebook bleibt in den letzten Zustand erhalten und kann über die Übersichtsseite wieder gestartet und die Arbeit daran fortgesetzt werden.

Gelöscht wird das Notebook durch Rechtsklick „Delete“ des Eintrags in der Listenansicht.

Benutzung

  • Bitte beachten Sie, dass alle Verzeichnisse außer dem Home-Verzeichnis flüchtig sind und beim Schließen des Notebook-Servers verloren gehen.
  • Pro Benutzer ist eine Quota von maximal 50 GB Speicher und 10 GB RAM festgelegt.
  • jupyter-cloud.gwdg.de ist nicht für kontinuierliche Berechnungen über mehrere Tage geeignet.

Notebook startet nicht mehr / Kernel verbindet sich nicht nach Paketinstallation oder Update

Sollte nach einem Upgrade von Paketen / Installation neuer Pakete / Installation eines neuen Kernel kein Notebook mehr startbar sein, bzw. der Kernel verbindet sich nicht mehr, kann es helfen den Ordner '.local' umzubenennen, um neu zu starten. Bitte beachten Sie, das hierbei alle Custom-Kernel und lokal nachinstallierte Pakete deaktiviert werden:

  • File - New - Terminal
  •  mv -v .local/ .local.gwdg-disable 
  • Anschließend Notebook Server neustarten über: File - Hub Control Panel - Stop My Server

Installation zusätzlicher Python Module

Zusätzliche Python Module können über das Terminal und den Python package manager „pip“ installiert werden. Hierzu muss über das Menü „New“ → „Terminal“ ein Terminal geöffnet werden. Anschließend wird mit

pip install --user <module>

ein neues Modul in das Home-Verzeichnis installiert.

Installation von größeren Python Modulen und Disk Space

Die Installation von größeren Python Modulen wie z.B. „tensorflow“ kann mit einer Fehlermeldung „No space left on device“ abbrechen, da pip bei der Verarbeitung größerer Module den Platz unter „/tmp“ ausschöpft. Die folgenden Schritte legen ein neues Verzeichnis für temporäre Daten im wesentlich größeren Benutzerverzeichnis an, welches pip dann für diese Installation benutzt:

mkdir -v ~/.user-temp
TEMP=~/.user-temp pip install --user <module>

Der Präfix mit TEMP lässt pip diesen Ort für dieses eine Installation für temporäre Daten verwenden.

Installation zusätzlicher Pakete per Conda in einem eigenen Environment

Die Verwaltung von Softwarepaketen und Environments mit Conda erfolgt in einer Terminal-Sitzung des Notebook-Servers. Dazu muß nach der Anmeldung am Dienst eine Terminal über New → Terminal gestartet werden.

Bevor mit conda gearbeitet wird, sollten die Conda-Funktionen geladen werden (<b>Punkt am Anfang beachten!</b>):

. /opt/conda/etc/profile.d/conda.sh

Erstellen eines neuen Environments

Im Folgenden wird ein neues, einfaches Conda-Environment wikidoku erstellt, beispielhaft das Python-Modul jinja2 installiert und das Environment für das Notebook verfügbar gemacht.

Erstellen und Aktivieren des Environments:

conda create -y --prefix ./wikidoku
conda activate ./wikidoku

Als nächstes wird beispielhaft das Paket jinja2 installiert. An dieser Stelle kann nun beliebig Software aus beliebigen Conda-Channels installiert werden.

conda install -y jinja2

Das nun aktivierte Environment wird dem Notebook-Server bekannt gemacht. –name und –display-name können frei gewählt werden, letzteres wird später in der Auswahl des Notebooks angezeigt. Der zweite Befehl listet alle bekannten Environments auf. Abschließend wird das Environment verlassen.

python3 -m ipykernel install --user --name wikidoku --display-name "Python (wikidoku)"
jupyter kernelspec list
conda deactivate

Sollte die Installation des Kernels mit der Fehlermeldung abbrechen /usr/bin/python: No module named ipykernel, dann muß zuerst das jupyter-Module in dem aktuellen Environment installiert werden:

python3 -m pip install jupyter

Auswählen eines Environments

Neustart des Notebook-Servers

Wurde ein neues Environment erstellt, muß zunächst der Notebook-Server neu gestartete werden. Dazu alle offenen Terminals und Notebooks schließen und in der Jupyter-Übersicht oben rechts auf Control Panel klicken. Mit Stop My Server den Notebook-Server anhalten und mit Start My Serverwieder starten.

Über New → kann nun ein neues Notebook mit dem neue Environment gestartet werden. Bei einem vorhandenen Notebook kann nach dem Öffnen der Kernel gewechselt werden über das Menü Kernel → Change Kernel.

Installieren anderer Kernel in einem Conda-Environment

Die Installation eines eigenständigen Python-Kernels nur für das aktuelle Environment ist möglich. Hier wird beispielhaft die Installation eines alten python-2.7-Kernels gezeigt.

Ein neues Environment wird nach den o.g. Schritten erzeugt und aktiviert. Danach erfolgt die Installation der Kernels, des jupyter-Moduls für den Kernel und abschließend wird der neue Kernel für den Notebook-Server aktiviert:

conda install -y python=2.7
python -m pip install jupyter
python -m ipykernel install --user --name oldpython --display-name "Python 2.7 (oldpython)"

Der neue Kernel steht nun in neu-gestarteten Notebooks (s.o.) in der Kernel-Auswahl zur Verfügung. Die aktuelle Kernel-Version kann in einem Notebook überprüft werden mit den folgendem Code:

import sys
print (sys.version)

Environment entfernen

Um ein Environment zu entfernen, wird es vom Notebook-Server abgemeldet und dann die zugehörigen Dateien gelöscht (optional, aber empfohlen).

jupyter kernelspec list
jupyter kernelspec remove wikidoku
rm -rf ./wikidoku

Installation zusätzlicher R Pakete

1) mkdir -p ~/R/library; mkdir ~/tmp
2) create a file "/home/jovyan/.Renviron" with 2 lines:
"R_LIBS_USER=/home/jovyan/R/library" and "TMPDIR=/home/jovyan/tmp"
3) R
4) source("https://bioconductor.org/biocLite.R")
5) biocLite()

This is because R downloads and installs packages to and from the default tmp directory,
from which it cannot execute files. Using a tmp directory inside the home directory solves
this problem.

How to install packages from Github (in R):

1) library(devtools)
2) options(unzip = "internal")
3) install_github("repo/package")

Transfer von Daten in das Unix/Linux-Heimatverzeichnis

Um den Zugriff auf größere Datenmengen auf jupyter.gwdg.de zu erleichtern, kann das Unix/Linux-Heimatverzeichnis hinzugezogen werden. Hierfür werden Daten mit dem Tool rsync transferiert. Nachfolgend ein Beispiel, das auf die jeweilige Umgebung des Benutzers angepasst werden muss:

Zunächst muss über das jupyter-Menü ein neues Terminal geöffnet werden: „New“ → „Terminal“

ls mynotebooks/
myfile.txt
rsync -av ~/mynotebooks/ bbrauns@login.gwdg.de:/usr/users/bbrauns/mynotebooks/
sending incremental file list
./
myfile.txt

sent 145 bytes  received 44 bytes  75.60 bytes/sec
total size is 12  speedup is 0.06

Ggf. muss der jeweilige ssh-private-key in das .ssh/ Verzeichnis in jupyter-cloud hinterlegt werden. Ebenso muss der zugehörige ssh-public-key auf login.gwdg.de vorhanden sein.

Für den Zugriff auf die Daten im Unix/Linux-Heimatverzeichnis von einem Windows-Rechner siehe: Samba Server

Zusätzlichen kernel mit pipenv bereitstellen

Open a new jupyter terminal via the menu “New” → “Terminal”

pip install pipenv --user
mkdir myproject
cd myproject
export PATH=~/.local/bin/:$PATH
pipenv --python /usr/bin/python3.6 #needed because of conda
pipenv install ipykernel networkx
pipenv shell
ipython kernel install --user --name=projectname
  • Stop and restart server via control panel
  • Afterwards „projectname“ is usable as new kernel

Zusätzlichen julia kernel installieren

!Experimentell!

(Terminal, Home Verzeichnis)
Ggf. .julia und .julia_history Verzeichnis löschen für sauberen Neuanfang.
mkdir .julia_bin
wget https://julialang-s3.julialang.org/bin/linux/x64/1.0/julia-1.0.1-linux-x86_64.tar.gz
tar -xvzf julia-1.0.1-linux-x86_64.tar.gz
cd julia-1.0.1/bin/
./julia

(Julia REPL)

ENV["JUPYTER"]="jupyter"
import Pkg
Pkg.add("IJulia")
using IJulia
exit()

(Server neustarten)

Zusätzliche julia Pakete installieren mit extra Kernel

!Experimentell!

Das verwendete jupyter docker stacks image hat die Variable JULIA_DEPOT_PATH auf den Pfad /opt/julia gesetzt. Dieser ist allerdings flüchtig, da nur das Home Directory persistent gehalten wird. Es wird folgend ein neuer julia kernel installiert, der sein Paket-Verzeichnis im Home Directory hat:

Start terminal  
Temporarily change julia package directories:  

export JULIA_DEPOT_PATH=/home/jovyan/.julia-depot
export JULIA_PKGDIR=/home/jovyan/.julia-depot

Create directory for custom packages and new julia kernel:

> mkdir /home/jovyan/.julia-depot
> julia
julia > # switch to pkg with ']' character
pkg > add IJulia # switch back to julia with CTRL+C
julia > using IJulia
	   installkernel("My-Julia-kernel", env=Dict("JULIA_DEPOT_PATH"=>"/home/jovyan/.julia-depot"))
Restart notebook server
Create new notebook with "My-Julia-kernel" kernel
Add package example: 

using Pkg
Pkg.add("DataFrames")
Diese Website verwendet Cookies. Durch die Nutzung der Website stimmen Sie dem Speichern von Cookies auf Ihrem Computer zu. Außerdem bestätigen Sie, dass Sie unsere Datenschutzbestimmungen gelesen und verstanden haben. Wenn Sie nicht einverstanden sind, verlassen Sie die Website.Weitere Information