Create course slides#7
Conversation
|
To discuss:
|
| # A likely scenario | ||
|
|
||
| - You have just joined a new research group as a Student/Researcher/PI. | ||
| - The group use a custom pipeline/setup to perform their data analysis/simulations. |
There was a problem hiding this comment.
| - The group use a custom pipeline/setup to perform their data analysis/simulations. | |
| - The group use a custom pipeline/setup to perform their data analysis/simulations. | |
| - You are reading their latest paper, and want to reproduce one of their figures - your task is to introduce better data and adapt the algorithm, and add a new line to show the improvement. |
|
|
||
| # Version Control | ||
|
|
||
| - First put things into VC |
There was a problem hiding this comment.
| - First put things into VC | |
| - First put things into version control (e.g. Github, Gitlab, Bitbucket, Codeberg) |
There was a problem hiding this comment.
I have added that to a separate slide, to try to differentiate between version control and repo hosting, here
| # Version Control | ||
|
|
||
| - First put things into VC | ||
| - Then any changes/fixes can be tracked |
There was a problem hiding this comment.
Maybe also something about better collaboration
There was a problem hiding this comment.
I have added a bit about that in the slide on further steps/repo hosting, but I will expand on it as well
| - Basic documentation | ||
| - Project files (e.g. project.toml for python etc) | ||
| - System dependencies (nix/guix/docker?) | ||
|
|
There was a problem hiding this comment.
Add something about automatisation - creating (at least) scripts to run the simulation pipeline, produce figures etc
| - Accessibility | ||
| - Interoperability | ||
| - Reuse | ||
|
|
There was a problem hiding this comment.
Notebooks and containers
| - Interoperability | ||
| - Reuse | ||
|
|
||
| $-- Maybe we should look at this retrospectively, and see what elements we covered and |
There was a problem hiding this comment.
Reproducibility reviews - let new team members run the code according to documentation, and raise issues for things that are not clear/outdated.
Also, point towards reprohacks and other reproducibility initiatives.
By separating out the walkthrough scenario, we can reuse these slides for shorter talks more easily.
I have found these really useful when dealing with messy repositories in the past.
MarionBWeinzierl
left a comment
MarionBWeinzierl
left a comment
There was a problem hiding this comment.
This looks good as a first draft to continue working from
2 participants
This PR will resolve #5.
The slides are currently written in markdown with the intention of using pandoc to convert to the final content format.