Compare commits
2 Commits
5fd3cd75a0
...
master
| Author | SHA1 | Date |
|---|---|---|
|
|
662a044b2d | |
|
|
8d20a27094 |
34
README.md
34
README.md
|
|
@ -2,8 +2,9 @@
|
||||||
|
|
||||||
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 for documentation
|
[scipy stack](https://scipy.org/), [mkdocs](https://www.mkdocs.org/) for
|
||||||
and pandoc to generate reports from markdown files.
|
documentation and [pandoc](https://pandoc.org/) to generate reports from
|
||||||
|
markdown files.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
@ -12,3 +13,32 @@ 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
|
||||||
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue