- Install required tools (see here)
- Click
Use this template
on Github (you need to be logged in to Github) - Clone your new and shiny repo (eg. using
Github Desktop
) - Prepare your environment to get started
- Delete this section of this document!
- Replace all
REPLACE_ME
placeholders
REPLACE_ME: Enter here a one-liner saying what this code is or does, or will do!
Install the following tools:
- Anaconda
- Visual Studio Code and extensions: python, pylance and editorconfig
- Github Desktop
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.
A few additional things to try:
- On Visual Studio Code, press
Ctrl+Shift+P
,Select linter
and selectflake8
- To auto-format code,
right-click
,Format document...
- (Windows-only) Change shell: press
Ctrl+Shift+P
,Select Default Shell
and selectcmd.exe
- Try git integration: commit, pull & push are all easily available from Visual Studio Code.