Replication Package¶
A project is incomplete if its central result cannot be inspected or rerun.
Recommended structure¶
artifact/
├── README.md
├── environment/
├── subjects/
│ └── fetch_subjects.py
├── src/
├── configs/
├── scripts/
│ ├── run_experiment.sh
│ └── make_tables.py
├── results/
│ ├── raw/
│ └── processed/
└── report/
README checklist¶
- system requirements;
- exact versions;
- one-command quick start if possible;
- expected runtime/cost;
- how to obtain subject systems;
- how to regenerate each reported table/figure;
- known non-deterministic steps;
- licenses and data restrictions.