added readme

This commit is contained in:
Lucas Frérot 2024-12-27 08:18:42 +01:00
commit faa3858401
No known key found for this signature in database
GPG Key ID: 03B54A50E3FBA7E8
1 changed files with 9 additions and 0 deletions

9
README.md Normal file
View File

@ -0,0 +1,9 @@
> **READ FIRST**: [Good simulation practices wiki](https://git.dalembert.upmc.fr/lfrerot/good_simulation_practices/wiki)
# Data and code tenets helper
[Principles of code and data
management](https://git.dalembert.upmc.fr/lfrerot/good_simulation_practices/wiki/Research-simulation),
lists tenets that must be respected when working with simulation code and
scientific data. This repository provides scripts to help automatically enfore
these tenets (as much as possible).