https://github.com/mkrapp/cookiecutter-reproducible-science

boilerplate for reproducible and transparent science
https://github.com/mkrapp/cookiecutter-reproducible-science

cookiecutter cookiecutter-template

Last synced: 5 months ago
JSON representation

boilerplate for reproducible and transparent science

• Host: GitHub
• URL: https://github.com/mkrapp/cookiecutter-reproducible-science
• Owner: mkrapp
• License: other
• Created: 2016-07-23T00:42:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-01-15T13:19:54.000Z (about 4 years ago)
• Last Synced: 2024-08-09T02:19:31.748Z (8 months ago)
• Topics: cookiecutter, cookiecutter-template
• Homepage:
• Size: 4.88 KB
• Stars: 178
• Watchers: 4
• Forks: 80
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - mkrapp/cookiecutter-reproducible-science - boilerplate for reproducible and transparent science (Others)

README

        
Reproducible Science

====================

A boilerplate for reproducible and transparent science with close resemblances to the philosophy of [Cookiecutter Data Science](https://github.com/drivendata/cookiecutter-data-science): *A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.*

Requirements

------------

Install `cookiecutter` command line: `pip install cookiecutter`    

Usage

-----

To start a new science project:

`cookiecutter gh:mkrapp/cookiecutter-reproducible-science`

Project Structure

-----------------

```

.

├── AUTHORS.md

├── LICENSE

├── README.md

├── bin                <- Your compiled model code can be stored here (not tracked by git)

├── config             <- Configuration files, e.g., for doxygen or for your model if needed

├── data

│   ├── external       <- Data from third party sources.

│   ├── interim        <- Intermediate data that has been transformed.

│   ├── processed      <- The final, canonical data sets for modeling.

│   └── raw            <- The original, immutable data dump.

├── docs               <- Documentation, e.g., doxygen or scientific papers (not tracked by git)

├── notebooks          <- Ipython or R notebooks

├── reports            <- For a manuscript source, e.g., LaTeX, Markdown, etc., or any project reports

│   └── figures        <- Figures for the manuscript or reports

└── src                <- Source code for this project

    ├── data           <- scripts and programs to process data

    ├── external       <- Any external source code, e.g., pull other git projects, or external libraries

    ├── models         <- Source code for your own model

    ├── tools          <- Any helper scripts go here

    └── visualization  <- Scripts for visualisation of your results, e.g., matplotlib, ggplot2 related.

```

Check out my latest research project, which successfully applied the `cookiecutter` philosophy: [SEMIC: an efficient surface energy and mass balance model applied to the Greenland ice sheet](https://gitlab.pik-potsdam.de/krapp/semic-project).

License

-------

This project is licensed under the terms of the [BSD License](/LICENSE)