Skip to content

Getting started

Requirements

  • Python >= 3.7
  • Git
  • Poetry (if the command line below doesn't work, see here):

    curl -sSL https://install.python-poetry.org | python3 -
    
    (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
    
  • Cookiecutter (don't create a new environment, poetry will take care of that):

    pip install cookiecutter
    
    conda install cookiecutter
    

Usage

Info

After answering a few questions, the command line below creates a new folder with everything you need inside. Especially, it created a README.md file that helps you understand the package organization you just created.

Run the following command line to create a new project folder. Note that it will put everything inside a new folder; thus, you don't have to mkdir first.

cookiecutter gh:MICS-Lab/poetry_cookiecutter