 HackMD
~~~~~~~~–-
tags: workshop-2024-September
September 2024 CR Workshop Planning
- This document: https://hackmd.io/@coderefinery/2024-sep-ws-planning
- Workshop repo: https://github.com/coderefinery/2024-09-10-workshop
- Workshop page: https://coderefinery.github.io/2024-09-10-workshop/
- Previous workshop page: https://coderefinery.github.io/2024-03-12-workshop
- Collaborative notes for workshop: https://notes.coderefinery.org/workshop-2024-september#
Format
- week 1 lectures + exercises
- week 2 lectures + demos
- encourage "bring your own code" and garage sessions, bring your own classroom
Role distribution
- Are all role descriptions up to date?
- https://coderefinery.github.io/manuals/roles-overview/
- (Learner)
- (Team leader)
- Instructor
- RD (Richard Darst); confirmed
- BL (Bjørn Lindi); confirmed
- JH (Johan Hellsvik): not this time
- SR (Sabry Razick); confirmed
- DP (Dhanya Pushpadas); confirmed
- DI (Diana Iusan); confirmed
- EG (Enrico Glerean); confirmed
- RB: first-week lessons; confirmed
- TR (Teemu Ruokolainen); confirmed
- TP (Thomas Pfau); confirmed
- YT (Yu Tian); confirmed
- HF (Hossein Firooz); confirmed
- YW (Yonglei Wang);
- JR (Jarno Rantaharju);
- (Expert helper) → old role involved breakout rooms, now more about answering questions in notes
- RD
- DP
- AV (Aurelie Vancraeyenest)
- DI
- EG
- (HackMD manager) → "Notes Manager"
- BL (week 2?)
- SW (week 1)
- Host
- RD
- Director
- RD
- Broadcaster
- RD
- Registration coordinators
- DI, EG
- Instructor coordinators
- EG, DI
- Outreach and marketing coordinators
- EG
- DP
- DI
- Team lead/exercise coordinators
- EG
- AV
- SW
- (Video editor)
- RD
- https://coderefinery.github.io/manuals/roles-overview/
TODO list
Before the workshop
-
decide on the workshop dates:
- onboarding: EG can join
- Samantha and Aurelie might be coordinating that, To be checked
- main workshop event: September 10-12, and 17-19
- bring your own code: to be checked with RB and/or Samantha and check dates
- Oct 22 to be removed (overlap with hackathon, better to remove it and maybe add one in november). Maybe 1 session is enough? It depends on who has the time to be there. Last time there were only 2 learners.
- onboarding: EG can join
-
create Indico event
- how should it be changed compared to March 2024?
-
prepare for certificates (like previous times, EG + Mira if needed)
-
distribute lessons
- ask from instructor training registrations if someone would like to co-teach? SW asks in TTT
- EG to ask in CR zulip today 12/8
- Tentative distribution of lessons:
-
decide on workshop format: learner's Zoom? helpers?
- TwitchTV. No central zoom (people are free to create their own zoom rooms)
- Bring your own classroom
-
Inform instructors about timeline for install instructions
-
Make sure install instructions are up to date and "correct"
- EG asks on zulip for a responsible person(s)
-
Set up broadcasting zoom room and communicate them
-
Set up Q&A HackMD : https://notes.coderefinery.org/workshop-2024-september
-
Various websites updates
- instructor names
- bring your own code
- communication partners
Advertising
- Create/update advertising texts on the workshop page
- Zulip chat (ping all)? -> events channel (add also request for instructors?)
- ASC Twitter
- Notify-me list?
- Sigma2 newsletter
- NAISS newsletter (DI)
- ENCCS website
- CSC training newsletter (Goes out Aug 22)
- CSC training calendar
- CSC internal
- Avointiede (openscience)
- CSC LinkedIn, X
- CodeRefinery Social Media
- more detailed workshop info posts (SW)
- CodeRefinery ambassadors
- general info on workshop
- more detailed workshop info email (SW)
- Aalto STEM students e-lists (EG)
- Aalto triton users (EG)
- Aalto HR training mailout (will go out on 16/Aug)
- Aalto scicomp announcements
- Otaniemi posters at CS+U+NBE+PHYS+VAARE
- Delta doctoral network
- Notify UiB researchers [one mail sent to faculties]
- UiB hpc mailing list (DP)
- NERSC, Bergen mailing list
- Bjerknes newsletter
- UiB calendar
- University of Oslo computational biology mailing list (SR)
- University of Oslo Phd and Postdocs mailing list (SR)
- University of Oslo dDcince contact (SR)
- NTNU mailout (BL?)
- Other Finnish universities (EG to ask them to forward to their mailing list OR create internal calendar event)
- JYU
- HY
- LUT
- TUNI
- Turku
- UoEF
- Oulu
Targeted marketing
- Reach out to find partners/local hosts
- direct email
- own eventpage -> get mention on webpage ("partnership status")
- manual page for in-person room
- EuroCC, etc
- direct email
- Older list by RD:
- Learners (many sub-categories with different time vs need trade-offs: students, junior researchers, senior researchers, lifelong learning) (join a workshop)
- Exercise leaders (bring your friends, join to learn more and lead groups)
- Research leaders (people who can tell their students they need to attend CR)
- University staff (Computing, open sci, etc.) (people who can serve as local organizers and serve as local helpers)
- Potential instructors (teach, etc.)
- High-level management (provide us funding)
Lesson updates (as needed)
- It's up to the instructors if they want to change something
- python env to check and update
- e.g. snakemake was not in the newest version (the major changes on newer snakemake should affect the hpc part)
- We should check that last march workshop feedback was turned into issue and then check if something is "urgent"
- instructors + organisers can check this by end of August
- after team meetings?
- Co-working times every monday at 15 CEST - can be used
- Will there be updates?
Communication with participants
…
Distribution of lessons - Final list as of 02/09
Week 1
- Day 1&2 - Introduction to version control with Git
- Icebreakers and intro: SW + RD + instructors of the day
- Day 1 RB & RD
- Day 2 RB & BL
- ok to publish
- Icebreakers and intro: SW + RD + instructors of the day
- Day 3 - Collaborative distributed version control
- Icebreakers and intro: SW + RD + instructors of the day
- SR & DP
- ok to publish
Week 2
- Day 4 part 1 - Reproducible research
- Icebreakers and intro: EG + RD + instructors of the day
- TP & TR
- Day 4 part 2 - Social coding and open software
- RD & HF
- Day 5 part 1 - How to document your research software
- Icebreakers and intro: RD + instructors of the day
- JR & AM
- Day 5 part 2- Jupyter notebooks
- DI & JR
- Day 6 part 1- Automated testing
- Icebreakers and intro: RD + instructors of the day
- BL & ??
- Day 6 part 2 - Modular code development
- YT & RD
Documentation timing
10:00 - 10:05 Introduction
10:05 - 10:15 Motivation and wishlist
10:15 - 10:20 Popular solutions
10:20 - 10:30 In-code documentation
10:30 - 10:40 Readme demo
- example: https://github.com/geopandas/geopandas
10:40 - 10:55 Readme exercises 2 and 3 in notes
10:55 - 11:05 Break
11:05 - 11:45 Sphinx and Markdown
11:45 - 11:55 Deploying Sphinx
11:55 - 12:00 Summary and outro
