Compare commits

..

No commits in common. "master" and "5fd3cd75a0af5f2ea1c6440cd45b3f3492f0eb77" have entirely different histories.

1 changed files with 2 additions and 32 deletions

View File

@ -2,9 +2,8 @@
This repo is a template for [cookiecutter](https://cookiecutter.readthedocs.io). This repo is a template for [cookiecutter](https://cookiecutter.readthedocs.io).
It creates a data science pipeline project, using the python It creates a data science pipeline project, using the python
[scipy stack](https://scipy.org/), [mkdocs](https://www.mkdocs.org/) for [scipy stack](https://scipy.org/), mkdocs for documentation
documentation and [pandoc](https://pandoc.org/) to generate reports from and pandoc to generate reports from markdown files.
markdown files.
## Usage ## Usage
@ -13,32 +12,3 @@ cookiecutter https://git.acereca.ne/acereca/CCSciPyMD.git
``` ```
This will start the creation process and ask for a new project name. 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
```shell
make all
```
2) create reports based on the processing
```shell
make docs
```
---
To createa and view the documentation use
```shell
make mkdocs
```
---
Cleanup removes all files from `out/`
```shell
make clean
```