README.md

Simulation Software Engineering Lecture Material

Material of the Simulation Software Engineering lecture. There are different ways how to get an overview:

• Look at timetable.md of the current course or a previous course, or
• Look at the README.md files of each chapter / folder.

Please note that we update the material over the course of each semester.

List of Chapters

1. Version Control
2. Virtualization and Containers
3. Building and Packaging
4. Documentation
5. Testing and CI
6. Miscellaneous

Linting

The markdown files can be checked using markdownlint, which is automatically being called from pre-commit:

pipx install pre-commit  # Install pre-commit as a tool
pre-commit install       # Install/enable pre-commit in the specific repository
pre-commit run -a        # Run all pre-commit hooks (not necessary, automatically when committing)

It will automatically read the markdownlint configuration of this repository. The linter is configured in the file .markdownlint.json.

Third-Party Content

In several parts of the material, we use content from

Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: Research Software Engineering with Python, 2021,

a book, which we also recommend to recap Git/Bash/Python basics.

License

This work is licensed under a Creative Commons Attribution 4.0 International License.