Overview
Installation
Install COMPAS with uv, mamba, conda or pip.
COMPAS is a regular Python package on PyPI and conda-forge. Pick one package manager and use it on every step below; the tabs stay in sync.
Requirements
You need a supported Python version and one of these package managers:
- uv, which is fast and manages Python for you. We recommend it.
- Miniforge, which provides both
mambaandconda. - Python, which includes
pip.
Install COMPAS
uv init my-project
cd my-project
uv add compas
mamba create -n compas-dev -c conda-forge compas
mamba activate compas-dev
conda create -n compas-dev -c conda-forge compas
conda activate compas-dev
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install compas
Verify the installation
uv run python -m compas
python -m compas
python -m compas
python -m compas
This prints the installed version, for example 2.15.1.
Update COMPAS
uv sync --upgrade-package compas
mamba update -c conda-forge compas
conda update -c conda-forge compas
pip install --upgrade compas
Extensions install the same way. Replace
compas with the package name, for example uv add compas_viewer. See Packages for what is available.