/Lecture-Material

Material for the Simulation Software Engineering Lecture

Primary LanguageTeXCreative Commons Attribution 4.0 InternationalCC-BY-4.0

Simulation Software Engineering Lecture Material

markdownlint PDFs CC BY 4.0

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

  • Look at timetable.md,
  • Look at the README.md files of each chapter / folder,
  • Browse the content through the course website.

List of chapters

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

Linting

The markdown files can be checked using markdownlint. Once the linter is installed one can run it locally from the root of this repository using

mdl .

It will automatically read the markdownlint configuration of this repository. The linter is configured in the files .mdl.rb and .mdlrc. The majority of the configuration is done in .mdl.rb.

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.

CC BY 4.0