Skip to content
PhiSpel edited this page Aug 11, 2022 · 21 revisions

Welcome to the Modellbildung-und-Simulation wiki!

Style Guide

The Style Guide for the book can be found on the next page. It is not finished, but there are some important infos already. For exampel about writing conventions like how we handle abbreviations, the colors we use and references. On the right, you find the menu to browse through the topics.

Informationen zum Urheberrecht

The Sheet for information concerning copyright can be found here.

The ONE Spreadsheet to rule

The famous Spreadsheet for the overall overview is here.

File-naming conventions

  • Numbering starts at 00_ for chapters and exercises.
  • Chapters are ordered in folders in /content.
  • Exercises are ordered in the folder with the corresponding topic in .md or .ipynb files.
  • Titles of chapters must be titles in the first file within the folder, e.g. # Interpolation und Approximation in 05_interp_approx/00_interpolation_Und_approximation.md. Same goes for titles of sections and subsections, e.g. Skripte und Funktionen in 00_einleitung/02_first_steps/02_skripte_und_funktionen.ipynb.

Also keep in mind the conventions from JupyterBooks:

  • Each sub-folder must have at least one content file inside it
  • The ordering of files in _toc.yml will depend on the alphanumeric order of the filenames (e.g., folder_01 comes before folder_02, and apage comes before b_page)
  • If there is a file called index.md in any folder, it will be listed first.
Clone this wiki locally