COMPAS Documentation

This is the documentation of the core infratructure of COMPAS, an open source framework for computational research and collaboration in Architecture, Engineering, Fabrication, and Construction.

Note

This is the documentation of the core Python package of COMPAS. If you are looking for the COMPAS Framework website, please go to https://compas.dev.

User Guide

If you want to use COMPAS for your research or in one of your projects, this is the place to start.

• User Guide
  • Introduction
  • Installation
  • First Steps
  • What’s Next
  • Geometry
  • Datastructures
  • Visualisation
  • Colors and Color Maps
  • Dealing with Tolerances
  • Serialising Data
  • Remote Procedure Calls (RPC)
  • Hash Tree
  • Working in Rhino
  • Working in Rhino 8 (with CPython)
  • Working in Grasshopper
  • Working in Blender
  • Releases
  • Citing
  • License

Development

If you want to contribute to COMPAS, this is the place to start.

• Developer Guide
  • Development Setup
  • Development Workflow
  • Code Contributions
  • Contributing to the Documentation
  • Developing an Extension
  • Developing a Plugin For a Pluggable
  • Developing a GH Component
  • Implementing a New Data Type
  • Creating a new data type
  • Attribute types

API Reference

The reference documentation of the core package and the CAD packages.

• API Reference
  • compas
  • compas_blender
  • compas_ghpython
  • compas_rhino

Indices and tables

• Index

• Module Index

• Search Page