Installation

User

Note

While there are many similar tools, we recommend using mamba to manage your Python environments. It can be installed from here.

mamba create -n <myenvname> compas_timber -c conda-forge --yes
mamba activate <myenvname>

Developer

If you wish to contribute to or modify COMPAS Timber, fork the repository and clone the fork

git clone https://github.com/<yourgithub_username>/compas_timber.git
cd compas_timber

Create a new environment if necessary

mamba create -n <myenvname> python=3.10 --yes
mamba activate <myenvname>

Install the package in editable mode with its development dependencies

pip install -e .[dev]

The Grasshopper components are developed and built in the separate timber_design repository.