-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update orga slides for WT2425 (#183)
- Loading branch information
Showing
2 changed files
with
107 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,10 @@ slideOptions: | |
| .reveal section h2 { | ||
| color: orange; | ||
| } | ||
| .reveal section h3 { | ||
| color: orange; | ||
| text-align: left; | ||
| } | ||
| .reveal code { | ||
| font-family: 'Ubuntu Mono'; | ||
| color: orange; | ||
|
|
@@ -40,6 +44,7 @@ slideOptions: | |
| ## The Lecturers | ||
|
|
||
| - Benjamin (Uekermann) [`@uekerman`](https://github.com/uekerman) | ||
| - Gerasimos (Chourdakis) [`@MakisH`](https://github.com/MakisH) | ||
| - Ishaan (Desai) [`@IshaanDesai`](https://github.com/IshaanDesai) | ||
|
|
||
| SSE Hall of Fame: | ||
|
|
@@ -66,13 +71,13 @@ SSE Hall of Fame: | |
| Two parallel branches: | ||
|
|
||
| - **Weekly lectures** (90 mins) and **exercises** (90 mins) to learn and train concepts and tools | ||
| - Thursdays, 09:45–11:15 and 15:45–17:15 | ||
| - This room: 38-0.124 | ||
| - Wednesdays, 09:45–11:15 and 15:45–17:15 | ||
| - This room: 38-0.108 | ||
| - No strict distinction between lecture and exercise | ||
| - Interactive style (not a theory course) | ||
| - **Individual challenge**: contribute to real simulation software :rocket: | ||
| - List of software candidates: this afternoon | ||
| - 3 presentations from you (more later) | ||
| - 3 rounds of presentations from you (more later) | ||
| - You get a direct advisor | ||
| - Use exercise blocks and time after lectures for discussions | ||
|
|
||
|
|
@@ -89,28 +94,34 @@ Two parallel branches: | |
| ## Prerequisites: Infrastructure | ||
|
|
||
| - GitHub account | ||
| - We'll create an IPVS-SIM GitLab account for everyone | ||
| - We will create IPVS-SIM GitLab accounts for everyone | ||
| - Laptop with root access | ||
| - You should be able to install and configure software. | ||
| - OK if we use Slido? | ||
| - Signed up on C@MPUS? | ||
|
|
||
| --- | ||
|
|
||
| ## Waiting List | ||
|
|
||
| - Students who have a fixed spot (top 40) in either the lecture or the exercise get in. | ||
| - We take 50 students in total. | ||
| - Remaining spots are filled by waiting list provided presence or excused today. | ||
| - We manually add these students at the end of this week. | ||
|
|
||
| --- | ||
|
|
||
| ## Material | ||
|
|
||
| - Great new open-source book to recap: Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: [Research Software Engineering with Python](https://merely-useful.tech/py-rse) | ||
| - Great open-source book to recap: Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: [Research Software Engineering with Python](https://third-bit.com/py-rse/) | ||
| - All our material is on [https://github.com/Simulation-Software-Engineering](https://github.com/Simulation-Software-Engineering) | ||
| - Mainly markdown ... use your favorite tool to render (simply GitHub viewer, [GWDG Hedgedoc](https://pad.gwdg.de/), [stuvus Hedgedoc](https://pad.stuvus.de/), [pandoc](https://pandoc.org/), [PDFs generated in CI](https://github.com/Simulation-Software-Engineering/Lecture-Material/actions/workflows/create-pdfs-from-markdown.yml), [Marp example](https://github.com/uekerman/sse-marp-example), ...) | ||
| - We rework the material as the semester goes | ||
| - We rework the material as the semester goes. | ||
| - We give many links to videos, docs, blog posts, podcasts, ... | ||
| - Recordings of the lecture from last year as a backup on ILIAS. Please always come when possible. What we do is interactive. | ||
|
|
||
| --- | ||
|
|
||
| ## Contribute to the Material | ||
|
|
||
| - You, no joke :see_no_evil: ([many students contributed last year](https://github.com/Simulation-Software-Engineering/Lecture-Material/graphs/contributors)) | ||
| - You, no joke :see_no_evil: ([many students already contributed](https://github.com/Simulation-Software-Engineering/Lecture-Material/graphs/contributors)) | ||
| - Typos, broken links, ... | ||
| - Additional material | ||
| - By definition, we study quickly evolving technology ... help us staying up to date | ||
|
|
@@ -135,10 +146,17 @@ Two parallel branches: | |
|
|
||
| ## The Challenge | ||
|
|
||
| 1. Pick a large-scale open-source simulation software (FEniCS, PETSc, SU2, TRILINOS, ...) (till **Oct 27**, evening) | ||
| 2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 10**) | ||
| 3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 15**) | ||
| 4. Contribute something small (but not trivial) to the software (*"good first issue"*). Run through complete contribution cycle (issue, discussion, PR, review, merge). Present what you did. Examples: feature, tutorial, documentation, support of new packaging tool, bugfix, ... (**Feb 9**) | ||
| - Contribute something small (but not trivial) to a large-scale open-source simulation software (*"good first issue"*) | ||
| - Examples: feature, tutorial, documentation, new packaging, bugfix, ... | ||
| - Run through complete cycle (issue, discussion, PR, review, merge) | ||
|
|
||
| ### Timeline | ||
|
|
||
| 1. Pick a software (till **Oct 23**, evening) | ||
| 2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 6**) | ||
| 3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 11**) | ||
| 4. Suggest contribution (**Dec 16**) | ||
| 5. Present the contribution (**Feb 5**) | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -152,14 +170,14 @@ td { | |
|
|
||
| | Date | Type | Chapter | Topic | Lecturer | | ||
| | ---- | ---- | ------- |------ | -------- | | ||
| | 20.10. |Lecture | 0-1 | Course intro, intro to SSE, VC basics | Benjamin | | ||
| | 20.10. |Lecture | 1 | Git: my workflow + quiz, software projects for challenge | Benjamin | | ||
| | 27.10. |Lecture | 3 | Packaging, pip and PyPI | Ishaan | | ||
| | 27.10. |Lab | 3 | pip and PyPI exercise | Ishaan | | ||
| | 03.11. |Lecture + presentations| 1 | *"My neat little Git trick"*, merge vs rebase, working in teams| Benjamin | | ||
| | 03.11. |Lab | 1 | Git exercise | Ishaan | | ||
| | 10.11. |Lecture | 2 | Virtual machines | Ishaan | | ||
| | 10.11. |Presentations | C | **1st student presentations** | students | | ||
| | 16.10. |Lecture | 0-1 | Course intro, intro to SSE, VC basics | Benjamin | | ||
| | 16.10. |Lecture | 1 | Git basics, my Git workflow, Git quiz, how to challenge | Benjamin | | ||
| | 23.10. |Lecture | 1 | *My neat little Git trick*, merge vs rebase, working in teams| Benjamin | | ||
| | 23.10. |Lab | 1 | Git | Benjamin | | ||
| | 30.10. |Lecture | 2 | Intro containers, Docker, Singularity | Gerasimos | | ||
| | 30.10. |Lecture | 2 | Intro virtualization, VirtualBox, Vagrant | Gerasimos | | ||
| | 06.11. |Lab | 2 | Virtualization and containers | Gerasimos | | ||
| | 06.11. |Presentations | C | **1st student presentations** | students | | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -173,16 +191,16 @@ td { | |
|
|
||
| | Date | Type | Chapter | Topic | Lecturer | | ||
| | ---- | ---- | ------- |------ | -------- | | ||
| | 17.11. |Lecture | 2 | Containers | Ishaan | | ||
| | 17.11. |Lab | 2 | Virtual machines and containers | Ishaan | | ||
| | 24.11. |Lecture | 3 | Make and CMake | Benjamin | | ||
| | 24.11. |Lab | 3 | CMake | Benjamin | | ||
| | 01.12. |Lecture | 3 | CPack, Debian packages | tbd. | | ||
| | 01.12. |Lab | 3 | CPack, Debian packages | tbd. | | ||
| | 08.12. |Lecture + Lab | 3 | Spack | Ishaan | | ||
| | 08.12. |Lecture | 4 | tbd. | Benjamin | | ||
| | 15.12. |Lecture | 4 | tbd. | Benjamin | | ||
| | 15.12. |Presentations | C | **2nd student presentations** | students | | ||
| | 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 | | ||
|
|
||
| --- | ||
|
|
||
|
|
@@ -196,37 +214,37 @@ td { | |
|
|
||
| | Date | Type | Chapter | Topic | Lecturer | | ||
| | ---- | ---- | ------- |------ | -------- | | ||
| | 12.01. |Lecture | 5 | Testing in Python | Ishaan | | ||
| | 12.01. |Lab | 5 | Testing in Python | Ishaan | | ||
| | 19.01. |Lecture | 5 | Automation, CI/CD | Benjamin | | ||
| | 19.01. |Lab | 5 | Automation, CI/CD | Benjamin | | ||
| | 26.01. |Lecture | 5 | Boost.Test | Benjamin | | ||
| | 26.01. |Lab | 5 | Boost.Test | Benjamin | | ||
| | 02.02. |Lecture | 6 | Licenses, versioning, ... | Benjamin | | ||
| | 02.02. |Lecture | 6 | tbd. | tbd. | | ||
| | 09.02. |Presentations | C | **final student presentations** | students| | ||
| | 09.02. |Presentations | C | **final student presentations** | students| | ||
| | 08.01. |Lecture | 4 | Markup, Pandoc, website gener. | Benjamin | | ||
| | 08.01. |Lecture | 6 | FLOSS, versioning, repo layouts, DOI, Zenodo, DaRUS | Benjamin | | ||
| | 15.01. |Lecture | 5 | Intro testing, testing in Python | Ishaan | | ||
| | 15.01. |Lab | 5 | Testing in Python | Ishaan | | ||
| | 22.01. |Lecture | 5 | Automation, GitHub Actions, GitLab CI | Gerasimos| | ||
| | 22.01. |Lab | 5 | GitHub Actions | Gerasimos| | ||
| | 29.01. |Lecture | 5 | Boost.Test and CTest | Benjamin | | ||
| | 29.01. |Lab | 5 | Boost.Test and CTest | Benjamin | | ||
| | 05.02. |Presentations | C | **3rd student presentations** | students | | ||
| | 05.02. |Presentations | C | **3rd student presentations** | students | | ||
|
|
||
| --- | ||
|
|
||
| ## Examination | ||
|
|
||
| - *"Course accompanying examination"*: no exam, but continuous examination (more like a lab course or a seminar) | ||
| - Attendance is mandatory. | ||
| - We look at: | ||
| - Challenge (outcome and presentations), (~50%) | ||
| - Exercises (not every detail, but *"passed"* or *"failed"*) (~40%) | ||
| - Overall engagement (interactive lecture, discussions, small presentations, contributions, ...) (~10%) | ||
| - Let us know if you cannot come to a lecture / exercise (you don't have to give a reason) | ||
| - You will need to register yourself to the *"exam"* on C@MPUS | ||
| - Point of no return: Once you gave the first presentation (Nov 11), you have to register (please let us still know when you drop just before the presentation) | ||
| - Challenge (reports, presentations, contribution) (45%) | ||
| - Exercises (not every detail, but *"outstanding"* / *"passed"* / *"failed"* ) (50%) | ||
| - Overall engagement (interactive lecture, discussions, small presentations, contributions, ...) (5%) | ||
| - You will need to register yourself to the *"exam"* on C@MPUS. | ||
| - Point of no return: Once you handed in the first report (Nov 6), you have to register. | ||
|
|
||
| --- | ||
|
|
||
| ## GitLab Account | ||
|
|
||
| - Please write a mail till tonight to Ishaan | ||
| - Please write a mail till tonight to Ishaan. | ||
| - [[email protected]](mailto:[email protected]) | ||
| - 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 | ||
| - We will then add you to the `Simulation Software Engineering` group | ||
| - If you already have an IPVS-SIM GitLab account, we only need your username. | ||
| - We will then add you to the `Simulation Software Engineering` group. | ||