You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 00_organization/challenge_intro_slides.md
+38-16Lines changed: 38 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,10 @@ slideOptions:
21
21
.revealsectionh2 {
22
22
color: orange;
23
23
}
24
+
.revealsectionh3 {
25
+
color: orange;
26
+
text-align: left;
27
+
}
24
28
.revealcode {
25
29
font-family: 'Ubuntu Mono';
26
30
color: orange;
@@ -37,20 +41,38 @@ slideOptions:
37
41
38
42
---
39
43
40
-
## Schedule
44
+
## The Challenge
45
+
46
+
- Contribute something small (but not trivial) to a large-scale open-source simulation software (*"good first issue"*)
47
+
- Examples: feature, tutorial, documentation, new packaging, bugfix, ...
48
+
- Run through complete cycle (issue, discussion, PR, review, merge)
49
+
50
+
### Timeline
51
+
52
+
1. Pick a software (till **Oct 23**, evening)
53
+
2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 6**)
54
+
3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 11**)
2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 10**)
44
-
3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 15**)
45
-
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**)
64
+
The challenge part:
46
65
47
-
Rough workload / grading weights: 25%, 25%, 50%
66
+
- All 3 reports: 3/8
67
+
- Presentation: 1/8
68
+
- Actual contribution: 2/8 difficulty, 2/8 quality (*"net benefit"* for maintainers?)
69
+
-*"outstanding"* / *"passed"* / *"failed"*
48
70
49
71
---
50
72
51
73
## Which Software to Pick?
52
74
53
-
- Something in the simulation universe (this includes equation solvers, meshing, scientific visualization, ...)
75
+
- Something in the simulation universe (this includes equation solvers, meshing, scientific visualization, (AI), ...)
- Comment in [issue #1](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2223/challenge/-/issues/1) till **27th of October** (next Thursday) evening (no FCFS)
- Comment in [issue #1](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2425/challenge/-/issues/1) till **23rd of October** (next Wednesday) evening (no FCFS)
100
122
- Priority list with at least three choices
101
-
- If not on our suggestion list, write short paragraph what the software does and give links
123
+
- If **not** on our suggestion list, write short paragraph what the software does and give links
102
124
103
125
---
104
126
105
127
## Role of Advisor
106
128
107
-
- Benjamin or Ishaan
108
-
- Use exercise blocks and time after lectures for discussions
109
-
- Discuss at least what you plan to contribute
129
+
- Benjamin, Frédéric, Gerasimos, or Ishaan
130
+
- Use, for example, exercise blocks and time after lectures for discussions
110
131
- Share links etc. to issues and PRs (or tag us)
111
132
112
133
---
113
134
114
135
## Presentations
115
136
116
-
- Length depends on students in course (maybe 5-10 mins for first two presentations, 10-20 mins for last)
137
+
- Length depends on number of students in course (maybe 5-10 mins)
138
+
- Everybody has to present at least once
117
139
- Everybody should learn something from every presentation
118
140
- Style: like a presentation in a team meeting, not like a presentation at a conference
119
141
120
142
---
121
143
122
144
## Reports
123
145
124
-
-Please also submit a report for each presentation
146
+
-Submit a report for each step
125
147
- 1-2 pages (2500-5000 chars)
126
148
- Written in markdown
127
-
- Submission via a merge request to the [GitLab challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2223/challenge)
149
+
- Submission via a merge request to the [GitLab challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2425/challenge)
128
150
- Add links, instructions, ... should work like a compact summary for everybody in the end
-**Weekly lectures** (90 mins) and **exercises** (90 mins) to learn and train concepts and tools
69
-
-Thursdays, 09:45–11:15 and 15:45–17:15
70
-
- This room: 38-0.124
74
+
-Wednesdays, 09:45–11:15 and 15:45–17:15
75
+
- This room: 38-0.108
71
76
- No strict distinction between lecture and exercise
72
77
- Interactive style (not a theory course)
73
78
-**Individual challenge**: contribute to real simulation software :rocket:
74
79
- List of software candidates: this afternoon
75
-
- 3 presentations from you (more later)
80
+
- 3 rounds of presentations from you (more later)
76
81
- You get a direct advisor
77
82
- Use exercise blocks and time after lectures for discussions
78
83
@@ -89,28 +94,34 @@ Two parallel branches:
89
94
## Prerequisites: Infrastructure
90
95
91
96
- GitHub account
92
-
- We'll create an IPVS-SIM GitLab account for everyone
97
+
- We will create IPVS-SIM GitLab accounts for everyone
93
98
- Laptop with root access
94
99
- You should be able to install and configure software.
95
-
- OK if we use Slido?
96
-
- Signed up on C@MPUS?
100
+
101
+
---
102
+
103
+
## Waiting List
104
+
105
+
- Students who have a fixed spot (top 40) in either the lecture or the exercise get in.
106
+
- We take 50 students in total.
107
+
- Remaining spots are filled by waiting list provided presence or excused today.
108
+
- We manually add these students at the end of this week.
97
109
98
110
---
99
111
100
112
## Material
101
113
102
-
- 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)
114
+
- Great open-source book to recap: Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: [Research Software Engineering with Python](https://third-bit.com/py-rse/)
103
115
- All our material is on [https://github.com/Simulation-Software-Engineering](https://github.com/Simulation-Software-Engineering)
104
116
- 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), ...)
105
-
- We rework the material as the semester goes
117
+
- We rework the material as the semester goes.
106
118
- We give many links to videos, docs, blog posts, podcasts, ...
107
-
- Recordings of the lecture from last year as a backup on ILIAS. Please always come when possible. What we do is interactive.
108
119
109
120
---
110
121
111
122
## Contribute to the Material
112
123
113
-
- You, no joke :see_no_evil: ([many students contributed last year](https://github.com/Simulation-Software-Engineering/Lecture-Material/graphs/contributors))
124
+
- You, no joke :see_no_evil: ([many students already contributed](https://github.com/Simulation-Software-Engineering/Lecture-Material/graphs/contributors))
114
125
- Typos, broken links, ...
115
126
- Additional material
116
127
- By definition, we study quickly evolving technology ... help us staying up to date
2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 10**)
140
-
3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 15**)
141
-
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**)
149
+
- Contribute something small (but not trivial) to a large-scale open-source simulation software (*"good first issue"*)
150
+
- Examples: feature, tutorial, documentation, new packaging, bugfix, ...
151
+
- Run through complete cycle (issue, discussion, PR, review, merge)
152
+
153
+
### Timeline
154
+
155
+
1. Pick a software (till **Oct 23**, evening)
156
+
2. Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 6**)
157
+
3. Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 11**)
158
+
4. Suggest contribution (**Dec 16**)
159
+
5. Present the contribution (**Feb 5**)
142
160
143
161
---
144
162
@@ -152,14 +170,14 @@ td {
152
170
153
171
| Date | Type | Chapter | Topic | Lecturer |
154
172
| ---- | ---- | ------- |------ | -------- |
155
-
|20.10. |Lecture | 0-1 | Course intro, intro to SSE, VC basics | Benjamin |
156
-
|20.10. |Lecture | 1 | Git: my workflow + quiz, software projects for challenge | Benjamin |
157
-
|27.10. |Lecture |3|Packaging, pip and PyPI | Ishaan|
158
-
|27.10. |Lab |3|pip and PyPI exercise | Ishaan|
159
-
|03.11. |Lecture + presentations| 1|*"My neat little Git trick"*, merge vs rebase, working in teams| Benjamin|
160
-
|03.11. |Lab|1|Git exercise | Ishaan|
161
-
|10.11. |Lecture| 2 |Virtual machines | Ishaan|
162
-
|10.11. |Presentations | C |**1st student presentations**| students |
173
+
|16.10. |Lecture | 0-1 | Course intro, intro to SSE, VC basics | Benjamin |
174
+
|16.10. |Lecture | 1 | Git basics, my Git workflow, Git quiz, how to challenge| Benjamin |
175
+
|23.10. |Lecture |1|*My neat little Git trick*, merge vs rebase, working in teams| Benjamin|
- Let us know if you cannot come to a lecture / exercise (you don't have to give a reason)
220
-
- You will need to register yourself to the *"exam"* on C@MPUS
221
-
- 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)
0 commit comments