Skip to content

pep-dortmund/toolbox-workshop

Repository files navigation

PeP et al. Toolbox Workshop Creative Commons License CI

Dieses Repository enthält Materialien zum PeP et al. Toolbox Workshop.

Folgende Themen sind Teil des Workshops:

  • Erste Woche
    • Python-Grundlagen
    • numpy
    • matplotlib
    • scipy
    • uncertainties
    • Unix-Kommandozeile
    • make
    • git
  • Zweite Woche
    • Umgang mit LaTeX

License

The programming code examples in this material are shared under the GnuGPLv3 license. The lecture material (e.g. jupyter notebooks) are shared under the Creative Commons Attribution-NonCommercial License: https://creativecommons.org/licenses/by-nc/4.0/legalcode.txt, so they cannot be used for commercial training / tutorials / lectures.

Build Requirements

  • up-to-date TeXLive 2024
  • up-to-date anaconda3 (using python 3.11) or miniconda with packages in environment.yml
  • poppler (for pdfseparate)
  • wget

Installation

For TeXLive and mamba, follow the installation instruction on http://toolbox.pep-dortmund.org/install

Create the environment with the required packages using

mamba env create -f environment.yml

and activate it each time you are working in this project using

mamba activate toolbox

MacOS

  • brew install poppler wget

Ubuntu

  • sudo apt install poppler-utils

Arch

  • sudo pacman -S poppler

Working with git

We are using black and nbqa-black as auto-formatters to ensure code quality. To make sure these tools are running every time you make a commit, set up our pre-commit hook via

$ pre-commit install

before your first commit. The pre-commit hook will run the auto-formatters and reject a commit if any of the checks fail. Any failing checks can then be solved by fixing the issues reported by the pre-commit hook.

We use the github workflow in this repository, see https://guides.github.com/introduction/flow/. In short, to contribute:

  1. Create a new branch and switch to it using git switch -c <name>
  2. Make changes and commit
  3. Push the Branch using git push -u origin <name>
  4. Open a Pull Request on github.