|
| 1 | +<img src="./images/UCAM_ICCS_Logo.png" width="600"> |
| 2 | + |
| 3 | +# Reproducibility in Computing |
| 4 | + |
| 5 | +This repository contains documentation, resources, and code for the Reproducibility in Computing session |
| 6 | +designed and delivered by Jack Franklin and Marion Weinzierl of [ICCS](https://github.com/Cambridge-ICCS). |
| 7 | +All materials, including slides and videos, are available such that individuals can cover the |
| 8 | +course in their own time. |
| 9 | + |
| 10 | +A website for this workshop can be found at TODO: provide link. |
| 11 | + |
| 12 | + |
| 13 | +## Contents |
| 14 | + |
| 15 | +- [Learning Objectives](#learning-objectives) |
| 16 | +- [Teaching material](#teaching-material) |
| 17 | +- [Preparation and prerequisites](#preparation-and-prerequisites) |
| 18 | +- [Installation and setup](#installation-and-setup) |
| 19 | +- [License information](#license) |
| 20 | +- [Contribution Guidelines and Support](#contribution-guidelines-and-support) |
| 21 | + |
| 22 | + |
| 23 | +## Learning Objectives |
| 24 | + |
| 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. |
| 27 | + |
| 28 | +## Teaching Material |
| 29 | + |
| 30 | +### Slides |
| 31 | +The slides for this workshop can be viewed here: TODO: provide link |
| 32 | + |
| 33 | +### Exercises |
| 34 | + |
| 35 | +TODO |
| 36 | + |
| 37 | +The exercises for the course can be found in the [exercises](exercises/) directory. |
| 38 | +These take the form of \<partially completed jupyter notebooks/downloadable code/online tasks or games etc.\>. |
| 39 | + |
| 40 | +### Worked Solution |
| 41 | +TODO |
| 42 | + |
| 43 | +Worked solutions for all of the exercises can be found in the [worked solutions](worked-solutions/) directory. |
| 44 | +These are for recapping after the course in case you missed anything, and contain example solutions. |
| 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 | + |
| 50 | + |
| 51 | +## Preparation and prerequisites |
| 52 | + |
| 53 | +### Prerequisites |
| 54 | + |
| 55 | +To get the most out of the session we assume a basic understanding of the research process, programming in Python and research software. |
| 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. |
| 58 | + |
| 59 | + |
| 60 | +### Preparation |
| 61 | + |
| 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. |
| 63 | + |
| 64 | +If you want to follow along with the exercises, basic Python coding skills and a Python development environment are required. |
| 65 | + |
| 66 | + |
| 67 | +## Installation and setup |
| 68 | + |
| 69 | +TODO |
| 70 | + |
| 71 | + |
| 72 | +## License |
| 73 | + |
| 74 | +The code materials in this project are licensed under the [MIT License](LICENSE). |
| 75 | + |
| 76 | + |
| 77 | +## Contribution Guidelines and Support |
| 78 | + |
| 79 | +If you spot an issue with the materials please let us know by |
| 80 | +[opening an issue](https://github.com/Cambridge-ICCS/ReproducibilityInComputingCourse/issues) |
| 81 | +here on GitHub clearly describing the problem. |
| 82 | + |
| 83 | +If you are able to fix an issue that you spot, or an |
| 84 | +[existing open issue](https://github.com/Cambridge-ICCS/ReproducibilityInComputingCourse/issues) |
| 85 | +please get in touch by commenting on the issue thread. |
| 86 | + |
| 87 | +Contributions from the community are welcome. |
| 88 | +To contribute back to the repository please first |
| 89 | +[fork it](https://github.com/Cambridge-ICCS/ReproducibilityInComputingCourse/fork), |
| 90 | +make the necessary changes to fix the problem, and then open a pull request back to |
| 91 | +this repository clearly describing the changes you have made. |
| 92 | +We will then preform a review and merge once ready. |
| 93 | + |
| 94 | +If you would like support using these materials, adapting them to your needs, or |
| 95 | +delivering them please get in touch either via GitHub or via |
| 96 | +[ICCS](https://github.com/Cambridge-ICCS). |
0 commit comments