A generic template for an analysis project repository.
This repository is a template for scientific analysis projects.
This template lays out a set of recommended folders for organizing files in the project.
These folders are:
custom/custom code for the projectdata/any data from the project that are included in the repositoryfigures/any figures from the project that are included in the repositorynotebooks/Jupyter notebooks that do or illustrate parts of the projectscripts/scripts that run parts of the project
In addition, the repository should include the following files:
- A
LICENSEfile, indicating which license the code is shared under - A
requirements.txtfile, listing out any dependencies
The repository should include a descriptive README in the base folder.
Suggested sections in the README are as follows:
A brief description of the project.
A note on how to interact with this project. For example, this could guide people interested in the project to start with the notebooks.
Links to the reference for the project, such as a preprint or paper.
Notes on what requirements there are to run this project.
This should include programming language, major version required, and any dependencies.
A brief description of the repository layout and contents.
This should be a list of all subfolders, and a quick description of what they contain.
This list folder can be adapted from the Files & Folders list above.