diff --git a/Home.md b/Home.md index 7442d5a..f17dbd7 100644 --- a/Home.md +++ b/Home.md @@ -1,8 +1,29 @@ # Welcome ! -This wiki gives a (rough) short list of best practices for scientific simulation works. The most important keywords are *reproducibility*, *organization*, *durability* and *efficiency*. If you follow the advice of this wiki, you should be able to move the pain out of running simulations. Have a read at the topics below: +This wiki gives a (rough) short list of best practices for scientific simulation +works. The most important keywords are *reproducibility*, *organization*, +*durability* and *efficiency*. This wiki proposes solutions to attain these +goals when doing simulation work (although some solutions can effectively be +used beyond simulations, e.g. for experimental data). + +The intended readership of this wiki is: + +- New PhD students working on simulations for their thesis. They will benefit + from most of the pages in this wiki and are required to implement [good + simulations practices](Research-simulation) +- Interns working on simulations or just using code in general. They will find + helpful advice on how to manage code, data and workflows. +- Anyone interested in code, workflow and/or data management. + +> **Disclaimer**: this wiki is not meant as a tutorial for the software that is +> referenced. The reader is expected to document themselves thoroughly whenever +> a particular solution is proposed, to experiment for themselves, and to ask +> their advisor, or more experienced colleagues, when in doubt. ## Table of contents -- [Computing environment](Computing-environment) +- [Research simulation good practices](Research-simulation): a list of + high level principles that should always be applied when running simulations +- [Computing environment](Computing-environment): setting up a lasting hassle-free + computing environment - [Workflow management](Workflow-management) -- [Data management](Data-management) \ No newline at end of file +- [Data management](Data-management) diff --git a/Research-simulation.md b/Research-simulation.md new file mode 100644 index 0000000..7387461 --- /dev/null +++ b/Research-simulation.md @@ -0,0 +1 @@ +# Good simulation practices