Skip to content

Releases: ai4er-cdt/ai4er-cookiecutter

Base version

09 Oct 10:44
3a1edaf
Compare
Choose a tag to compare

ai4er-cookiecutter version 0.1

This very first version (v0.1) of the ai4er-cookiecutter allows you to automatically set up:

  1. A useful folderstructure for notebooks, source code, documentation, etc.
  2. Create a symlink to your data folder for easy and unified data access.
  3. Initialize as github repo and link to an existing (empty!) repository on github.com
  4. Create a new conda environment for your project and store it in the projects /env subdirectory

Prerequisites

Please make sure that you have a working version of python (>= 3.0) and cookiecutter (>=1.7) installed.
To install cookiecutter, simply use

pip install --user cookiecutter
or
conda install cookiecutter

For more information on the installation of cookiecutter, see here.

Usage

To use this cookiecutter, you simply type the following into your command line (Note: cookiecutter must be installed as prerequisite).

cookiecutter https://github.com/ai4er-cdt/ai4er-cookiecutter/tree/v0.1

The cookiecutter will then automatically prompt you to set project names, etc.