lfrerot
/
good_simulation_practices
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added simulation principles page

Lucas Frérot 2024-10-25 12:16:19 +02:00
parent 31d0b2c57e
commit e9de364393
No known key found for this signature in database
GPG Key ID: 03B54A50E3FBA7E8
2 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Home.md

@ -1,8 +1,29 @@
# Welcome ! # 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 ## 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) - [Workflow management](Workflow-management)
- [Data management](Data-management) - [Data management](Data-management)

1
Research-simulation.md Normal file

@ -0,0 +1 @@
# Good simulation practices