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
+43-21Lines changed: 43 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,26 +47,41 @@ slideOptions:
47
47
- Examples: feature, tutorial, documentation, new packaging, bugfix, ...
48
48
- Run through complete cycle (issue, discussion, PR, review, merge)
49
49
50
-
### Timeline
50
+
---
51
+
52
+
## Timeline
51
53
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**)
55
-
4. Suggest contribution (**Dec 16**)
56
-
5.Present the contribution (**Feb 5**)
54
+
- Pick a software (till **Oct 22**, evening)
55
+
-**Step 1**: Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 5**)
56
+
-**Step 2**: Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 17**)
- You need to pass (at least *"ok"*) all steps individually
75
+
76
+
---
77
+
78
+
## Example Contributions
79
+
80
+
1. Ported several demo cases ([see one](https://github.com/FEniCS/dolfinx/pull/2508)) from FEniCS to [FEniCSx](https://fenicsproject.org/): difficulty *"outstanding"*
81
+
2.[Improved website search](https://github.com/MakieOrg/Makie.jl/pull/2474) of [Makie](https://makie.org/website/): difficulty *"good"*
82
+
3.[Solved a simple good first issue](https://github.com/pymor/pymor/pull/1898) in [pyMOR](https://pymor.org/): difficulty *"ok"*
83
+
84
+
(all did a good or outstanding job in terms of quality)
70
85
71
86
---
72
87
@@ -75,7 +90,6 @@ The challenge part:
75
90
- Something in the simulation universe (this includes equation solvers, meshing, scientific visualization, (AI), ...)
76
91
- Truly open source, all development in public
77
92
- Uses Git
78
-
- Written in Python or C++ (not a strict must)
79
93
- Real community project (not 1-2 PhD students developing, but multiple research groups behind project)
80
94
- A project that is open for contributions (`CONTRIBUTING.md` or similar)
81
95
- Ideally a software you have not worked with before (if you have, please discuss with us)
@@ -90,10 +104,9 @@ The challenge part:
90
104
-[DUNE](https://www.dune-project.org/): Modular toolbox for PDEs
91
105
-[Eigen](https://eigen.tuxfamily.org): LA library in C++
92
106
-[ESPResSo](https://espressomd.org): MD Simulator with Python API (Stuttgart)
93
-
-[FEniCS(-X)](https://fenicsproject.org/): FEM library in C++ with Python interface
94
107
-[Firedrake](https://www.firedrakeproject.org/): FEM library in Python
- more projects in [xSDK](https://xsdk.info/packages/) or [NumFOCUS](https://numfocus.org/sponsored-projects)
127
+
- more projects in [xSDK](https://xsdk.info/packages/) or [NumFOCUS](https://numfocus.org/sponsored-projects) or [HiRSE Code Promotion](https://www.helmholtz-hirse.de/promo.html)
114
128
-**Or your suggestion** (also agent-based or discrete event simulation software)
115
129
116
130
---
117
131
132
+
## What Happens if Maintainers do not React in Time?
133
+
134
+
- Give them time, contact early
135
+
- Not your fault
136
+
- Keep all communication public, then easy for us to review
- 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)
- Comment in [issue #1](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2526/challenge/-/issues/1) till **22rd of October** (next Wednesday) evening (no FCFS)
122
144
- Priority list with at least three choices
123
145
- If **not** on our suggestion list, write short paragraph what the software does and give links
124
146
125
147
---
126
148
127
149
## Role of Advisor
128
150
129
-
- Benjamin, Frédéric, Gerasimos, or Ishaan
130
-
- Use, for example, exercise blocks and time after lectures for discussions
151
+
- Benjamin, Felix, Frédéric, Gerasimos, or Ishaan
152
+
- Use, for example, exercise blocks and time before and after lectures for discussions
131
153
- Share links etc. to issues and PRs (or tag us)
132
154
133
155
---
134
156
135
157
## Presentations
136
158
137
159
- Length depends on number of students in course (maybe 5-10 mins)
138
-
- Everybody has to present at least once
160
+
- Everybody has to present at least once, better twice
139
161
- Everybody should learn something from every presentation
140
162
- Style: like a presentation in a team meeting, not like a presentation at a conference
141
163
@@ -146,7 +168,7 @@ The challenge part:
146
168
- Submit a report for each step
147
169
- 1-2 pages (2500-5000 chars)
148
170
- Written in markdown
149
-
- Submission via a merge request to the [GitLab challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2425/challenge)
171
+
- Submission via a merge request to the [GitLab challenge repo](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2526/challenge)
150
172
- Add links, instructions, ... should work like a compact summary for everybody in the end
- Felix (Neubauer) [`@Logende`](https://github.com/Logende)
54
+
50
55
SSE Hall of Fame:
51
56
52
57
- Alexander (Jaust) [`@ajaust`](https://github.com/ajaust)
@@ -71,15 +76,13 @@ SSE Hall of Fame:
71
76
Two parallel branches:
72
77
73
78
-**Weekly lectures** (90 mins) and **exercises** (90 mins) to learn and train concepts and tools
74
-
- Wednesdays, 09:45–11:15 and 15:45–17:15
75
-
- This room: 38-0.108
76
-
- No strict distinction between lecture and exercise
77
-
- Interactive style (not a theory course)
79
+
- Wednesdays, 09:45–11:15 (in V47.05) and 15:45–17:15 (in 38-0.108, might be too small in first week)
80
+
- Typically lecture in the morning and exercise in the afternoon
78
81
-**Individual challenge**: contribute to real simulation software :rocket:
79
82
- List of software candidates: this afternoon
80
83
- 3 rounds of presentations from you (more later)
81
84
- You get a direct advisor
82
-
- Use exercise blocks and time after lectures for discussions
85
+
- Use time before and after lectures for discussions
83
86
84
87
---
85
88
@@ -88,6 +91,8 @@ Two parallel branches:
88
91
- Basic programming (Python, C++)
89
92
- Basic software development skills (bash, Git, md, ...)
90
93
- Some simulation background
94
+
- SimTech, COMMAS students: no issue
95
+
- CS, SE: ideally through Numerical Fundamentals (NumGL) and Fundamentals of Scientific Computing (WissRech)
91
96
92
97
---
93
98
@@ -100,22 +105,13 @@ Two parallel branches:
100
105
101
106
---
102
107
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.
109
-
110
-
---
111
-
112
108
## Material
113
109
114
110
- Great open-source book to recap: Irving, Hertweck, Johnston, Ostblom, Wickham, and Wilson: [Research Software Engineering with Python](https://third-bit.com/py-rse/)
115
111
- All our material is on [https://github.com/Simulation-Software-Engineering](https://github.com/Simulation-Software-Engineering)
116
112
- 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), ...)
117
113
- We rework the material as the semester goes.
118
-
- We give many links to videos, docs, blog posts, podcasts, ...
114
+
- We give links to docs, videos, blog posts, podcasts, ...
119
115
120
116
---
121
117
@@ -132,6 +128,15 @@ Two parallel branches:
132
128
133
129
---
134
130
131
+
## Use of Generative AI
132
+
133
+
- Also changes RSE rapidly
134
+
- Even more important: having a good overview of technology and being able to **read** code (what we teach in this course)
135
+
- If you use generative AI for your exercises or your challenge: **mandatory** to make this transparent (which parts of your code, how, ...)
136
+
- It is important, experiment! But also build a firm understanding of the basics of technology!
137
+
138
+
---
139
+
135
140
## Chapters
136
141
137
142
1. Version Control
@@ -155,11 +160,11 @@ Two parallel branches:
155
160
156
161
### Timeline
157
162
158
-
1. Pick a software (till **Oct 23**, evening)
159
-
2.Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 6**)
160
-
3.Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 11**)
161
-
4. Suggest contribution (**Dec 16**)
162
-
5.Present the contribution (**Feb 5**)
163
+
- Pick a software (till **Oct 22**, evening)
164
+
-**Step 1**: Present the software: how you got it, what are main features, some tutorials you did, ... (**Nov 5**)
165
+
-**Step 2**: Present *"RSE infrastructure"* of the software: Which CI / documentation / building / git workflow ... does it use? How do contributions work? (**Dec 17**)
Copy file name to clipboardExpand all lines: 00_organization/rse_basics_slides.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,7 @@ slideOptions:
60
60
> A Research Software Engineer (RSE) combines professional software engineering expertise with an intimate understanding of research.
61
61
62
62
-*"Movement"* started in the UK, first UK RSE conference in 2016
63
-
- First conferences in Germany and the Netherlands in 2019
63
+
- First conferences in Germany and the Netherlands in 2019 ([deRSE 2026](https://events.hifis.net/event/2945/) is in Stuttgart, March 3-5)
64
64
-[First de-RSE position paper](https://f1000research.com/articles/9-295/v2) in 2020, [several working groups](https://de-rse.org/en/working_groups.html)
65
65
-[Learning and teaching RSE](https://de-rse.org/learn-and-teach/), [foundational competencies](https://de-rse.org/blog/2024/10/08/identifying-the-foundational-competencies-of-an-RSE-en.html)
66
66
-[Why be an RSE?](https://researchit.blogs.bristol.ac.uk/2021/10/14/international-rse-day-why-be-an-rse/) Interesting and novel projects, technical freedom, RSEs come from varied backgrounds, development for social good
0 commit comments