Skip to main content

COMPAS CEM

Github Actions Build Status License PyPI Package latest release Python versions Made with COMPAS CAD paper ArXiv paper Zenodo DOI

Constrained form-finding of a spiral staircase

The combinatorial equilibrium method (CEM) for COMPAS.

The CEM is a numerical form-finding method that automatically generates forms in static equilibrium for spatial structures modeled as 3D bar systems. These systems resist external loads purely under tensile and compressive axial forces, leading to mechanically efficient structural configurations. COMPAS CEM encapsulates the CEM into an open-source structural design tool that enables the formulation and the solution of constrained form-finding problems in plain and simple Python code.

Main features

  • Mix tension and compression forces: Explore a wider spectrum of structural typologies by combining internal tension and compression forces in the same structure. Design space frames, bridges, tensegrities, and staircases and go beyond the conventional catalog of compression-only shells and cable-nets!

  • Solve constrained form-finding problems efficiently via automatic differentiation: Generate forms in static equilibrium that simultaneously meet a priori design goals such as best-fitting a global target shape, restraining bar lengths, and controlling the reaction forces at the supports of a structure.

  • Usable across different 3D modeling software and operating systems: COMPAS CEM runs on Windows, MacOS and Linux (perhaps one day in the metaverse) and it does not depend on any CAD software to work. However, it provides the necessary interfaces to be seamlessly used inside popular design environments like Rhino, Blender, and Grasshopper. As a COMPAS extension, COMPAS CEM offers native integration and data exchange with other extensions and plugins in the COMPAS ecosystem.

  • Move those sliders with the Grasshopper plugin: Are you a Grasshopper person? Worry not. COMPAS CEM is also shipped as a precooked Grasshopper plugin to readily integrate our constrained form-finding engine into your next spaghetti pipeline 🍝.

Installation

Install COMPAS CEM with a one-liner via pip:

pip install compas-cem

Alternatively, add it to a uv project:

uv add compas-cem

Either pulls in COMPAS 2.x and the other core dependencies automatically. COMPAS CEM supports Python 3.9 to 3.13. To draw diagrams with the plotter or the viewer, as the examples do, install the viz extra instead, for example pip install "compas-cem[viz]". For other ways to install and the uv sync development setup, see the installation guide.

Grasshopper plugin

The Grasshopper plugin runs in Rhino 8. Install it from Rhino's Package Manager: search for compas_cem, install it and restart Rhino. The first component you run installs the compas-cem Python package into Rhino.

First steps

Are you a bug hunter?

If you find a bug or want to suggest a potential enhancement, please help us tackle it by filing a report.

Questions and feedback

We encourage the use of the COMPAS framework forum for questions and discussions.

Contributing

Pull requests are warmly welcome! Check the Contributor's Guide for more details.

Citing

If you use COMPAS CEM for a project or research, please cite us using these references.

Acknowledgements

This work has been supported in part by the U.S. National Science Foundation under grant OAC-2118201 and the NSF Institute for Data Driven Dynamical Design.

License

MIT

Metadata

Release files for compas-cem 0.10.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for compas-cem 0.10.1
File Size Uploaded Provenance Actions
compas_cem-0.10.1.tar.gz 323.2 kB Without provenance Details for compas_cem-0.10.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for compas-cem 0.10.1
File Interpreter ABI Platform Actions
compas_cem-0.10.1-py3-none-any.whl Python 3 none any Details for compas_cem-0.10.1-py3-none-any.whl

Total release size: 714.4 kB

Release files / compas_cem-0.10.1.tar.gz

Download URL compas_cem-0.10.1.tar.gz
Size 323.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d754711227bc12cc56028f5bd16da762f4129c745919b70c52527689e0b10b23
BLAKE2b-256 checksum
How to use checksums
dd8a1e5e373743f50fe6bff3ab05c5ff65c0bfb50209a38731e911b8191e1fc9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Release files / compas_cem-0.10.1-py3-none-any.whl

Download URL compas_cem-0.10.1-py3-none-any.whl
Size 391.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f5c74a11d63d0279a0a22aee3abf5f24e07845e8d4775a90d84618b786446377
BLAKE2b-256 checksum
How to use checksums
0cbef11566ee0d7cb1d51c239e6d97419c3d4be88a4aa53ead6e5c68e270da33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.10.11

Security for compas-cem 0.10.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page