Installation

Install

pip install compas_cra

Windows, macOS and Linux, CPython 3.9-3.13. The IPOPT solver is compiled into the package.

pip install compas_cra[viz]                                              # with viewers
python -c "from compas_cra import _native; print(_native.IPOPT_VERSION)" # verify

In Rhino 8, run a script with this header — Rhino installs everything on the first run (examples in scripts/):

#! python3
# venv: compas-cra
# r: compas_cra

Development

Windows

git clone https://github.com/BlockResearchGroup/compas_cra.git
cd compas_cra

uv venv --python 3.12
source .venv/Scripts/activate

uv pip install invoke compas_invocations2
invoke setup
invoke test

macOS

Nothing has to be installed first. If Homebrew is not on the machine, invoke setup installs it, along with bash and gcc — macOS asks for your password once, because the Homebrew installer creates its prefix as root. The account has to be an administrator, which is the default for the first account on a Mac.

Run it as yourself. Not sudo invoke setup: Homebrew refuses to install as root, and the venv, build/ and the staged IPOPT tree would all come out root-owned. The task asks for the password at the single point it needs one.

Set COMPAS_CRA_NO_BREW_INSTALL=1 to refuse the bootstrap and be told to install Homebrew yourself instead.

A checkout path containing a space (Desktop/untitled folder/…) is fine: IPOPT is autotools, which cannot build under such a path, so invoke setup builds and stages it in ~/.compas_cra/ipopt instead and points the extension build there.

git clone https://github.com/BlockResearchGroup/compas_cra.git
cd compas_cra

uv venv --python 3.12
source .venv/bin/activate

uv pip install invoke compas_invocations2
invoke setup
invoke test

Linux

sudo apt install build-essential gfortran libopenblas-dev git curl make patch pkg-config

git clone https://github.com/BlockResearchGroup/compas_cra.git
cd compas_cra

uv venv --python 3.12
source .venv/bin/activate

uv pip install invoke compas_invocations2
invoke setup
invoke test

After the first build

uv pip install -e .   # rebuild after C++ changes; Python changes need no reinstall

Documentation only

uv venv --python 3.12
source .venv/Scripts/activate
uv pip install -r requirements.txt
invoke docs

Tasks

Command	What it does
invoke setup	Build the solver and install the package, on any platform
invoke docs	Serve the site at localhost:8000 with live reload; --no-serve builds dist/docs
invoke lint	ruff check --fix src tests
invoke format	ruff format src tests
invoke test	Run the test suite
invoke release <major\|minor\|patch>	Bump, tag and push, which triggers the release

Without a local toolchain

pip install cibuildwheel
CIBW_BUILD="cp312-*" cibuildwheel --output-dir dist   # Linux/Docker; exactly what CI runs

For building IPOPT by hand, see packaging/README.md.