Skip to content

Installation¤

Install the compas_fab library itself. For the CAD environment you plan to use, also see CAD front-ends. For the planning backend you plan to use, see Choosing a backend.

We recommend uv for managing your Python environment, but pip and conda work too.

Install uv¤

If you do not have uv installed:

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Create a virtual environment¤

uv venv

Activate it:

source .venv/bin/activate

.venv\Scripts\activate

Install compas_fab¤

uv pip install compas_fab

Or with pip:

pip install compas_fab

Or with conda from the conda-forge channel:

conda install -c conda-forge compas_fab

Verify installation¤

python -m compas_fab

You should see a confirmation message that compas_fab is installed correctly.

Next steps¤

  • Choose a backend: pick a planner that matches what you want to do.
  • Set up a CAD front-end: Rhino, Grasshopper, Blender, COMPAS Viewer or headless Python.
  • Concepts: a backend-agnostic walkthrough of the data model (RobotCell, RobotCellState, Target, Waypoints).