CodeRefinery Uppsala workshop 2023-05 planning

CodeRefinery Uppsala workshop 2023-05 planning

Advertisement text

CodeRefinery workshop, Uppsala, May 9-11, 2023
Organised by CodeRefinery and partners, among which are NAISS, UPPMAX, PDC, and ENCCS.

Do you write code for your research? Do you manage data? Most importantly, are you doing it properly? Has it ever happened to you to have to rewrite or simply copy-paste codes from one folder to another, possibly losing things during the process? Have you ever opened an old code you wrote and had no clue what it does? Maybe you feel you waste a lot of time doing a lot of manual work to process your data and would like to automate it? Or maybe you also are not doing any of this yet, but would like to avoid these issues from happening in the future and do things properly from the beginning?

If you answered yes to any of the previous questions, then you are strongly encouraged to participate in the CodeRefinery workshop in Uppsala on May 9-11, 2023.

Topics covered in the workshop include:

Using Git to maintain your codes and collaborate with others
Principles of reproducible research and FAIR
Good coding practices in general (writing documentation, testing, how to choose an appropriate license)
The Workshop will not teach you to code, but all the "good practice skills" that are needed to write good maintainable software and achieve reproducible research.

The workshop will alternate between type along tutorials and hands-on exercises. You may register for parts of the workshop.

Workshop page: https://coderefinery.github.io/2023-05-09-uppsala.
Registration link: https://forms.gle/ZrHLow4HnCqYK49VA.

Advertised to

Teachers and helpers

Diana: interested in Git intro and Git collab.
Thor: any lesson except social coding and maybe not modular code development
Johan: can teach some of the lessons, no particular preference
Anastasiia: helper
Qiang: helper
Pavlin: at least helper, maybe teach documentation and/or Jupyter
Björn: at least helper, maybe teacher as well…

Lesson distribution

Helpers

AOB

do any lessons need to be re-adjusted to in-person teaching

To do

Detailed schedule being edited currently

Schedule Day 1, morning

09:00 - 09:15 (15 min) Welcome and practical information (Diana)
09:15 - 12:00 Introduction to version control (part 1/2) (Diana)
- 09:15 - 09:30 (15 min) Motivation - teaching & demo
- 09:30 - 09:45 (15 min) Basics - teaching & type along
- 09:45 - 10:05 (20 min) Basics - exercises
  1. Record changes
  2. Optional: Comparing, renaming, and removing - if time allows
- 10:05 - 10:25 (20 min) Basics - History, commit log, ignoring - teaching
- 10:25 - 10:40 (15 min) Break
- 10:40 - 10:55 (15 min) Branching and merging - teaching
- 10:55 - 11:15 (20 min) Branching and merging - exercises
  1. Create and commit to branches Teaching resumed before merging branches.
  2. Optional exercises with branches: Fast-forward merge and Rebasing - if time allows
- 11:15 - 11:30 (15 min) Summarize branching and merging
- 11:30 - 11:40 (10 min) Conflict resolution (teaching)
- 11:40 - 12:00 (20 min) Exercise conflict resolution

Schedule Day 1, afternoon

13:00 - 13:10 (10 min) Recap and Q&A from day 1, morning
13:10 - 16:00 Introduction to version control (part 2/2) (Björn)
- 13:10 - 13:20 (10 min) Sharing repositories online - teaching/type-along
- 13:20 - 13:40 (20 min) Exercise: Pushing our guacamole recipe repository to GitHub
- 13:40 - 13:55 (15 min) Inspecting history - teaching/type-along
- 13:55 - 14:25 (30 min) Inspecting history - exercises
  1. Basic archeology commands
  2. Optional: Git bisect - to be done if time allows
- 14:25 - 14:40 Break
- 14:40 - 14:50 (10 min) Summarize inspecting history
- 14:50 - 15:05 (15 min) Undoing and recovering - teaching/type-along
- 15:05 - 15:25 (20 min) Undoing and recovering - exercises
- 15:25 - 15:40 (15 min) Summarize undoing and recovering and discussion and mention that staging area exists
- 15:40 - 16:00 (20 min) How much Git is necessary?

Schedule Day 2, morning

08:50 - 09:00 Soft start and icebreaker question
09:00 - 12:00 Collaborative distributed version control (Thor)
- 09:00 - 09:15 Recap Git, any Hackmd questions to highlight
- 09:15 - 09:30 Concepts around collaboration
  1. Explain terms. Pull, push, clone, fork. Focus on pull and not fetch.
  2. Focus more on Clone and less on Generating from templates and importing
- 09:30 - 11:10 Centralized workflow
  - 9:30 - 9:45 : Explain concepts.
  - 9:45 - 09:50 Inform clearly what is expected outcome.
  - 09:50 - 10:20 Excercise
- 10:20 - 10:35 Break
  - 10:35 - 10:50 Instructors go through the exercise
- 10:50 - 12:00 Distributed version control and forking workflow + one break
  - 10:50 - 11:00 - Concepts and what are exercise outcomes
  - 11:00 - 11:30 - Exercise
  - 11:30 - 11:40 - Instructors go through excercises
- 11:40 - 12:00 - How to contribute changes to somebody else’s project and Q&A

Schedule Day 2, afternoon

13:00 - 14:45 Reproducible research (Pavlin)
- 13:00 - 13:10 Motivation
- 13:10 - 13:20 Organizing your projects
- 13:20 - 13:50 Recording dependencies
  - discussion (5 min)
  - exercise (20 min)
  - discussion (5 min)
- 13:50 - 14:20 Recording computational steps
  - discussion (5 min)
  - exercise (20 min)
  - discussion (5 min)
- 14:20 - 14:30 Recording environments
- 14:30 - 14:45 Sharing code and data
  - demo (15 min)

14:45 - 15:00 Break

15:00 - 16:00 Social coding (Johan)
- 15:00 - 15:15 Social coding (15 min)
- 15:15 - 15:45 Licensing (30 min)
- 15:45 - 16:00 Software citation (15 min)

Schedule Day 3, morning

09:00 - 10:25 Jupyter (Pavlin)
- 09:00 - 09:10 Jupyter notebooks
- 09:10 - 09:25 JupyterLab and notebook interface
- 09:25 - 09:50 A first computational notebook
  - intro to the exercise (5 min)
  - breakout room exercise (20 min)
- 09:50 - 10:00 Notebooks and version control demo, 10-15 min
- 10:00 - 10:20 Sharing notebooks
  - Binder Breakout room exercise (20 min)
- 10:20 - 10:25 Wrap-up
- 10:25 - 10:40 Break
10:40 - 12:00 Documentation (Björn)
- 10:40 - 10:50 Motivation and tools
  - create a wishlist in HackMD
- 10:50 - 11:10 Writing good README files
  - brief discussion
  - 15 minutes for exercises, choosing either 1, 2 or 3 (or do multiple of time allows)
  - brief discussion
- 11:10 - 11:45 Sphinx and markdown
  - discussion (5 min)
  - Exercise 1 as type along (10 min)
  - Exercise 2, exercise 3 if time allows (20 min)
  - Discussion, going over exercise (5 min)
- 11:45 - 11:55 Deploying Sphinx documentation to GitHub Pages
  - Exercise 1 as demo
- 11:55 - 12:00 Summary

Schedule Day 3, afternoon

13:00 - 14:30 Software testing (Johan)
- 13:00-13:05 Motivation
- 13:05-13:15 Concepts
- 13:15-13:40 Testing locally
  - 5 min talking
  - 15 min exercises
  - 5 min going over exercises and discussion
- 13:40-14:05 Automated testing
  - type-along session
- 14:05-14:30 Test design
  - discussion: 5 minutes
  - Exercises: 10 minutes. Any of exercises Design-1 to Design-8 that learners want to do.
  - discussion and type-along of advanced exercises: 10 minutes
14:30 - 14:45 Break
14:45 - 15:45 Modular coding (Thor)
15:45 - 16:00 Concluding remarks and where to go from here