compas_tf
Timber floor development. A parametric model of a timber floor — columns, ribs, beds, t-sections, oculus and the connectors that hold them together — that you can build, cut, measure, extract from and hand to a shop as STEP.
Documentation: https://brg-research.github.io/compas_tf/
Use it
pip install compas_tf
import compas
model = compas.json_load("cantilevers_baked_model.json")
print(len(list(model.geometry_elements()))) # 237
print(len(list(model.contacts()))) # 733
A written model is baked — every boolean already evaluated and stored on the
element — so it loads in 0.60 s with no boolean backend involved.
compas_tf_example is a
standalone project that does nothing but read one.
Develop it
Needs git, uv and Python 3.10+.
git clone https://github.com/BRG-research/compas_tf.git
cd compas_tf
uv venv .venv --python 3.12
source .venv/Scripts/activate # macOS / Linux: source .venv/bin/activate
uv pip install -r requirements.txt -r requirements-dev.txt -r requirements-viewer.txt
uv pip install -e .
uv pip, not plainpip— auv venvhas no pip of its own, so a barepip installlands in the wrong environment.
invoke lint
invoke test
python tools/run_examples.py # all 21 examples, viewer suppressed
Examples
examples/ is a chain: each reads the JSON the one before it wrote.
example_model_18_write_model_and_brep.py is the hinge — it bakes the model,
finds every contact, and writes the four files the readers open:
| Example | Does |
|---|---|
example_model_19_read_model.py |
the model back — elements, tree, contacts |
example_model_20_read_brep.py |
the STEP — 237 closed solids |
example_model_21_extract_bay.py |
one column + one cantilever as its own model |
example_model_22_read_brep_adjacency.py |
what touches what, from STEP + sidecar |
References
- compas_nest — 2D nesting of part outlines.
Metadata
Release files for compas-tf 0.1.12
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| compas_tf-0.1.12.tar.gz | 108.2 kB | With provenance | Details for compas_tf-0.1.12.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| compas_tf-0.1.12-py3-none-any.whl | Python 3 | none | any | Details for compas_tf-0.1.12-py3-none-any.whl |
Total release size: 221.0 kB
Release files / compas_tf-0.1.12.tar.gz
| Download URL | compas_tf-0.1.12.tar.gz |
|---|---|
| Size | 108.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c98f24db9ad0fa45f819579253996f2735075c271a5299d223f1a09aea0f8201
|
|
BLAKE2b-256 checksum How to use checksums |
b0cc3509f5173194c85870f3b9022075b2244b9bf0b8e2a931727637ec241f3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logRelease files / compas_tf-0.1.12-py3-none-any.whl
| Download URL | compas_tf-0.1.12-py3-none-any.whl |
|---|---|
| Size | 112.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f6e581c14fa900fb4a13bae70c00264e116fac4af811292faaefacbd21f8d7d3
|
|
BLAKE2b-256 checksum How to use checksums |
13e5c04b0a5a7cf4f841fafb42cedbae6b9fbcc01d883809d8fa4a635435d2c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logSecurity for compas-tf 0.1.12
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for compas_tf-0.1.12.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 10, 2026.
Transparency logA 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.