Erste Schritte

Installation

  1. Herunterladen und Auspacken:

    $ curl -O https://codeload.github.com/veit/jupyter-tutorial-de/zip/main
$ unzip main
Archive:  main
…
   creating: jupyter-tutorial-de-main/
…

  2. Installieren der Python-Pakete

    $ cd jupyter-tutorial-main
$ pipenv install
Creating a virtualenv for this project…
…

  3. Installieren der Jupyter Notebook Extensions:

    $ pipenv run jupyter contrib nbextension install --user
jupyter contrib nbextension install --user
Installing jupyter_contrib_nbextensions nbextension files to jupyter data directory
…
Successfully installed jupyter-contrib-core-0.3.3 jupyter-contrib-nbextensions-0.5.1
jupyter-highlight-selected-word-0.2.0 jupyter-latex-envs-1.4.6
jupyter-nbextensions-configurator-0.4.1
…
$ pipenv run jupyter nbextension enable latex_envs --user --py
Enabling notebook extension latex_envs/latex_envs...
      - Validating: OK

  4. HTML-Dokumentation erstellen:

    $ python3 -m venv .
$ bin/python -m pip install --upgrade pip
$ bin/python -m pip install -r docs/constraints.txt
$ bin/sphinx-build -ab html docs/ docs/_build/

  5. PDF erstellen:

    Für die Erstellung von PDFs benötigt ihr weitere Pakete.

    Für Debian/Ubuntu erhaltet ihr diese mit:

    $ sudo apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

    oder für macOS mit:

    $ brew cask install mactex
…
🍺  mactex was successfully installed!
$ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts
$ sudo texlua install-getnonfreefonts
…
mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...
mktexlsr: Done.

    Anschließend könnt ihr ein PDF generieren mit:

    $ cd docs/
$ pipenv run make latexpdf
…
The LaTeX files are in _build/latex.
Run 'make' in that directory to run these through (pdf)latex
…

    Das PDF findet ihr anschließend in docs/_build/latex/jupytertutorial.pdf.

Folge uns

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehle ich euch, einen Fork meines GitHub-Repository zu erstellen und darin eure Änderungen vorzunehmen. Gerne dürft ihr auch einen Pull Request stellen. Sofern die darin enthaltenen Änderungen klein und atomar sind, schaue ich mir eure Vorschläge gerne an.