Dies ist eine alte Version des Dokuments!
Inhaltsverzeichnis
Jupyter / Jupyter-Hub
Die GWDG bietet Jupyter-Hub im offenen Testbetrieb für interessierte Benutzer von Python, Julia oder R an.
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 rechts unter „New“ mit der Auswahl eines Notebook-Kernels ein neues Notebook gestartet werden. Früher genutzte oder bereits gestartete Notebooks und ihre zugehörigen Dateien finden sich in der Liste mittig der Seite. Neben dem Menü „New“ findet sich auch eine Schaltfläche „Upload“, über welche Dateien zur Verwendung in Notebooks nach Jupyter-Hub übertragen werden können.
Der eigentliche Start eines Notebooks geschieht mit der Auswahl eines Kernels. Das Notebook wird in einem neuen Fenster gestartet und kann sofort verwendet werden. Über das Menü „Help“ kann eine Interface Tour gestartet, die Übersicht über Tastaturkürzel angezeigt und die Dokumentationen zu dem verwendeten Kernel (soweit vorhanden) geöffnet werden.
Beispiele
Unterhalb des Ordners public-ro befinden sich Beispiel-Notebooks aus dem offiziellen Jupyter-Projekt die direkt gestartet werden können und die Nutzungsweise von Jupyter näher erläutern.
Beenden und Verwalten von Notebooks
Ein aktives Notebook kann über das Menü „File“ > „Close and Halt“ 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 Markierung des Eintrags in der Liste und Klick auf das rote Mülleimersymbol.
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 50GB Speicher und 4GB RAM festgelegt.
- jupyter.gwdg.de ist nicht für kontinuierliche Berechnungen über mehrere Tage geeignet.
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:
jovyan@bcbde100c399:~$ . /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:
jovyan@bcbde100c399:~$ conda create -y --prefix ./wikidoku jovyan@bcbde100c399:~$ conda activate ./wikidoku
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.
jovyan@bcbde100c399:~$ python -m ipykernel install --user --name wikidoku --display-name "Python (wikidoku)" jovyan@bcbde100c399:~$ jupyter kernelspec list
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:
jovyan@bcbde100c399:~$ python -m pip install jupyter
Als nächstes wird beispielhaft das Paket jinja2
installiert. An dieser Stelle kann nun beliebig Software aus beliebigen Conda-Channels installiert werden. Abschließend wird das Environment verlassen.
jovyan@bcbde100c399:~$ conda install -y jinja2 jovyan@bcbde100c399:~$ conda deactivate
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 Server
wieder 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:
jovyan@bcbde100c399:~$ conda install -y python=2.7 jovyan@bcbde100c399:~$ python -m pip install jupyter jovyan@bcbde100c399:~$ 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)
Installation zusätzlicher R Pakete
1) mkdir -p ~/R/library; mkdir ~/temp 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“
jovyan@0d5793127e96:~$ ls mynotebooks/ myfile.txt jovyan@0d5793127e96:~$ rsync -av ~/mynotebooks/ bbrauns@login.gwdg.de:/usr/users/bbrauns/mynotebooks/ bbrauns@login.gwdg.de's password: sending incremental file list ./ myfile.txt sent 145 bytes received 44 bytes 75.60 bytes/sec total size is 12 speedup is 0.06
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)
Mehr Informationen zum offener Testbetrieb
Welche Bedeutung der offene Testbetrieb für die praktische Verwendung von Jupyter-Hub hat, finden sich in den Erläuterungen zum offenen Testbetrieb.