Installation

Install with conda

The recommended way to install COMPAS is with conda using an environment.

All-in-one

Create an environment and give it a name, e.g. "project", install Python 3.7 and COMPAS (use the conda-forge channel), say “yes” to all questions asked.

conda create -n project python=3.7 COMPAS -c conda-forge --yes

Step-by-Step

  1. Create a Python 3.7 environment named “project”.

  2. Activate the environment.

  3. Install COMPAS

conda create -n project python=3.7
conda activate project
conda install COMPAS -c conda-forge

Verify

conda activate project
python
>>> import compas
>>> compas.__version__
'0.15.6'

Install with pip

Install a released version.

pip install COMPAS

Install an editable version from local source.

pip install -e .

Note that the same is possible in combination with conda environments.

conda activate project
pip install -e .

Known Issues

If you encounter a problem that is not described here, please file an issue using the Issue Tracker.

Installing Planarity

Problem The installation process with pip fails while installing planarity, because cython is not installed.

Install cython using pip (or conda), before installing COMPAS.

pip install cython --install-option="--no-cython-compile"
pip install COMPAS
conda install cython
pip install COMPAS

Microsoft Visual C++ Build Tools

Problem The installation of COMPAS, or a COMPAS package, or any other package, fails because “Microsoft Visual C++ Build Tools are missing”.

To install the Microsoft Visual C++ Build Tools choose one of the options provided here: https://www.scivision.dev/python-windows-visual-c-14-required/ and just follow the instructions.