Skip to content

Commit

Permalink
improved slides for block 6 from JuliaHEP (#6)
Browse files Browse the repository at this point in the history
Slides improved after workshop given in JuliaHEP. Now they have more streamlined text, and they advertise DrWatson explicitly. They are a bit longer content.
  • Loading branch information
Datseris authored Nov 8, 2023
1 parent d0ca1bf commit 74bd990
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
> _Sounds too good to be true…? Join this workshop, and you will be surprised to find out that attributing all these properties to your code does not take much effort; once you have the proper education on the subject, you get all of this good stuff practically for free!_
## Information

This repository contains the materials (presentation slides and exercises) for the "Good Scientific Code" workshop. Powerpoint version of the slides (for editing) is available on demand.

The workshop is (mostly) language-agnostic, meaning that the principles are about general coding. Examples and exercises will be in Julia and Python.
Expand All @@ -40,11 +41,13 @@ The workshop is divided into the following six blocks:
- **Scientific project reproducibility**: publish reproducible papers

## Bring your own code!
The exercise sessions have two components. On the first, illustrative but simple exercises are given to the participants to practice each topic. Participants are expected to solve the exercises live during the workshop! The second component requires the participants to apply this new knowledge to their very own code base. Therefore, please bring along all code you have used in your latest published paper. If you haven’t published yet, no worries, bring along all the code you have at the moment for your science project. Decide in advance on 2-3 figures of your paper/project, which will be the central focus of the exercises. The exercise plan will transform your code from random scripts to a self-contained code base that is understandable, extendable, continuously tested, documented, and hosted on open and accessible platforms.

The exercise sessions have two components. On the first, illustrative but simple exercises are given to the participants to practice each topic. Participants are expected to solve the exercises live during the workshop! The second component requires the participants to apply this new knowledge to their very own code base. Therefore, please bring along all code you have used in your latest published paper. If you haven't published yet, no worries, bring along all the code you have at the moment for your science project. Decide in advance on 2-3 figures of your paper/project, which will be the central focus of the exercises. The exercise plan will transform your code from random scripts to a self-contained code base that is understandable, extendable, continuously tested, documented, and hosted on open and accessible platforms.

_Note: for this plan to have meaningful impact, you should bring a code base where you had to write a substantial amount of source code._

## YouTube recording

A video recording of the live version of this workshop, performed at the Max Planck Institute for Meteorology, is available on YouTube: https://youtu.be/x3swaMSCcYk .

## Citing
Expand Down
Binary file modified block6_sciencereprod/block6_slides.pdf
Binary file not shown.

0 comments on commit 74bd990

Please sign in to comment.