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: README.md
+24-86Lines changed: 24 additions & 86 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,12 @@
2
2
3
3
# Reproducibility in Computing
4
4
5
-
This repository contains documentation, resources, and code for the `<your course title>` session
5
+
This repository contains documentation, resources, and code for the Reproducibility in Computing session
6
6
designed and delivered by Jack Franklin and Marion Weinzierl of [ICCS](https://github.com/Cambridge-ICCS).
7
7
All materials, including slides and videos, are available such that individuals can cover the
8
8
course in their own time.
9
9
10
-
A website for this workshop can be found at [\<Link to website or slides if available\>](https://iccs.cam.ac.uk/).
10
+
A website for this workshop can be found at TODO: provide link.
11
11
12
12
13
13
## Contents
@@ -22,113 +22,51 @@ A website for this workshop can be found at [\<Link to website or slides if avai
22
22
23
23
## Learning Objectives
24
24
25
-
The key learning objective from this workshop is to
26
-
_Provide participants with \<Your workshop objective here\>_.
27
-
28
-
However, more specifically we will achieve this through to:
29
-
30
-
* add more detailed objectives here,
31
-
* list any specific tools and techniques to be used,
32
-
* add any other sub-skills that will be covered,
33
-
* state what the outcome of the exercises/lecture will be.
34
-
35
-
With regards to specific content we cover:
36
-
37
-
* optionally, consider adding specific takeaway skills here
38
-
* for example, classification and regression with neural networks
39
-
* for example, how to add and commit files to git
25
+
The key learning objective from this workshop is raise the awareness of the importance of software reproducibility, and give the participants and understanding
26
+
and basic tools to improve it.
40
27
41
28
## Teaching Material
42
29
43
30
### Slides
44
-
The slides for this workshop can be viewed here: [\<Link to your slides\>](https://iccs.cam.ac.uk/)
31
+
The slides for this workshop can be viewed here: TODO: provide link
45
32
46
33
### Exercises
34
+
35
+
TODO
36
+
47
37
The exercises for the course can be found in the [exercises](exercises/) directory.
48
38
These take the form of \<partially completed jupyter notebooks/downloadable code/online tasks or games etc.\>.
49
39
50
-
### Worked Solutions
40
+
### Worked Solution
41
+
TODO
42
+
51
43
Worked solutions for all of the exercises can be found in the [worked solutions](worked-solutions/) directory.
52
44
These are for recapping after the course in case you missed anything, and contain example solutions.
53
45
46
+
### Mini ReproHack
47
+
48
+
The [Mini ReproHack repository](https://github.com/Cambridge-ICCS/MiniReproHack) can be used before, alongside or after this course, to learn hands-on what makes software reproducible. It contains instructions on how do a [reproducibility hackathon](www.reprohack.org) by trying to reproduce the results of real climate science papers.
49
+
54
50
55
51
## Preparation and prerequisites
56
52
57
53
### Prerequisites
58
54
59
-
To get the most out of the session we assume a basic understanding in a few areas and
60
-
for you to do some preparation in advance.
61
-
This expected knowledge is outlined below, along with resources for reading if you
62
-
are unfamiliar with any areas.
63
-
64
-
- List here any key skills or knowledge that will be assumed of a user for the course,
65
-
- for example, basic calculus (integration and differentiation of a function) and matrix algebra
66
-
- Provide resources where appropriate,
67
-
- for example, Basic Neural Networks - we recommend the
68
-
[video series by 3Blue1Brown](https://www.3blue1brown.com/topics/neural-networks), at least chapters 1-3.
69
-
- Also include any programming expectations
70
-
- for example, the course will be taught in Python using [`numpy`](https://numpy.org/)
71
-
and [`pandas`](https://pandas.pydata.org/docs/getting_started/index.html).
72
-
- We assume users are familiar with the basics of Python. This includes:
73
-
- Basic mathematical operations
74
-
- Writing and running scripts/programs
75
-
- Writing and using functions
76
-
- If users need to clone the repository from GitHub/Lab using git also note this.
77
-
The [ICCS Summer School](https://www.youtube.com/watch?v=ZrwzK4CnJ3Q) should provide the necessary knowledge.
55
+
To get the most out of the session we assume a basic understanding of the research process, programming in Python and research software.
78
56
57
+
The ICCS [RSE Skills workshop](https://github.com/jatkinson1000/rse-skills-workshop) gives you an overview of many of the topics mentioned in this course.
79
58
80
-
### Preparation
81
-
82
-
List here anything that you expect participants to have on their computer in advance of the course in order to participate.
83
-
For example:
84
59
85
-
- A text editor - e.g. vim/[neovim](https://neovim.io/), [gedit](https://gedit.en.softonic.com/), [vscode](https://code.visualstudio.com/), [sublimetext](https://www.sublimetext.com/) etc. to open and edit code files
86
-
- A terminal emulator - e.g. [GNOME Terminal](https://help.gnome.org/users/gnome-terminal/stable/), [wezterm](https://wezfurlong.org/wezterm/index.html), [Windows Terminal (windows only)](https://learn.microsoft.com/en-us/windows/terminal/), [iTerm (mac only)](https://iterm2.com/)
87
-
- A Python 3 installation
60
+
### Preparation
88
61
89
-
Remember that participants will have a mix of Unix and Windows systems, and these should be covered
90
-
to ensure smooth delivery. Whilst Unix may be a presumed first choice, provide links to information
91
-
for setup on Windows, for example
92
-
[Windows' getting-started with python information](https://learn.microsoft.com/en-us/windows/python/beginners).
62
+
It is helpful but not mandatory to do a [mini ReproHack](#mini-reprohack) before the session to get a better understanding of the problem of software and research reproducibility.
93
63
94
-
If you require assistance or further information with any of these please reach out to
95
-
us before the session.
64
+
If you want to follow along with the exercises, basic Python coding skills and a Python development environment are required.
96
65
97
66
98
67
## Installation and setup
99
68
100
-
Here you should include any instructions required for setup in preparation for the course.
101
-
These may be followed during the sesison as a walkthrough, but you should provide clear
102
-
instructions here for participants who take longer, needs additional help, or return to work
103
-
in their own time.
104
-
It is possible that many participants will not have done this in advance,
105
-
which you should be prepared for, but having these clear instructions means
106
-
that they can be pointed at this instead of holding up the session.
107
-
108
-
Things to include are:
109
-
110
-
- obtaining the code, for example instructions on how to clone the code locally:
0 commit comments