Skip to content

Installation¤

User¤

Note

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

uv venv <myenvname> --python 3.13
source <myenvname>/bin/activate
uv pip install compas_timber

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

uv venv <myenvname> --python 3.13
source <myenvname>/bin/activate

Install the package in editable mode with its development dependencies

uv pip install -e ".[dev]"

To compile the Rhino8 Grasshopper components

invoke build-cpython-ghuser-components