Add topic overview demo

00_organization/README.md

@@ -9,7 +9,8 @@ Learning goals:
 | Duration | Content |
 | --- | --- |
 | 20 minutes | [`challenge_intro_slides.md`](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) |
-| 40 minutes | [`course_intro_slides.md`](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) |
+| 30 minutes | [`course_intro_slides.md`](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) |
 | 15 minutes | [`rse_basics.md`](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/rse_basics_slides.md) |
+| 10 minutes | [`topic_overview_demo.md`](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/topic_overview_demo.md) |
 
 Folders such as `wt2122` contain organizational content specific to previous lectures.

00_organization/course_intro_slides.md

@@ -144,6 +144,10 @@ Two parallel branches:
 
 ---
 
+## Topic Overview Demo
+
+---
+
 ## The Challenge
 
 - Contribute something small (but not trivial) to a large-scale open-source simulation software (*"good first issue"*)

00_organization/topic_overview_demo.md

@@ -0,0 +1,30 @@
+# Topic Overview Demo
+
+- We will use [preCICE](https://precice.org/) as an example for many things in this course.
+- Briefly sprint through all 6 chapters of the course and preview what we will learn.
+- preCICE is a coupling library for partitioned multi-physics simulations, developed at US and TUM.
+- 1. Version Control
+    - [preCICE organization on GitHub](https://github.com/precice), multi-repo approach
+    - at the core is a [library called precice](https://github.com/precice/precice)
+    - forking workflow with protected main branch, develop is default, open a PR, explain source and target
+    - linear history, show commits
+- 2. Virtualization and Containers
+    - being a coupling library, many software components are involved in actual simulations --> virtualization is an important topic to handle all these components
+    - [preCICE Docker images](https://hub.docker.com/u/precice) for testing only (preCICE and downstream repositories), not meant for users
+    - [virtual machine](https://precice.org/installation-vm.html) for demo (sandbox) mode with many components, scripted using Vagrant
+- 3. Building and Packaging
+    - [installation overview](https://precice.org/installation-overview.html), Debian package, spack, Python bindings on PyPI
+    - package creation and [building from source](https://precice.org/installation-source-configuration.html) via CMake
+- 4. Documentation
+    - written in markdown in distributed places (click edit on some page), rendered via jekyll, hosted via GitHub Pages
+    - distinguish user from dev docs, tutorials, configuration references
+    - [brief styleguide](https://precice.org/docs-meta-content-guidelines.html)
+    - [changelog](https://github.com/precice/precice/blob/develop/CHANGELOG.md)
+- 5. Testing and Continuous Integration
+    - [unit and integration](https://precice.org/dev-docs-dev-testing.html) tests via Boost.Test
+    - [tests and more automation](https://github.com/precice/precice/actions) run on Github Actions
+    - many Python components use unittest
+- 6. Miscellaneous
+    - LGPL3 license
+    - semantic versioning scheme
+    - [distribution published on DaRUS](https://darus.uni-stuttgart.de/dataset.xhtml?persistentId=doi:10.18419/darus-4167)

timetable.md

@@ -2,7 +2,8 @@
 
 ## 1.1 – Wed, October 16, 2024
 
-- **50** min.: [Course planning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) + questions
+- **40** min.: [Course planning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) + questions
+- **10** min.: [Overview demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/topic_overview_demo.md)
 - **20** min.: [Introduction to RSE](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/rse_basics_slides.md)
 - **20** min.: [Introduction to version control](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/intro_slides.md)