Schnelleinstieg

Contributors License Docs

Installation

  1. Herunterladen und Auspacken:

    $ curl -O https://codeload.github.com/veit/pyviz-tutorial/zip/master
    $ unzip master
    Archive:  master
    
       creating: pyviz-tutorial-master/
    
    
  2. Pandoc installieren:

    • für Ubuntu und Debian:

      $ sudo apt install pandoc
      
    • für Mac OSX:

      $ brew install pandoc
      
  3. Python-Pakete installieren:

    $ cd pyviz-tutorial
    $ python3 -m venv .
    $ bin/python -m pip install  --upgrade pip setuptools
    $ bin/python -m pip install -r requirements.txt
    
  4. HTML-Dokumentation erstellen:

    $ bin/sphinx-build -b 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:

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

    oder für Mac OS X 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/
    $ 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/pyviz-tutorial.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.