Skip to main content

The COMPAS framework

Project description

The COMPAS framework

Build Status

The COMPAS framework is an open-source, Python-based framework for computational research and collaboration in architecture, engineering and digital fabrication.

The main library consists of a core package (compas) and several additional packages for integration of the core functionality in CAD software (compas_blender, compas_rhino, compas_ghpython).

The core package defines all real functionality. The CAD packages simply provide a unified framework for processing, visualising, and interacting with geometry and datastructures, and for building user interfaces in different CAD software.

The complete documentation of the compas framework is available at https://compas-dev.github.io/.

Getting Started

The recommended way to install COMPAS is to use Anaconda/conda:

$ conda config --add channels conda-forge
$ conda install COMPAS

But it can also be installed using pip:

$ pip install COMPAS

Once installed, you can verify your setup. Start Python from the command line and run the following:

>>> import compas
>>> import compas_rhino
>>> import compas_blender
>>> import compas_ghpython

Optionally, you can also install from source. Check the documentation for more details.

First Steps

Some useful resources for first explorations:

Questions and feedback

The COMPAS framework has a forum: http://forum.compas-framework.org/ for questions and discussions.

Issue tracker

If you find a bug, please help us solve it by filing a report.

Contributing

If you want to contribute, check out our developer guidelines.

License

The main library of COMPAS is released under the MIT license.

Contact

The COMPAS framework is developed by the Block Research Group at ETH Zurich, with the support of the NCCR (National Centre for Competence in Research) in Digital fabrication. Main contributors are Tom Van Mele, Andrew Liew, Tomás Méndez and Matthias Rippmann.

For questions, comments, requests, ..., please contact the main developers directly.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

COMPAS-0.3.0.tar.gz (1.7 MB view hashes)

Uploaded Source

Built Distribution

COMPAS-0.3.0-py2.py3-none-any.whl (1.9 MB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page