CCSciPyMD/README.md

Scipy + MD + Mkdocs Cookiecutter Template

This repo is a template for cookiecutter. It creates a data science pipeline project, using the python scipy stack, mkdocs for documentation and pandoc to generate reports from markdown files.

Usage

cookiecutter https://git.acereca.ne/acereca/CCSciPyMD.git

This will start the creation process and ask for a new project name.

Project Setup

The created project is then based on a makefile piepline.

1. run all data processing tasks with

make all

2. create reports based on the processing

make docs

---

To createa and view the documentation use

make mkdocs

---

Cleanup removes all files from out/

make clean