carpentries-incubator / docker-introduction

Reproducible Computational Environments using Containers
https://carpentries-incubator.github.io/docker-introduction/
Other
42 stars 48 forks source link

Include "10 Simple Rules for Dockerfiles" reference #128

Closed sgibson91 closed 2 years ago

sgibson91 commented 2 years ago

Hi all, thanks very much for developing this lesson! I'm keen to help teach it at some point

I'm dropping a link to an article "10 Simple Rules for writing Dockerfiles for reproducible data science" that I think would be an excellent additional reference for this lesson https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1008316

svenvanderburg commented 2 years ago

That paper comes with a github repo that has some nice real-world examples of docker images: https://github.com/nuest/ten-simple-rules-dockerfiles/tree/master/examples .

I had some trouble though to actually run them and reproduce the results (so far for reproducible science...)

These 2 I could run and seem like nice real-world examples that could be useful in the lesson:

paper on reproducible research environments. Uses Docker to run an interactive Jupyter instance that allows you to completely reproduce the paper.

Docker qgis model. Based on some satellite data it can create these kind of images (by running a model in a docker container) image .

jcohen02 commented 2 years ago

Thanks for the suggestion @sgibson91, and the link to the examples @svenvanderburg. It's a shame that not all the examples are working at present but really good to highlight that section of the repository nonetheless.

I wasn't sure of the best place to add this information so for now I've just added a small callout box to the end of the advanced containers epsiode (05b). It seems reasonable to highlight this once all the information about Dockerfiles has been covered. However, I also thought it may fit a little earlier on where the initial Dockerfile overview is provided in the main episode 5 content.

Feel free to suggest edits/additions to the text in PR #139, or to suggest moving the material to an alternative location.