This guide is intended for people who want to contribute to the code and documentation of the core COMPAS packages:
Note, however, that the general procedure is applicable to all COMPAS package development.
To set up a developer environment
Fork the repository and clone the fork.
Create a virtual environment using your tool of choice (e.g. virtualenv, conda, etc).
conda create -n compas-dev python=3.7 conda activate compas-dev
Install development dependencies:
cd path/to/compas pip install -r requirements-dev.txt
Make sure all tests pass:
Create a branch for your contributions.
git branch title-proposed-changes git checkout title-proposed-changes
Start making changes!
Submitting a PR
Once you are done making changes, you have to submit your contribution through a pull request (PR). The procedure for submitting a PR is the following.
Make sure all tests still pass:
Add yourself to
Commit your changes and push your branch to GitHub.
Create a pull request through the GitHub website.
During development, use pyinvoke tasks on the command line to ease recurring operations:
invoke clean: Clean all generated artifacts.
invoke check: Run various code and documentation style checks.
invoke docs: Generate documentation.
invoke test: Run all tests and checks in one swift command.
principle of least astonishment
api docs * napoleon * Numpy-style
Each of the core packages is divided into subpackages that group functionality into logical components.
compas is divided into:
The API of each subpackage is documented in the docstring of its
__init__.py file using basic RestructuredText.
From outside of these packages, functionality should be imported directly from the subpackage level,
regardless of the code structure underneath.
For example, in some
from compas.geometry import add_vectors from compas.geometry import oriented_bounding_box_numpy from compas.geometry import Polygon from compas.geometry import Transformation from compas.numerical
To allow the public API of the modules and packages contained in a subpackage to reach the subpackage level,
each module should declare the classes, functions and variables of its public API in the module’s
Per package, the APIs of the contained module are collected in
__all__ variable of the package (in the
__all__ = [_ for _ in dir() if not _.startswith('_')]
COMPAS has an extensible architecture based on plugins that allows to customize and extend the functionality of the core framework.
For a plugin to work, there needs to exist a counterpart to be connected to. This means there are two components involved:
compas.plugins.pluggable()interface: the extension point that COMPAS defines as the counterpart for plugins to connect to.
compas.plugins.plugin()implementation: a concrete implementation of the
Both of these components are declared using decorators:
@pluggable def do_hard_stuff(input): pass @plugin(pluggable_name='do_hard_stuff') def do_hard_stuff_numpy(input): # NOTE: Here use the power of numpy to do hard stuff very fast # ..
Once these parts are implemented, the program could simply
call the function
do_hard_stuff and the appropriate plugin
numpy would be called automatically.
Why are plugins important?
The example above is just a single code block, but the power of plugins comes
from the ability to split those two parts -the
compas.plugins.plugin()- into completely different files, folders
or even entire projects and still work the same way.
Additionally, COMPAS is able to pick the most suitable plugin implementation
for its current execution context. For instance, one could have two implementations
of the same
compas.plugins.pluggable() definition, one using
another one using
Rhino SDK and have the correct one automatically selected
based on where your script is executing.
How to make plugins discoverable?
COMPAS plugin discovery is based on naming conventions. This is mainly due to
the need to support IronPython inside Rhino, which lacks
infrastructure. For more details, check
these python guidelines.
A COMPAS plugin needs to fulfill two conditions:
Name: The package name should be prefixed with
Metadata: The package should define a bit of metadata listing the modules that contain plugins. This is done declaring a variable called
__all_plugins__ = ['compas_cgal.booleans'].
COMPAS automatically discovers plugins searching over all available packages in the system,
and picks up those prefixed with the
All packages are included in the search: packages installed with
pip, packages made
available through the
IRONPYTHONPATH, local packages, etc.
Once a package is found, the metadata in
__all_plugins__ is read and all modules
listed are analyzed to look for functions decorated with the
A complete example
Let’s explore a complete example to gain a better understanding.
For the sake of example, we are going to assume that
compas core defines
@pluggable(category='booleans') def boolean_union_mesh_mesh(A, B): pass
Now let’s write a plugin that implements this interface:
__all_plugins__ = ['compas_plugin_sample.boolean_trimesh']
import trimesh @plugin(category='booleans', requires=['trimesh']) def boolean_union_mesh_mesh(A, B): va, fa = A at = trimesh.Trimesh(vertices=va, faces=fa) vb, fb = B bt = trimesh.Trimesh(vertices=vb, faces=fb) r = at.union(bt, engine='scad') return r.vertices, r.faces
Voilà! We have a trimesh-based boolean union plugin!
There are a few additional options that plugins can use:
requires: List of required python modules. COMPAS will filter out plugins if their requirements list is not satisfied at runtime. This allows to have multiple implementations of the same operation and have them selected based on which packages are installed. on the system. Eg. requires=[‘scipy’].
trylast: Plugins cannot control the exact priority they will have but they can indicate whether to try to prioritize them or demote them as fallback using these two boolean parameters.
pluggable_name: Usually, the name of the decorated plugin method matches that of the pluggable interface. When that is not the case, the pluggable name can be specified via this parameter.
domain: extension points are unambiguously identified by a URL that combines domain, category and pluggable name. All COMPAS core plugins use the same domain, but other packages could potentially decide to use a different domain to ensure collision-free naming of pluggable extension points.
While developing plugins, it is also possible to enable print output to understand what
how plugin selection works behind the scenes. To enable that, set
from compas.plugins import plugin_manager plugin_manager.DEBUG = True