Erste Schritte

Schnelleinstieg

Installation

1. Herunterladen und Auspacken:

   $ curl -O https://github.com/veit/jupyter-tutorial/archive/master.zip
   $ unzip master.zip
   

2. Pipenv installieren

   Siehe Pipenv installieren

3. Python-Pakete installieren:

   $ cd jupyter-tutorial
   $ pipenv install
   Creating a virtualenv for this project…
   …
   Installing dependencies from Pipfile.lock (fbb457)…
   …
   $ pipenv run jupyter nbextension enable highlighter/highlighter
       Enabling notebook extension highlighter/highlighter...
             - Validating: OK
   

4. Javascript- und CSS-Dateien der Jupyter Notebook Extensions installieren

   $ 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
   

5. HTML-Dokumentation erstellen:

   $ pipenv run sphinx-build -b html docs/ docs/_build/
   

6. PDF erstellen:

   $ 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.

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.