Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.33 KB

README.md

File metadata and controls

29 lines (16 loc) · 1.33 KB

Cookiecutter Open Educational Ressources with Jupyter

A cookiecutter template. Creates a barebones structure to be used with a collection of jupyter notebooks that you want to make available as an Open Educational Resource.

The documentation is available at: TBD...

Installation

Apart from a python 3 installation you also need to install cookiecuttter. You can use pip:

pip install --user cookiecutter

Or conda:

conda install -c conda-forge cookiecutter

For further installation advice please refer to the official documentation.

Usage

To use the template to create your new project you have to open a terminal and navigate to the folder you want to create the project folder in. Now you can either download the template from GitHub and use it from the directory you saved it in:

cookiecutter <your_template_folder>/cookiecutter_oer_jupyter

Or you can tell cookiecutter to find the template on github:

cookiecutter gh:https://github.com/spatialaudio/cookiecutter_oer_jupyter

TBC...

This template was created as part of a project of the Datenkompass MV (DKMV) intiative for research data mangement in Mecklenburg Vorpommern, Germany.