Repository Structure

Key Principles

We have one overriding goal: All output must be replicable

This means that a user with no special experience should be able to clone the repository, delete everything other than the code and raw input files, and reproduce all output including intermediate data files, statistical analysis, tables and figures, and PDFs of the paper draft and slides. Doing this should be a straightforward and intuitive process, and while the computational time may be substantial, the human time required should not. Not only must the current output be replicable, but all previous output must be as well (e.g., results in any previous draft or issue deliverable). The output not only needs to be replicable today; it needs to remain so in the future.

Scope

A repository typically contains all work related to a specific research project (e.g., a single journal article). This includes the data, analysis, paper draft, slides, and any supplementary information like data use agreements, notes from seminar presentations, and so on.

Readme

Link to RA manual

Directories

Inputs and outputs

Build code

• Make.py
• inputs.txt

Standard Directories

• data
• analysis
• paper_slides
• lib

Wiki

LFS and .gitattributes

.gitignore

SCONS