How to use this template

1. Install required tools (see here)
2. Click Use this template on Github (you need to be logged in to Github)
3. Clone your new and shiny repo (eg. using Github Desktop)
4. Prepare your environment to get started
5. Delete this section of this document!
6. Replace all REPLACE_ME placeholders

REPLACE_ME: Title

REPLACE_ME: Enter here a one-liner saying what this code is or does, or will do!

Requirements

Install the following tools:

• Anaconda
• Visual Studio Code and extensions: python, pylance and editorconfig
• Github Desktop

Getting started

Create a environment using Anaconda prompt:

cd FOLDER_OF_REPO
conda env create -n NAME_OR_TITLE -f environment.yml

Activate the environment:

conda activate NAME_OR_TITLE
python -m compas_rhino.install

Open folder in Visual Studio Code:

code .

Select your environment from the lower left area in Visual Studio Code.

🚀 You're ready!

Start coding on example.py and explore the example_grasshopper.ghx file.

Additional ideas

A few additional things to try:

1. On Visual Studio Code, press Ctrl+Shift+P, Select linter and select flake8
2. To auto-format code, right-click, Format document...
3. (Windows-only) Change shell: press Ctrl+Shift+P, Select Default Shell and select cmd.exe
4. Try git integration: commit, pull & push are all easily available from Visual Studio Code.