A logical, reasonably standardized, but flexible project structure for doing and sharing data science work.
- Python 2.7 or 3.5
- Cookiecutter Python package >= 1.4.0: This can be installed with pip by or conda depending on how you manage your Python packages:
$ pip install cookiecutteror
$ conda config --add channels conda-forge
$ conda install cookiecuttercookiecutter https://github.com/ManavalanG/cookiecutter-data-science
The directory structure of your new project looks like this:
├── LICENSE
│
├── Makefile <- Makefile with commands like `make data` or `make train`
│
├── README.md <- The top-level README for developers using this project.
│
├── configs <- Stores snakemake configs
│ └── main.yaml <- snakemake config file
│
├── 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 <- A default Sphinx project; see sphinx-doc.org for details
│
├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ │ the creator's initials, and a short `-` delimited description, e.g.
│ │ `1.0-jqp-initial-data-exploration`.
│ │
│ └── exploratory <- Jupyter notebooks that are used for exploring data
│ and not yet finalized or taken decent shape
│
├── references <- Data dictionaries, manuals, and all other explanatory materials.
│
├── reports <- Generated analysis as HTML, PDF, LaTeX, etc.
│ └── figures <- Generated graphics and figures to be used in reporting
│
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
│
├── Snakefile <- main snakemake file
│
├── src <- Source code for use in this project.
│ ├── __init__.py <- Makes src a Python module
│ │
│ │
│ └── visualization <- Scripts to create exploratory and results oriented visualizations
│
├── logs <- Stores log files
│
└── tox.ini <- tox file with settings for running tox; see tox.testrun.org
We welcome contributions! See the docs for guidelines.
pip install -r requirements.txt
py.test tests