Installation

Developer Guide

You can also install COMPAS CRA manually from source.

Install from source

Create a virtual environment using your tool of choice (e.g. virtualenv, conda, etc), optional.

conda create -n cra
conda activate cra

Go to your directory and clone compas_cra:

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

Install requirements

pip install -r requirements.txt
pip install -r requirements-dev.txt

In the requirements-dev.txt, we also installed COMPAS CRA as an editable version from local source.

pip install -e .

Install IPOPT solver.

conda install ipopt  # For Windows: conda install ipopt=3.11.1

Install compas_view2 for visualisation.

conda install -c conda-forge compas_view2=0.7.0

A quicker way - from .yml file

Set up conda channels

conda config --add channels conda-forge

Clone compas_cra:

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

Install COMPAS CRA with all dependencies in a new conda environment:

conda env create -f env_osx.yml  # (Mac)
conda env create -f env_win.yml  # (Windows)
conda env create -f env_linux.yml  # (Linux)

conda activate cra  # you can change the environment name in .yml file

Update conda packages

conda env update cra --file env_osx.yml --prune  # (Mac)
conda env update cra --file env_win.yml --prune  # (Windows)
conda env update cra --file env_linux.yml --prune  # (Linux)

Verify installation

After running:

invoke test

You should see something like:

============================= test session starts ==============================
platform darwin -- Python 3.8.13, pytest-7.0.1, pluggy-1.0.0
rootdir: ~/compas-dev/compas_cra, configfile: setup.cfg, testpaths: tests
collected 4 items

tests/test_cra.py .                                                      [ 25%]
tests/test_cra_penalty.py .                                              [ 50%]
tests/test_ipopt.py .                                                    [ 75%]
tests/test_rbe.py .                                                      [100%]

=============================== warnings summary ===============================
.
.
.
-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
======================== 4 passed, 5 warnings in 2.41s =========================

Rhino Installation

compas_cra is developed independent of the functionality of CAD software. However, CAD software can be useful to create geometrical objects. For a more detailed information on how to install COMPAS and its packages for Rhino, please refer to Working in Rhino page of the COMPAS documentation.

In order to install COMPAS CRA for Rhino, do

$ python -m compas_rhino.uninstall
$ python -m compas_rhino.install
$ python -m compas_rhino.install -p compas_cra

Every time a new file is opened in Rhino, be sure to restart Rhino or reset the Python Script Engine before running scripts.

Verify Conda Environment, COMPAS CRA, and COMPAS in Rhino

import compas_bootstrapper

print(compas_bootstrapper.ENVIRONMENT_NAME)
print(compas_bootstrapper.PYTHON_DIRECTORY)
print(compas_bootstrapper.INSTALLED_PACKAGES)

File can also be found in scripts/rhinoenv.py

Known issues (Windows)