good_simulation_practices/README.md

20 lines
668 B
Markdown

> **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).
## Dependencies
The script `rtenets` requires:
- bash
- git
- curl (optional, for web-based operations)
- jq (optional, for gitea API calls)
- python (optional, to setup dtool and snakemake)