diff --git a/00_organization/README.md b/00_organization/README.md index df40e6b7..fde6226f 100644 --- a/00_organization/README.md +++ b/00_organization/README.md @@ -14,4 +14,4 @@ Learning goals: | 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. +Folders such as `wt2x2y` contain organizational content specific to previous lectures. diff --git a/00_organization/challenge_intro_slides.md b/00_organization/challenge_intro_slides.md index 9da12eec..465e335b 100644 --- a/00_organization/challenge_intro_slides.md +++ b/00_organization/challenge_intro_slides.md @@ -150,7 +150,7 @@ The challenge part: ## Role of Advisor -- Benjamin, Felix, Frédéric, Gerasimos, or Ishaan +- Felix, Frédéric, Serge, or Gerasimos - Use, for example, exercise blocks and time before and after lectures for discussions - Share links etc. to issues and PRs (or tag us) diff --git a/00_organization/course_intro_slides.md b/00_organization/course_intro_slides.md index e0066aed..67d5fc2b 100644 --- a/00_organization/course_intro_slides.md +++ b/00_organization/course_intro_slides.md @@ -43,18 +43,19 @@ slideOptions: ## The Lecturers -- Benjamin (Uekermann) [`@uekerman`](https://github.com/uekerman) - Gerasimos (Chourdakis) [`@MakisH`](https://github.com/MakisH) -- Ishaan (Desai) [`@IshaanDesai`](https://github.com/IshaanDesai) +- Frédéric (Simonis) [`@fsimonis`](https://github.com/fsimonis) +- Felix (Neubauer) [`@Logende`](https://github.com/Logende) +- On leave this year: Benjamin (Uekermann) [`@uekerman`](https://github.com/uekerman) Additional challenge advisors: -- Frédéric (Simonis) [`@fsimonis`](https://github.com/fsimonis) -- Felix (Neubauer) [`@Logende`](https://github.com/Logende) +- Serge Kotchourko [`@kotserge`](https://github.com/kotserge) SSE Hall of Fame: - Alexander (Jaust) [`@ajaust`](https://github.com/ajaust) +- Ishaan (Desai) [`@IshaanDesai`](https://github.com/IshaanDesai) --- @@ -76,7 +77,7 @@ SSE Hall of Fame: Two parallel branches: - **Weekly lectures** (90 mins) and **exercises** (90 mins) to learn and train concepts and tools - - Wednesdays, 09:45–11:15 (in V47.05) and 15:45–17:15 (in 38-0.108, might be too small in first week) + - Wednesdays, 09:45–11:15 (in V47.05) and 15:45–17:15 (in 38-0.124, might be too small in the beginning) - Typically lecture in the morning and exercise in the afternoon - **Individual challenge**: contribute to real simulation software :rocket: - List of software candidates: this afternoon @@ -160,80 +161,17 @@ Two parallel branches: ### Timeline -- Pick a software (till **Oct 22**, evening) -- **Step 1**: Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 5**) -- **Step 2**: Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 17**) -- Suggest contribution (**Dec 17**) -- **Step 3**: Present the contribution (**Feb 4**) +- Pick a software project to contribute to +- **Step 1**: Present the software: how you got it, what are main features, some tutorials you did, ... +- **Step 2**: Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? +- Suggest contribution +- **Step 3**: Present the contribution --- -## Time Table I - - - -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 15.10. |Lecture | 0-1 | Course intro, intro to SSE, VC basics | Benjamin | -| 15.10. |Lecture | 1 | Git basics, my Git workflow, Git quiz, how to challenge | Benjamin | -| 22.10. |Lecture | 1 | *My neat little Git trick*, merge vs rebase, working in teams| Benjamin | -| 22.10. |Lab | 1 | Git | Benjamin | -| 29.10. |Lecture | 2 | Containers and virtualization | Gerasimos | -| 29.10. |Lab | 2 | Containers and virtualization | Gerasimos | -| 05.11. |Presentations | C | **1st student presentations** | students | -| 05.11. |Presentations | C | **1st student presentations** | students | - ---- - -## Time Table II - - - -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 12.11. |Lecture | 3 | Intro packaging, Python packaging | Ishaan | -| 12.11. |Lab | 3 | Python packaging | Ishaan | -| 19.11. |Lecture | 3 | Linux fundamentals, Make, CMake | Gerasimos | -| 19.11. |Lab | 3 | CMake and Docker | Gerasimos | -| 26.11. |Lecture | 3 | Spack | Ishaan | -| 26.11. |Lab | 3 | Spack | Ishaan | -| 03.12. |Lecture | 3 | CPack and more CMake | Benjamin | -| 03.12. |Lab | 3 | CPack | Benjamin | -| 10.12. |Lecture | 4 | Technical writing | Gerasimos | -| 10.12. |Lab | 4 | Code review | Gerasimos | -| 17.12. |Presentations | C | **2nd student presentations** | students | -| 17.12. |Presentations | C | **2nd student presentations** | students | - ---- - -## Time Table III - - +## Timetable -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 07.01. |Lecture | 4 | Markup, Pandoc, website gener. | Benjamin | -| 07.01. |Lecture | 4 | FLOSS, versioning, repo layouts, DOI, Zenodo, DaRUS | Benjamin | -| 14.01. |Lecture | 5 | Intro testing, testing in Python | Ishaan | -| 14.01. |Lab | 5 | Testing in Python | Ishaan | -| 21.01. |Lecture | 5 | Automation, GitHub Actions, GitLab CI | Gerasimos| -| 21.01. |Lab | 5 | GitHub Actions | Gerasimos| -| 28.01. |Lecture | 5 | Boost.Test and CTest | Benjamin | -| 28.01. |Lab | 5 | Boost.Test and CTest | Benjamin | -| 04.02. |Presentations | C | **3rd student presentations** | students | -| 04.02. |Presentations | C | **3rd student presentations** | students | +See [GitHub: timetable.md](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/timetable.md) --- @@ -248,15 +186,15 @@ td { - *"good"* everywhere leads to 1.0. - We give (brief) feedback after every exercise. - You will need to register yourself to the *"exam"* on C@MPUS. -- Last in: The deadline to pick a software (**Oct 22**, evening) -- Last out: Once you handed in the first report (**Nov 6**) +- Last in: The deadline to pick a software +- Last out: Once you handed in the first report --- ## GitLab Account -- Please write a mail till tonight to Ishaan. - - [ishaan.desai@ipvs.uni-stuttgart.de](mailto:ishaan.desai@ipvs.uni-stuttgart.de) +- Please write a mail till tonight to Gerasimos. + - [gerasimos.chourdakis@ipvs.uni-stuttgart.de](mailto:gerasimos.chourdakis@ipvs.uni-stuttgart.de) - Email subject: "GitLab account SSE course" - State your **name** and preferred **email-address** - If you already have an IPVS-SIM GitLab account, we only need your username. diff --git a/00_organization/organizational_remarks_week8_slides.md b/00_organization/organizational_remarks_week8_slides.md index 5b62d68f..98f01e6a 100644 --- a/00_organization/organizational_remarks_week8_slides.md +++ b/00_organization/organizational_remarks_week8_slides.md @@ -45,27 +45,10 @@ td { } -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 12.11. |Lecture | 3 | Intro packaging, Python packaging | Ishaan | -| 12.11. |Lab | 3 | Python packaging | Ishaan | -| 19.11. |Lecture | 3 | Linux fundamentals, Make, CMake | Gerasimos | -| 19.11. |Lab | 3 | CMake and Docker | Gerasimos | -| 26.11. |Lecture | 3 | Spack | Ishaan | -| 26.11. |Lab | 3 | Spack | Ishaan | -| **03.12.** |**Lecture** | **3** | **CPack and more CMake** | **Benjamin** | -| 03.12. |Lab | 3 | CPack | Benjamin | -| 10.12. |Lecture | 4 | Technical writing | Gerasimos | -| 10.12. |Lab | 4 | Code review | Gerasimos | -| 17.12. |Presentations | C | **2nd student presentations** | students | -| 17.12. |Presentations | C | **2nd student presentations** | students | - ---- - ## Exam Registration -- You have to register for exam (we cannot do this for you) -- Campus deadline should be today +- You have to register for the exam node on C@MPUS (we cannot do this for you) +- The deadline should be very soon --- @@ -82,11 +65,12 @@ td { ## Challenge Contribution -- Please open an issue in the [challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2526/challenge) explaining what you want to work on in the contribution. We will then use these issues to further discuss the progress of the contribution. Provide links to issues, pull requests etc. - - Deadline (for opening the issue): Dec 17, 2025, 23:59 +- Please open an issue in the Challenge repo explaining what you want to work on in the contribution. We will then use these issues to further discuss the progress of the contribution. Provide links to issues, pull requests etc. + - Remember the deadline for opening the issue (see timetable) - If you open earlier, you get feedback earlier - - Latest feedback from supervisors: Jan 7, 2025, 09:45 + - Latest feedback from supervisors: first course week after Christmas - Title of issue: "Contribution to SOFTWARE by USERNAME" - Tag your supervisor in description - Get in touch with maintainers early (through official channels) - Discuss before you start developing + diff --git a/00_organization/wt2122/organizational_remarks_week3_slides_old.md b/00_organization/wt2122/organizational_remarks_week3_slides_old.md deleted file mode 100644 index f4bb173d..00000000 --- a/00_organization/wt2122/organizational_remarks_week3_slides_old.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -type: slide -slideOptions: - transition: slide - width: 1400 - height: 900 - margin: 0.1 - data-background-color: green ---- - - - -# Organizational Things - ---- - -## Misc - -- Please add presentations from last week to [*"My neat little Git trick"*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) -- [GitHub Universe](https://www.githubuniverse.com/2021) was last week. - - Amazing new feature: `ctrl` + `k` and never use mouse again - ---- - -## Git Cheat Sheet - -- Observations: - - Pay more attention to descriptions of issues and PRs: what, why, how, ... - - As reviewer, don't just accept, but think about how to increase quality - - You don't seem to like perfect linear histories :grin: ... in many cases just use `rebase & merge` or `squash & merge` button on GitHub -- **Deadline**: next Monday, Nov 8, 9am - ---- - -## Challenge - -- Have you seen **matching** on [GitLab](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering/challenge/-/issues/1)? -- Information on **first presentations** also on [GitLab](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering/challenge/-/issues/2) - - Half of students present first step, the other half second step (everybody third step) - - Still, everybody needs to hand in a report each time - - Please let us know (as early as possible) if you drop out such that we can find another presenter diff --git a/00_organization/wt2122/organizational_remarks_week7_slides_old.md b/00_organization/wt2122/organizational_remarks_week7_slides_old.md deleted file mode 100644 index 18a15bc5..00000000 --- a/00_organization/wt2122/organizational_remarks_week7_slides_old.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -type: slide -slideOptions: - transition: slide - width: 1400 - height: 900 - margin: 0.1 - data-background-color: green ---- - - - -# Organizational Things Week 7 - ---- - -## Poll on First 5 Weeks (1/2) - -- Thanks for participating! -- Many wrote that they liked the concept. Made us very happy. :blush: -- **Multiple sources of content (website, GitLab, GitHub)** - - We are aware of the problem and are thinking about solutions. - - Reason 1: you should learn GitLab + GitHub - - Reason 2: private information (GitLab) vs. public information (GitHub) - - We need privacy for some things. We want public domain for other things. - - In general: lecture on GitHub, challenge on GitLab - ---- - -## Poll on First 5 Weeks (2/2) - -- **Exercises too much workload** - - How much time do you still need at home to finish? - - You are not expected to finish within the exercise session (50% done is good). - - Ask for help! Also through draft PRs. -- **Git exercise and VM/containers lecture need improvement** -> YES -- Demo challenge presentation by lecturers? - - We are thinking about it. - - What do you hope to learn exactly? - ---- - -## Challenge - -- Information on **second step** on [GitLab](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering/challenge/-/issues/3) - - Now, the *"other half"* presents. - - Still, everybody needs to hand in a report (deadline: Dec 16, 2021, 15:45). -- Please open an issue in the [challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering/challenge/) explaining what you want to work on for step 3. We will then use these issues to further discuss the progress of the contribution. Provide links to issues, pull requests etc. - - Deadline (for opening the issue): Jan 10, 2022, 23:59 - - Title of issue: "Contribution to SOFTWARE by USERNAME" diff --git a/00_organization/wt2122/timetable.md b/00_organization/wt2122/timetable.md deleted file mode 100644 index c5310036..00000000 --- a/00_organization/wt2122/timetable.md +++ /dev/null @@ -1,151 +0,0 @@ -# Time Table - -## 1.1 – Thu, October 21, 2021 - -- **40** [Course planning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) + questions -- **15** [Introduction to RSE](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/rse_basics_slides.md) -- **15** [Introduction to version control](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/intro_slides.md) -- **15** [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics) -- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse/) - -## 1.2 – Thu, October 21, 2021 - -- **40** [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git) -- **30** [Git quiz](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_quiz.md) -- **20** [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) -- Ask students to prepare *My favorite neat little Git trick* - -## 2.1 – Thu, October 28, 2021 - -- Last chance to ask questions about challenge software, deadline to pick software in the evening -- Does everyone have access to IPVS-SIM GitLab challenge repo? -- We need GitHub accounts to prepare exercise this afternoon. Please read through exercise instructions already. -- **30-45** *[My favorite neat little Git trick*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) -- **25** [Merge vs. rebase](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/merge_rebase_slides.md) -- **20** [Working in teams / git workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/workflow_slides.md) -- **10** [GitHub/GitLab standards](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/standards_slides.md) (could be moved to afternoon block if time is too short) - -## 2.2 – Thu, October 28, 2021 - -- **75** [Exercise: SSE Git cheat sheet](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/cheat_sheet_exercise.md) -- **15** Discussion - -## 3.1 -- Thu, November 04, 2021 - -- **10** [Some Organizational Remarks](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week3_slides.md) -- **5** [Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) -- **10** [Introduction to Virtualization](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_slides.md) -- **40** [VirtualBox (including practical examples)](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_slides.md) -- **25** [Vagrant (including practical examples)](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_slides.md) -- **10** [Introduction to Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/containers_slides.md) - -- Tell students to get/install virtualbox in case they have a machine without Linux and or without root rights. - -## 3.2 -- Thu, November 04, 2021 - -- **5** [Docker quiz: "What is Docker?"](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_quiz.md) -- **60** [Docker (including practical examples)](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_slides.md) -- **20** [Singularity (including practical examples)](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_slides.md) -- **5** Short discussion about [learning goals from introductionary slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) - -- Tell students that for the exercise next week they should have VirtualBox, Vagrant and Docker installed. They can also install Docker inside a VM. - -## 4.1 -- Thu, November 11, 2021 - -- Students that have a machine without Linux and or without root rights should have a virtual box session with Linux installed. -- **90** [Exercise: Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_containers_exercise.md) - -## 4.2 -- Thu, November 11, 2021 - -- The Challenge, step one, presentations - -## 5.1 -- Thu, November 18, 2021 - -- **10** [Building and Packaging Quiz](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_quiz.md) -- **20** [Introduction to Packaging](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/intro_slides.md) -- **60** [Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md) - -## 5.2 -- Thu, November 18, 2021 - -- **90** [Exercise on Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md) - -## 6.1 -- Thu, November 25, 2021 - -- **25** System Paths, Libraries, and How to Use Them: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/systempaths_and_librarytools_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/systempaths_and_librarytools_demo.md) -- **15** Introduction to Make: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_demo.md) -- **45** Introduction to CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_demo.md) - -## 6.2 -- Thu, November 25, 2021 - -- **90** [Let's fight with CMake, Docker, and some dependencies](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_exercise.md) - -## 7.1 -- Thu, December 2, 2021 - -- **50** Creating Debian Packages from CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_demo.md) -- **5** [Some organizational things](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week7_slides.md) - -## 7.2 -- Thu, December 2, 2021 - -- **30** Recap and discussion of CMake exercise from previous week -- **60** [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md) - -## 8.1 -- Thu, December 9, 2021 - -- **45** Packaging for High-Performance Computing and for you: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_demo.md) -- **45** [Exercise: Packages with Spack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_exercise.md) - -## 8.2 -- Thu, December 9, 2021 - -- **90** [Technical Writing](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md) - -## 9.1 -- Thu, December 16, 2021 - -- **20** Lightweight Markup Languages: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_demo.md) -- **70** Code Documentation Tools: : [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/tools_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/tools_demo.md) -- [Homework/exercise: Writing and Publishing Documentation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/tools_exercise.md) - -## 9.2 -- Thu, December 16, 2021 - -- The Challenge, step two, presentations - -## 10.1 -- Thu, January 13, 2022 - -- **30** Introduction to Testing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/intro_slides.md) -- **60** Testing Python Code: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_demo.md) - -## 10.2 -- Thu, January 13, 2022 - -- **90** [Exercise: Testing Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_exercise.md) - -## 11.1 -- Thu, January 20, 2022 - -- **15** Workflow Automation: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_demo.md) -- **35** GitHub Actions: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_gitlab_ci_demo.md) -- **40** GitLab CI/CD: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_demo.md) - -## 11.2 -- Thu, January 20, 2022 - -- [Exercise: Workflow Automation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_exercise.md) - -## 12.1 -- Thu, January 27, 2022 - -- **25** Document conversion with Pandoc : [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_demo.md) - -## 12.2 -- Thu, January 27. 2022 - -- **25** Introduction to `Boost.Test`: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_demo.md) -- **65** Boost.Test and CTest in Action: [SideMade Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_sidemade_demo.md) -- [Exercise/Homework: Boost.Test and CTest in Action: SideMade Exercise](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_exercise.md) - -## 13.1 -- Thu, February 03. 2022 - -- **30** Licenses and copyright: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/floss_licenses_slides.md) -- **10** Versioning: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/versioning_slides.md) -- **10** Repository layout: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/repository_layout_slides.md) -- **15** DOI, Zenodo, and DaRUS: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/doi_zenodo_darus_slides.md) - -## 13.2 -- Thu, February 03. 2022 - -- **15** Software development tools (Alex) [tools_alex_slides.md](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/tools_alex_slides.md), [tools_alex_demo.md](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/tools_alex_demo.md) -- **15** Evaluation (EvaSys) -- **10** Call for master's theses and course participation: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/master_thesis_suggestions_slides.md) diff --git a/00_organization/wt2223/organizational_remarks_week10_slides_old.md b/00_organization/wt2223/organizational_remarks_week10_slides_old.md deleted file mode 100644 index 9b4e487b..00000000 --- a/00_organization/wt2223/organizational_remarks_week10_slides_old.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -type: slide -slideOptions: - transition: slide - width: 1400 - height: 900 - margin: 0.1 - data-background-color: green ---- - - - -# Organizational Things Week 10 - ---- - -## Overview of Upcoming Weeks - -We had to move things around a bit. - - - -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 12.01. |Lecture | 4 | Documentation Tools | Benjamin | -| 12.01. |Lecture | 6 | Licenses, Versioning, Repo Layouts, ... | Benjamin | -| 19.01. |Lecture | 5 | Testing in Python | Ishaan | -| 19.01. |Lab | 5 | Testing in Python | Ishaan | -| 26.01. |Lecture | 5 | Automation, CI/CD | Benjamin | -| 26.01. |Lab | 5 | Automation, CI/CD | Benjamin | -| 02.02. |Lecture | 5 | Boost.Test | Benjamin | -| 02.02. |Lab | 5 | Boost.Test | Benjamin | -| 09.02. |Presentations | C | **final student presentations** | students | -| 09.02. |Presentations | C | **final student presentations** | students | - ---- - -## Challenge Step 3: Suggestions - -- Heterogeneous field: from *"already did good contributions"* to *"not really started"* -- If we think you are doing good, we will not interfere much, but you can of course always ask for input. -- A few have not yet opened an issue in the challenge repo (deadline was Dec 18). Please get in touch with your adviser asap. -- In general, please use the issue to keep us posted about any updates. - ---- - -## Challenge Step 3: Report and Presentations - -- Again report + presentation -- Presentations and deadline for report on Feb 9 -- Issue with detailed instructions will follow soon -- A bit more and a bit longer presentations -- We will assign presenters: - - Everybody should give at least one presentation. - - We will pick nice contributions for additional presentations. diff --git a/00_organization/wt2223/organizational_remarks_week7_slides_old.md b/00_organization/wt2223/organizational_remarks_week7_slides_old.md deleted file mode 100644 index 70a887fb..00000000 --- a/00_organization/wt2223/organizational_remarks_week7_slides_old.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -type: slide -slideOptions: - transition: slide - width: 1400 - height: 900 - margin: 0.1 - data-background-color: green ---- - - - -# Organizational Things Week 7 - ---- - -## Challenge Step 1: MR Feedback - -- Try to write good MR titles and descriptions -- Resolve threads when comments are answered, done, or dropped -- If changes requested: try to fix in same MR -- Approval by reviewer: ready to merge - ---- - -## Challenge Step 1+2: Content - -- Steps 1 and 2 should lead you towards the contribution (step 3) -- Step 1: understand software from user perspective -- Step 2: understand software from dev perspective -- Reports are reports on what you did, not the actual work - ---- - -## Challenge Step 3 - -- Please open an issue in the [challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2223/challenge) explaining what you want to work on for step 3. We will then use these issues to further discuss the progress of the contribution. Provide links to issues, pull requests etc. - - Deadline (for opening the issue): Dec 18, 2022, 23:59 - - If you open earlier, you get feedback earlier - - Latest feedback from teachers: Jan 12, 2023, 09:45 - - Title of issue: "Contribution to SOFTWARE by USERNAME" -- Get in touch with maintainers early (through official channels) - - Discuss before you start developing diff --git a/00_organization/wt2223/timetable.md b/00_organization/wt2223/timetable.md deleted file mode 100644 index 647e5df3..00000000 --- a/00_organization/wt2223/timetable.md +++ /dev/null @@ -1,145 +0,0 @@ -# Time Table - -## 1.1 – Thu, October 20, 2022 - -- **50** [Course planning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/course_intro_slides.md) + questions -- **20** [Introduction to RSE](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/rse_basics_slides.md) -- **20** [Introduction to version control](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/intro_slides.md) - -## 1.2 – Thu, October 20, 2022 - -- **15** [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics) -- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse/) -- **50** [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git) -- **20** [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) -- Ask students to prepare *My favorite neat little Git trick* - -## 2.1 – Thu, October 27, 2022 - -- **15** Introduction to Packaging: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/intro_slides.md) -- **75** Packaging a Python Code: [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md), [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md) - -## 2.2 – Thu, October 27, 2022 - -- **90** [Exercise on Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md) - -## 3.1 – Thu, November 03, 2022 - -- **30-45** [*My favorite neat little Git trick*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) -- Maybe: **30** [Git quiz](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_quiz.md) -- **25** [Merge vs. rebase](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/merge_rebase_slides.md) -- **20** [Working in teams / Git workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/workflow_slides.md) -- **10** [GitHub/GitLab standards](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/standards_slides.md) - -## 3.2 – Thu, November 03, 2022 - -- **90** [Exercise on Git Workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_exercise.md) - -## 4.1 – Thu, November 10, 2022 - -- **5** [Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) -- **10** [Introduction to Virtualization](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_slides.md) -- **40** VirtualBox: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_demo.md) -- **25** Vagrant: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_demo.md) - -## 4.2 – Thu, November 10, 2022 - -- The Challenge, step one, presentations - -## 5.1 – Thu, November 17, 2022 - -- **10** [Introduction to Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/containers_slides.md) -- **60** Docker: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_demo.md) -- **20** Singularity: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_demo.md) - -## 5.2 – Thu, November 17, 2022 - -- **90** [Exercise: Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_containers_exercise.md) - -## 6.1 – Thu, November 24, 2022 - -- **25** Some Linux fundamentals: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_demo.md) -- **20** Introduction to Make: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_demo.md) -- **45** Introduction to CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_demo.md) - -## 6.2 – Thu, November 24, 2022 - -- **90** [Exercise: Let's Fight With CMake, Docker, and Some Dependencies](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_exercise.md) - -## 7.1 – Thu, December 1, 2022 - -- **70** Installation and Packaging with CMake and CPack: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_demo.md) -- **20** More CMake Demo (preCICE and ccmake): [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_more_demo.md) - -## 7.2 – Thu, December 1, 2022 - -- **10** [Organizational remarks](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week7_slides.md) -- **80** [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md) - -## 8.1 – Thu, December 8, 2022 - -- **90** Packaging for High-Performance Computing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_demo.md) - -## 8.2 – Thu, December 8, 2022 - -- **90** [Exercise: Packaging with Spack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_exercise.md) - -## 9.1 – Thu, December 15, 2022 - -- **90** Technical Writing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_demo.md) - -## 9.2 – Thu, December 15, 2022 - -- The Challenge, step two, presentations - -## 10.1 – Thu, January 12, 2023 - -- **10** [Organizational remarks](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week10_slides.md) -- **25** Markup Languages: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_slides.md) -- **20** Pandoc: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_demo.md) -- **35** Documentation Website Generators: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_demo.md) - -## 10.2 – Thu, January 12, 2023 - -- **20** [Floss Licenses](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/floss_licenses_slides.md) -- **20** [Versioning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/versioning_slides.md) -- **20** [Repository Layouts](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/repository_layouts_slides.md) -- **20** [DOI, Zenodo, DaRUS](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/doi_zenodo_darus_slides.md) - -## 11.1 – Thu, January 19, 2023 - -- **20** Introduction to Testing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/intro_slides.md) -- **70** Testing Python Code: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_demo.md) - -## 11.2 – Thu, January 19, 2023 - -- **90** [Exercise: Testing Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_exercise.md) - -## 12.1 – Thu, January 26, 2023 - -- **15** [Automation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_slides.md) -- **45** GitHub Actions: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_demo.md) -- **30** GitLab CI: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_demo.md) - -## 12.2 – Thu, January 26, 2023 - -- **90** [Exercise: Automating Workflows with GitHub Actions](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_exercise.md) - -## 13.1 – Thu, February 2, 2023 - -- **20** Introduction to Boost.Test: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_demo.md) -- **60** [Boost.Test and CTest in Action: SideMade Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_sidemade_demo.md) -- **10** [Boost.Test in the Real World: preCICE Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_precice_demo.md) - -## 13.2 – Thu, February 2, 2023 - -- **15** Lecture evaluation -- **75** [Boost.Test and CTest in Action: SideMade Exercise](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_exercise.md) - -## 14.1 – Thu, February 9, 2023 - -- The Challenge, step three, presentations - -## 14.2 – Thu, February 9, 2023 - -- The Challenge, step three, presentations diff --git a/00_organization/wt2425/organizational_remarks_week8_slides.md b/00_organization/wt2425/organizational_remarks_week8_slides.md deleted file mode 100644 index 132e66ea..00000000 --- a/00_organization/wt2425/organizational_remarks_week8_slides.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -type: slide -slideOptions: - transition: slide - width: 1400 - height: 900 - margin: 0.1 - data-background-color: green ---- - - - -# Organizational Things Week 8 - ---- - -## Time Table - - - -| Date | Type | Chapter | Topic | Lecturer | -| ---- | ---- | ------- |------ | -------- | -| 13.11. |Lecture | 3 | Intro packaging, Python packaging | Ishaan | -| 13.11. |Lab | 3 | Python packaging | Ishaan | -| 20.11. |Lecture | 3 | Linux fundamentals, Make, CMake | Benjamin | -| 20.11. |Lab | 3 | CMake and Docker | Benjamin | -| 27.11. |Lecture | 3 | Spack | Ishaan | -| 27.11. |Lab | 3 | Spack | Ishaan | -| **04.12.** |**Lecture** | **3** | **CPack and more CMake** | **Benjamin** | -| 04.12. |Lab | 3 | CPack | Benjamin | -| 11.12. |Lecture | 4 | Technical writing | Gerasimos | -| 11.12. |Presentations | C | 2nd student presentations | students | - ---- - -## Challenge First Report: MR Feedback - -- Try to write good MR titles and descriptions -- Resolve threads when comments are answered, done, or dropped -- If changes requested: try to fix in same MR -- Approval by reviewer: ready to merge -- All MRs should get merged - ---- - -## Challenge Contribution - -- Please open an issue in the [challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2425/challenge) explaining what you want to work on in the contribution. We will then use these issues to further discuss the progress of the contribution. Provide links to issues, pull requests etc. - - Deadline (for opening the issue): Dec 16, 2024, 23:59 - - If you open earlier, you get feedback earlier - - Latest feedback from teachers: Jan 8, 2025, 09:45 - - Title of issue: "Contribution to SOFTWARE by USERNAME" -- Get in touch with maintainers early (through official channels) - - Discuss before you start developing diff --git a/00_organization/wt2425/timetable.md b/00_organization/wt2425/timetable.md deleted file mode 100644 index ca9d7a03..00000000 --- a/00_organization/wt2425/timetable.md +++ /dev/null @@ -1,143 +0,0 @@ -# Time Table - -## 1.1 – Wed, October 16, 2024 - -- **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) - -## 1.2 – Wed, October 16, 2024 - -- **15** min.: [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics) -- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse) -- **50** min.: [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git) -- **20** min.: [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) -- Ask students to prepare *My favorite neat little Git trick* - -## 2.1 – Wed, October 23, 2024 - -- **30** min.: [*My favorite neat little Git trick*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) -- **25** min.: [Merge vs. rebase](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/merge_rebase_slides.md) -- **25** min.: [Working in teams / Git workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/workflow_slides.md) -- **10** min.: [GitHub/GitLab standards](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/standards_slides.md) - -## 2.2 – Wed, October 23, 2024 - -- **90** min.: [Exercise on Git Workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_exercise.md) - -## 3.1 – Wed, October 30, 2024 - -- **5** min.: [Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) -- **10** min.: [Introduction to Virtualization](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_slides.md) -- **40** min.: VirtualBox: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_demo.md) -- **25** min.: Vagrant: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_demo.md) - -## 3.2 – Wed, October 30, 2024 - -- **10** min.: [Introduction to Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/containers_slides.md) -- **60** min.: Docker: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_demo.md) -- **20** min.: Singularity: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_demo.md) - -## 4.1 – Wed, November 6, 2024 - -- **90** min.: [Exercise: Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_containers_exercise.md) - -## 4.2 – Wed, November 6, 2024 - -- The Challenge, step one, presentations - -## 5.1 – Wed, November 13, 2024 - -- **15** min.: Introduction to Packaging: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/intro_slides.md) -- **75** min.: Packaging a Python Code: [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md), [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md) - -## 5.2 – Wed, November 13, 2024 - -- **90** min.: [Exercise on Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md) - -## 6.1 – Wed, November 20, 2024 - -- **25** min.: Some Linux fundamentals: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_demo.md) -- **20** min.: Introduction to Make: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_demo.md) -- **45** min.: Introduction to CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_demo.md) - -## 6.2 – Wed, November 20, 2024 - -- **90** min.: [Exercise: Let's Fight With CMake, Docker, and Some Dependencies](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_exercise.md) - -## 7.1 – Wed, November 27, 2024 - -- **90** min.: Packaging for High-Performance Computing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_demo.md) - -## 7.2 – Wed, November 27, 2024 - -- **90** min.: [Exercise: Packaging with Spack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_exercise.md) - -## 8.1 – Wed, December 4, 2024 - -- **5** min.: Organizational remarks: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week8_slides.md) -- **65** min.: Installation and Packaging with CMake and CPack: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_demo.md) -- **20** min.: More CMake Demo (preCICE and ccmake): [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_more_demo.md) - -## 8.2 – Wed, December 4, 2024 - -- **90** min.: [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md) - -## 9.1 – Wed, December 11, 2024 - -- **90** min.: Technical Writing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_demo.md) - -## 9.2 – Wed, December 11, 2024 - -- The Challenge, step two, presentations - -## 10.1 – Wed, January 8, 2025 - -- **25** min.: Markup Languages: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_slides.md) -- **20** min.: Pandoc: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_demo.md) -- **35** min.: Documentation Website Generators: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_demo.md) - -## 10.2 – Wed, January 8, 2025 - -- **20** min.: [Floss Licenses](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/floss_licenses_slides.md) -- **20** min.: [Versioning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/versioning_slides.md) -- **20** min.: [Repository Layouts](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/repository_layouts_slides.md) -- **20** min.: [DOI, Zenodo, DaRUS](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/doi_zenodo_darus_slides.md) - -## 11.1 – Wed, January 15, 2025 - -- **20** min.: Introduction to Testing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/intro_slides.md) -- **70** min.: Testing Python Code: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_demo.md) - -## 11.2 – Wed, January 15, 2025 - -- **90** min.: [Exercise: Testing Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_exercise.md) - -## 12.1 – Wed, January 22, 2025 - -- **15** min.: [Automation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_slides.md) -- **45** min.: GitHub Actions: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_demo.md) -- **30** min.: GitLab CI: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_demo.md) - -## 12.2 – Wed, January 22, 2025 - -- **90** min.: [Exercise: Automating Workflows with GitHub Actions](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_exercise.md) - -## 13.1 – Wed, January 29, 2025 - -- **20** min.: Introduction to Boost.Test: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_demo.md) -- **60** min.: [Boost.Test and CTest in Action: SideMade Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_sidemade_demo.md) -- **10** min.: [Boost.Test in the Real World: preCICE Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_precice_demo.md) - -## 13.2 – Wed, January 29, 2025 - -- **90** min.: [Boost.Test and CTest in Action: SideMade Exercise](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_exercise.md) - -## 14.1 – Wed, February 5, 2025 - -- The Challenge, step three, presentations - -## 14.2 – Wed, February 5, 2025 - -- The Challenge, step three, presentations diff --git a/01_version_control/git_exercise.md b/01_version_control/git_exercise.md index ee0a8ea9..b2f6aed8 100644 --- a/01_version_control/git_exercise.md +++ b/01_version_control/git_exercise.md @@ -1,6 +1,6 @@ # Exercise: Git Workflows -Deadline: **Wednesday, October 29, 2025, 9:00** +Deadline: **Wednesday, October 28, 2026, 9:00** ## Preparation diff --git a/02_virtualization_and_containers/virtualmachines_containers_exercise.md b/02_virtualization_and_containers/virtualmachines_containers_exercise.md index 7c3673b3..c8b03d42 100644 --- a/02_virtualization_and_containers/virtualmachines_containers_exercise.md +++ b/02_virtualization_and_containers/virtualmachines_containers_exercise.md @@ -2,7 +2,7 @@ In this exercise, we work with the virtualization and container techniques that we have seen in the lecture. We set up a virtual machine manually first and then automate the process using Vagrant. Afterwards, we build our own container using Docker. -Deadline: **Wednesday, November 5, 2025, 9:00** +Deadline: **Wednesday, November 4, 2026, 9:00** ## Prerequisites diff --git a/03_building_and_packaging/cmake_exercise.md b/03_building_and_packaging/cmake_exercise.md index 34028e65..3f557d44 100644 --- a/03_building_and_packaging/cmake_exercise.md +++ b/03_building_and_packaging/cmake_exercise.md @@ -4,7 +4,7 @@ In this exercise, we need to fight. Not everything always works smoothly. This i To get an independent and reproducible environment as common ground, we use and, thus repeat, Docker. -Deadline: **Wednesday, November 26th, 2025, 9:00** +Deadline: **Wednesday, November 25, 2026, 9:00** ## Overview diff --git a/03_building_and_packaging/cpack_exercise.md b/03_building_and_packaging/cpack_exercise.md index ea1e3960..0ecc6e43 100644 --- a/03_building_and_packaging/cpack_exercise.md +++ b/03_building_and_packaging/cpack_exercise.md @@ -2,7 +2,7 @@ Let us try to package the code from the CMake exercise with CPack, such that we can give the (binary) software to somebody else. -Deadline: **December 10, 2025, 9:00** +Deadline: **December 9, 2026, 9:00** ## Overview diff --git a/03_building_and_packaging/spack_exercise.md b/03_building_and_packaging/spack_exercise.md index 809d9b04..206b823c 100644 --- a/03_building_and_packaging/spack_exercise.md +++ b/03_building_and_packaging/spack_exercise.md @@ -4,7 +4,7 @@ This exercise is about packaging code with Spack. We work with a simplified vers **Note**: At the end of the exercise you find a section with hints and remarks. Make sure to check this section. -Deadline: **Wednesday, December 3rd, 2025, 09:00** +Deadline: **Wednesday, December 2, 2026, 09:00** ## Creation of a Spack Package diff --git a/04_documentation/reviewing_exercise.md b/04_documentation/reviewing_exercise.md index 4474912c..9e11a4ed 100644 --- a/04_documentation/reviewing_exercise.md +++ b/04_documentation/reviewing_exercise.md @@ -2,7 +2,7 @@ Let us get familiar with code review tools and practices. -Deadline: **December 17, 2025, 9:00** +Deadline: **December 16, 2026, 9:00** **Note:** In this exercise, we use GenAI tools, which evolve rapidly. Feedback and suggestions are very welcome - [open an issue](https://github.com/Simulation-Software-Engineering/Lecture-Material/issues). diff --git a/README.md b/README.md index 1ffefeea..3fed8518 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Material of the Simulation Software Engineering lecture. There are different ways how to get an overview: -- Look at `timetable.md` of the [current course](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/timetable.md) or [a previous course](https://github.com/Simulation-Software-Engineering/Lecture-Material/tree/main/00_organization/wt2425/timetable.md), or +- Look at `timetable.md` of the [current course](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/timetable.md) or [a previous course](https://github.com/Simulation-Software-Engineering/Lecture-Material/tree/main/00_organization), or - Look at the `README.md` files of each chapter / folder. Please note that we update the material over the course of each semester. diff --git a/timetable.md b/timetable.md index a048edb9..c1b2498d 100644 --- a/timetable.md +++ b/timetable.md @@ -1,144 +1,215 @@ -# Time Table +# Timetable + +| Week | Date | Type | Description | Lecturer | +| --- | --- | --- | --- | --- | +| [1](#week-1) | 14.10. | 🧑‍🏫 | Course intro, intro to SSE, VC basics | Gerasimos | +| | | 🧑‍🏫 | Git basics, my Git workflow, Git quiz, how to challenge | Gerasimos | +| [2](#week-2) | 21.10. | 🧑‍🏫 | *My neat little Git trick*, merge vs rebase, working in teams | Frédéric | +| | | 💻️ | Git | Frédéric | +| | | ⚠️ | **Deadline:** Register for the Challenge | | +| [3](#week-3) | 28.10. | 🧑‍🏫 | Virtualization and containers | Gerasimos | +| | | 💻️ | Containers | Gerasimos | +| [4](#week-4) | 04.11. | 🎉 | Student presentations: Challenge - step 1 | | +| | | 🎉 | Student presentations: Challenge - step 1 | | +| [5](#week-5) | 11.11. | 🧑‍🏫 | Intro packaging, Python packaging | Felix | +| | | 💻️ | Python packaging | Felix | +| [6](#week-6) | 18.11. | 🧑‍🏫 | Linux fundamentals, Make, CMake | Gerasimos | +| | | 💻️ | CMake and Docker | Gerasimos | +| [7](#week-7) | 25.11. | 🧑‍🏫 | Spack | Frédéric | +| | | 💻️ | Spack | Frédéric | +| [8](#week-8) | 02.12. | 🧑‍🏫 | CPack and more CMake | Frédéric | +| | | 💻️ | CPack | Frédéric | +| [9](#week-9) | 09.12. | 🧑‍🏫 | Technical writing | Gerasimos | +| | | 💻️ | Code review | Gerasimos | +| [10](#week-10) | 16.12. | 🎉 | Student presentations: Challenge - step 2 | | +| | | 🎉 | Student presentations: Challenge - step 2 | | +| | | ⚠️ | **Deadline:** Suggest a Challenge contribution | | +| - | 23.12. | 🎄 | _Christmasn break_ | | +| - | 30.12. | 🎄 | _Christmasn break_ | | +| - | 06.01. | 🎄 | _Christmasn break_ | | +| [11](#week-11) | 13.01. | 🧑‍🏫 | Intro testing, testing in Python | Felix | +| | | 💻️ | Testing in Python | Felix | +| [12](#week-12) | 20.01. | 🧑‍🏫 | Markup, Pandoc, website gener. | Felix | +| | | 🧑‍🏫 | FLOSS, versioning, repo layouts, DOI, Zenodo, DaRUS | Gerasimos | +| [13](#week-13) | 27.01. | 🧑‍🏫 | Automation, GitHub Actions, GitLab CI | Felix | +| | | 💻️ | GitHub Actions | Felix | +| [14](#week-14) | 03.02. | 🧑‍🏫 | Boost.Test and CTest | Frédéric | +| | | 💻️ | Boost.Test and CTest | Frédéric | +| [15](#week-15) | 10.02. | 🎉 | Student presentations: Challenge - step 3 | | +| | | 🎉 | Student presentations: Challenge - step 3 | | + +This timetable is for the winter term 2026-27. + +Resources: + +- [Challenge respository](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2627/challenge) + +## Week 1 + +Introduction and Chapter 1: Version Control + +- Morning: + - **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) +- Afternoon: + - **15** min.: [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics) + - Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse) + - **50** min.: [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git) + - **20** min.: [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) + - Ask students to prepare *My favorite neat little Git trick* + +## Week 2 + +Chapter 1: Version Control (cont.) + +- Morning: + - **30** min.: [*My favorite neat little Git trick*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) + - **25** min.: [Merge vs. rebase](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/merge_rebase_slides.md) + - **25** min.: [Working in teams / Git workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/workflow_slides.md) + - **10** min.: [GitHub/GitLab standards](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/standards_slides.md) +- Afternoon: + - **90** min.: [Exercise on Git Workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_exercise.md) + +**Deadline:** (23:59) Register for the Challenge. + +## Week 3 + +Chapter 2: Virtualization and Containers + +- Morning: + - **5** min.: [Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) + - **15** min.: VirtualBox: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_demo.md) + - **20** min.: Vagrant: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_demo.md) + - **30** min.: Docker: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_demo.md) + - **20** min.: Singularity / Apptainer: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_demo.md) +- Afternoon: + - **90** min.: [Exercise: Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_containers_exercise.md) + +## Week 4 + +Student presentations + +- Morning: + - The Challenge, step one, presentations +- Afternoon: + - The Challenge, step one, presentations + +## Week 5 + +Chapter 3: Building and Packaging - Python + +- Morning: + - **15** min.: [Introduction to Packaging](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/intro_slides.md) + - **75** min.: Packaging a Python Code: [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pip_demo.md), [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md) +- Afternoon: + - **90** min.: [Exercise on Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md) + +## Week 6 + +Chapter 3: Building and Packaging - Linux -## 1.1 – Wed, October 15, 2025 +- Morning: + - **25** min.: Some Linux fundamentals: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_demo.md) + - **20** min.: Introduction to Make: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_demo.md) + - **45** min.: Introduction to CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_demo.md) +- Afternoon: + - **90** min.: [Exercise: Let's Fight With CMake, Docker, and Some Dependencies](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_exercise.md) -- **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) +## Week 7 -## 1.2 – Wed, October 15, 2025 +Chapter 3: Building and Packaging - Spack -- **15** min.: [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics) -- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse) -- **50** min.: [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git) -- **20** min.: [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md) -- Ask students to prepare *My favorite neat little Git trick* +- Morning: + - **90** min.: Packaging for High-Performance Computing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_demo.md) +- Afternoon: + - **90** min.: [Exercise: Packaging with Spack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_exercise.md) -## 2.1 – Wed, October 22, 2025 +## Week 8 -- **30** min.: [*My favorite neat little Git trick*](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/my_favorite_neat_little_git_trick_demo.md) -- **25** min.: [Merge vs. rebase](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/merge_rebase_slides.md) -- **25** min.: [Working in teams / Git workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/workflow_slides.md) -- **10** min.: [GitHub/GitLab standards](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/standards_slides.md) +Chapter 3: Building and Packaging - CMake and CPack -## 2.2 – Wed, October 22, 2025 +- Morning: + - **5** min.: Organizational remarks: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week8_slides.md) + - **65** min.: Installation and Packaging with CMake and CPack: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_demo.md) + - **20** min.: More CMake Demo (preCICE and ccmake): [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_more_demo.md) +- Afternoon: + - **90** min.: [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md) -- **90** min.: [Exercise on Git Workflows](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_exercise.md) +## Week 9 -## 3.1 – Wed, October 29, 2025 +Chapter 4: Documentation - Technical Writing, Code Review -- **5** min.: [Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/intro_slides.md) -- **15** min.: VirtualBox: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualbox_demo.md) -- **20** min.: Vagrant: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/vagrant_demo.md) -- **30** min.: Docker: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/docker_demo.md) -- **20** min.: Singularity / Apptainer: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/singularity_demo.md) +- Morning: + - **90** min.: Technical Writing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_demo.md) +- Afternoon: + - **90** min.: [Exercise: Reviewing with AI tools](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/reviewing_exercise.md) -## 3.2 – Wed, October 29, 2025 +## Week 10 -- **90** min.: [Exercise: Virtualization and Containers](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/02_virtualization_and_containers/virtualmachines_containers_exercise.md) +Student presentations -## 4.1 – Wed, November 5, 2025 +- Morning: + - The Challenge, step two, presentations +- Afternoon: + - The Challenge, step two, presentations -- The Challenge, step one, presentations +**Deadline:** Suggest a Challenge contribution. -## 4.2 – Wed, November 5, 2025 +## Week 11 -- The Challenge, step one, presentations +Chapter 5: Testing and Continuous Integration - Python -## 5.1 – Wed, November 12, 2025 +- Morning: + - **20** min.: Introduction to Testing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/intro_slides.md) + - **70** min.: Testing Python Code: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_demo.md) +- Afternoon: + - **90** min.: [Exercise: Testing Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_exercise.md) -- **15** min.: [Introduction to Packaging](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/intro_slides.md) -- **75** min.: Packaging a Python Code: [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pip_demo.md), [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_slides.md) +## Week 12 -## 5.2 – Wed, November 12, 2025 +Chapter 4: Documentation - Tools,
+Chapter 6: Miscellaneous - Publishing and Free Software -- **90** min.: [Exercise on Packaging a Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/pypi_exercise.md) +- Morning: + - **25** min.: Markup Languages: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_slides.md) + - **20** min.: Pandoc: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_demo.md) + - **35** min.: Documentation Website Generators: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_demo.md) +- Afternoon: + - **20** min.: [Floss Licenses](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/floss_licenses_slides.md) + - **20** min.: [Versioning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/versioning_slides.md) + - **20** min.: [Repository Layouts](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/repository_layouts_slides.md) + - **20** min.: [DOI, Zenodo, DaRUS](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/doi_zenodo_darus_slides.md) -## 6.1 – Wed, November 19, 2025 +## Week 13 -- **25** min.: Some Linux fundamentals: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/linux_fundamentals_demo.md) -- **20** min.: Introduction to Make: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/make_demo.md) -- **45** min.: Introduction to CMake: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_demo.md) +Chapter 5: Testing and Continuous Integration - GitHub Actions and GitLab CI -## 6.2 – Wed, November 19, 2025 +- Morning: + - **15** min.: [Automation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_slides.md) + - **45** min.: GitHub Actions: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_demo.md) + - **30** min.: GitLab CI: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_demo.md) +- Afternoon: + - **90** min.: [Exercise: Automating Workflows with GitHub Actions](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_exercise.md) -- **90** min.: [Exercise: Let's Fight With CMake, Docker, and Some Dependencies](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_exercise.md) +## Week 14 -## 7.1 – Wed, November 26, 2025 +Chapter 5: Testing and Continuous Integration - Boost.Test and CTest -- **90** min.: Packaging for High-Performance Computing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_demo.md) +- Morning: + - **20** min.: Introduction to Boost.Test: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_demo.md) + - **15** min.: [Lecture evaluation](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2526/challenge/-/issues/42) + - **60** min.: [Boost.Test and CTest in Action: SideMade Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_sidemade_demo.md) + - **10** min.: [Boost.Test in the Real World: preCICE Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_precice_demo.md) +- Afternoon: + - **90** min.: [Boost.Test and CTest in Action: SideMade Exercise](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_exercise.md) -## 7.2 – Wed, November 26, 2025 +## Week 15 -- **90** min.: [Exercise: Packaging with Spack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/spack_exercise.md) +Student presentations -## 8.1 – Wed, December 3, 2025 - -- **5** min.: Organizational remarks: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/organizational_remarks_week8_slides.md) -- **65** min.: Installation and Packaging with CMake and CPack: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_demo.md) -- **20** min.: More CMake Demo (preCICE and ccmake): [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cmake_more_demo.md) - -## 8.2 – Wed, December 3, 2025 - -- **90** min.: [Exercise: Packaging with CPack](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/03_building_and_packaging/cpack_exercise.md) - -## 9.1 - Wed, December 10, 2025 - -- **90** min.: Technical Writing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/technical_writing_demo.md) - -## 9.2 - Wed, December 10, 2025 - -- **90** min.: [Exercise: Reviewing with AI tools](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/reviewing_exercise.md) - -## 10.1 – Wed, December 17, 2025 - -- [Day of Research Software at the Uni Stuttgart, March 2, 2026](https://www.iws.uni-stuttgart.de/en/lh2/conferences-seminars-workshops/research-software-day/) -- The Challenge, step two, presentations - -## 10.2 – Wed, December 17, 2025 - -- The Challenge, step two, presentations - -## 11.1 – Wed, January 7, 2026 - -- **25** min.: Markup Languages: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/markup_languages_slides.md) -- **20** min.: Pandoc: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/pandoc_demo.md) -- **35** min.: Documentation Website Generators: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/04_documentation/website_generators_demo.md) - -## 11.2 – Wed, January 7, 2026 - -- **20** min.: [Floss Licenses](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/floss_licenses_slides.md) -- **20** min.: [Versioning](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/versioning_slides.md) -- **20** min.: [Repository Layouts](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/repository_layouts_slides.md) -- **20** min.: [DOI, Zenodo, DaRUS](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/06_miscellaneous/doi_zenodo_darus_slides.md) - -## 12.1 – Wed, January 14, 2026 - -- **20** min.: Introduction to Testing: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/intro_slides.md) -- **70** min.: Testing Python Code: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_demo.md) - -## 12.2 – Wed, January 14, 2026 - -- **90** min.: [Exercise: Testing Python Code](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/python_testing_exercise.md) - -## 12.1 – Wed, January 21, 2026 - -- **15** min.: [Automation](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_slides.md) -- **45** min.: GitHub Actions: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/github_actions_demo.md) -- **30** min.: GitLab CI: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/gitlab_ci_demo.md) - -## 12.2 – Wed, January 21, 2026 - -- **90** min.: [Exercise: Automating Workflows with GitHub Actions](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/automation_exercise.md) - -## 13.1 – Wed, January 28, 2026 - -- **20** min.: Introduction to Boost.Test: [slides](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_slides.md), [demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_intro_demo.md) -- **15** min.: [Lecture evaluation](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2526/challenge/-/issues/42) -- **60** min.: [Boost.Test and CTest in Action: SideMade Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_sidemade_demo.md) -- **10** min.: [Boost.Test in the Real World: preCICE Demo](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_precice_demo.md) - -## 13.2 – Wed, January 28, 2026 - -- **90** min.: [Boost.Test and CTest in Action: SideMade Exercise](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/05_testing_and_ci/boost_testing_exercise.md) +- Morning: + - The Challenge, step three, presentations +- Afternoon: + - The Challenge, step three, presentations