Installation

Install with conda

The recommended way to install COMPAS is with conda. For example, create an environment named research and install COMPAS.

conda config --add channels conda-forge
conda create -n research COMPAS

Afterwards, simply activate the environment and run the following command to check if the installation process was successful.

conda activate research
python -m compas

Yay! COMPAS is installed correctly!

COMPAS: 0.19.1
Python: 3.8.2 | packaged by conda-forge | (default, Apr 24 2020, 07:56:27) [Clang 9.0.1 ]

conda create -n research python=3.7 COMPAS

conda install -n research COMPAS

Install with pip

Install COMPAS using pip from the Python Package Index.

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

Install an editable version from local source.

cd path/to/compas
pip install -e .

Note that installation with pip is also possible within a conda environment.

conda activate my-project
pip install -e .

By default, planarity is marked as an optional requirement for installation with pip on Windows. To include planarity, add a conditional to the install command.

pip install compas[planarity]

pip install -e .[planarity]

Update with conda

To update COMPAS to the latest version with conda

conda update -n research COMPAS

To switch to a specific version

conda install -n research COMPAS=0.19.1

Update with pip

If you installed COMPAS with pip the update command is the following

pip install --upgrade COMPAS

Or to switch to a specific version

pip install COMPAS==0.19.1

Known Issues

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

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