Merge branch 'main' of https://github.com/gramaziokohler/compas_timber into compas_model_update

Author: papachap

.github/workflows/coverage.yml

@@ -0,0 +1,31 @@
+name: coverage
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  coverage:
+    if: "!contains(github.event.pull_request.labels.*.name, 'docs-only')"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.12"]
+
+    steps:
+      - uses: compas-dev/compas-actions.build@v4
+        with:
+          invoke_lint: false
+          invoke_test: false
+          python: ${{ matrix.python }}
+      - name: Run tests collecting coverage reports
+        run: pytest --cov src/compas_timber --cov-report=html
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4.0.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

CHANGELOG.md

@@ -36,6 +36,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Added `geometry` property in `compas_timber.elements.TimberElement` following its removal from the base `Element`.
 * Added `frame` property in serialized output in `compas_timber.elements.TimberElement` following its removal from the base `Element`.
 * Added `interactions()` method to `TimberModel` for iterating over edge-level joints and contacts in the model graph.
+* Added `topology` to class `Joint`.
+* Added `location` to class `Joint`.
+* Added `NBeamKDTreeAnalyzer` to `compas_timber.connections`.
+* Added `TripletAnalyzer` to `compas_timber.connections`.
+* Added `QuadAnalyzer` to `compas_timber.connections`.
+* Added `CompositeAnalyzer` to `compas_timber.connections`.
+* Added method `connect_adjacent_beams` to `TimberModel`.
+* Added `PlateJoint`.
+* Added `PlateButtJoint`.
+* Added `PlateMiterJoint`.
+* Added `PlateConnectionSolver`.
+* Added generic `ButtJoint` class from which `TButtJoint` and `LButtJoint` inherit.
 
 ### Changed
 
@@ -46,6 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Processings which are not the result of joinery are now serialized with `TimberElement`.
 * Fixed visualization bug in `Plate` due to loft resulting in flipped volume.
 * Fixed a few bugs in the `WallPopulator` workflow including GH component updates.
+* Renamed `NullJoint` to `GenericJoint`.
 * Fixed bug in show_ref_faces GH component.
 * Changed `compas_timber.connections.Joint` to inherit from `Data` instead of the depricated `Interaction`.
 * Renamed `compute_geometry` to `compute_elementgeometry` in `compas_timber.elements.Beam` following the renaming in `compas_model`.
@@ -59,11 +72,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Replaced all `GroupNode` references with the new `Group` element class from `compas_model`.
 * Updated default edge attributes in the model graph to include `joints` and `contacts`.
 * Updated `compas_model` version pinning from `0.4.4` to `0.8.0` to align with the latest development.
+* `BTLxProcessing.ref_side_index` defaults to `0` if not set, instead of the invalid `None`.
+* Fixed several GH Components for Rhino8 compatibility.
+* Fixed `graph_node` is `None` after deserializing a `TimberModel`.
 
 ### Removed
 
 * Removed Grasshopper after-install plugin. Components should be installed via Rhino's Plugin Manager.
 * Removed the `add_element()` method from `compas_timber.model.TimberModel`, as the inherited method from `Model` now covers this functionality.
+* Removed `get_face_most_towards_beam` from `Joint` as not used anywhere.
+* Removed `get_face_most_ortho_to_beam` from `Joint` as not used anywhere.
 
 
 ## [0.16.2] 2025-05-07
@@ -77,6 +95,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 
+
 ## [0.16.1] 2025-04-30
 
 ### Added

README.md

@@ -1,6 +1,7 @@
 # compas_timber
 
 [![Github Actions Build Status](https://github.com/gramaziokohler/compas_timber/workflows/build/badge.svg)](https://github.com/gramaziokohler/compas_timber/actions)
+[![codecov](https://codecov.io/gh/gramaziokohler/compas_timber/graph/badge.svg?token=EFI7G1T18Z)](https://codecov.io/gh/gramaziokohler/compas_timber)
 [![License](https://img.shields.io/github/license/gramaziokohler/compas_timber.svg)](https://pypi.python.org/pypi/compas_timber)
 [![pip downloads](https://img.shields.io/pypi/dm/compas_timber)](https://pypi.python.org/project/compas_timber)
 [![PyPI Package latest release](https://img.shields.io/pypi/v/compas_timber.svg)](https://pypi.python.org/pypi/compas_timber)

docs/api/compas_timber.connections.rst

@@ -4,23 +4,21 @@ compas_timber.connections
 
 .. currentmodule:: compas_timber.connections
 
-Classes
-=======
+Joints
+======
 
 .. autosummary::
     :toctree: generated/
     :nosignatures:
 
     BallNodeJoint
-    ConnectionSolver
     Joint
-    JointTopology
     LapJoint
     LButtJoint
     LFrenchRidgeLapJoint
     LLapJoint
     LMiterJoint
-    NullJoint
+    GenericJoint
     TBirdsmouthJoint
     TButtJoint
     TDovetailJoint
@@ -31,6 +29,22 @@ Classes
     XNotchJoint
     YButtJoint
 
+Solvers
+=======
+
+.. autosummary::
+    :toctree: generated/
+    :nosignatures:
+
+    ConnectionSolver
+    JointTopology
+    Cluster
+    BeamGroupAnalyzer
+    NBeamKDTreeAnalyzer
+    TripletAnalyzer
+    QuadAnalyzer
+    CompositeAnalyzer
+
 Functions
 =========
 

examples/model/0006_stand_topo.py

@@ -0,0 +1,73 @@
+import os
+
+from compas.data import json_load
+from compas.geometry import Vector
+from compas_viewer.scene import Tag
+from compas_viewer.viewer import Viewer
+
+from compas_timber.connections import JointTopology
+from compas_timber.elements import Beam
+from compas_timber.model import TimberModel
+
+HERE = os.path.dirname(__file__)
+LINES = os.path.join(HERE, "stand.json")
+
+
+def create_viewer():
+    # draw inflated centerlines
+    viewer = Viewer()
+    viewer.renderer.camera.far = 1000000.0
+    viewer.renderer.camera.position = [10000.0, 10000.0, 10000.0]
+    viewer.renderer.camera.pandelta = 0.05
+    viewer.renderer.rendermode = "ghosted"
+    return viewer
+
+
+def main():
+    # Load centerlines from file
+    lines = json_load(LINES)
+
+    model = TimberModel()
+
+    # Add beams to model
+    CROSS_SQUARE = (120, 120)
+    CROSS_TALL = (120, 60)
+    NORMAL_VERTICALS = Vector(0, 1, 0)
+
+    # Create the beams with the right cross section depending on their category
+    # Assign normal to the beams whose centerlines are aligned with the zaxis
+    for category, lines in lines.items():
+        for line in lines:
+            if category in ["main", "support", "window"]:
+                height, width = CROSS_SQUARE
+            else:
+                height, width = CROSS_TALL
+            normal = NORMAL_VERTICALS if category == "verticals" else None
+            beam = Beam.from_centerline(centerline=line, height=height, width=width, z_vector=normal)
+            beam.attributes["category"] = category
+            model.add_element(beam)
+
+    model.connect_adjacent_beams()
+
+    model.process_joinery()
+
+    # setup the viewer
+    viewer = create_viewer()
+
+    for joint in model.joints:
+        viewer.scene.add(joint.location)
+        viewer.scene.add(Tag(JointTopology.get_name(joint.topology).split("_")[-1], joint.location))
+
+    # draw centerline
+    for beam in model.beams:
+        viewer.scene.add(beam.centerline)
+
+    # draw geometry (with features)
+    for beam in model.beams:
+        viewer.scene.add(beam.geometry)
+
+    viewer.show()
+
+
+if __name__ == "__main__":
+    main()

examples/model/0007_analyzers.py

@@ -0,0 +1,98 @@
+import random
+
+from compas.colors import Color
+from compas.colors import ColorMap
+from compas.geometry import Line
+from compas.geometry import Point
+from compas.tolerance import Tolerance
+from compas_viewer.scene import Tag
+from compas_viewer.viewer import Viewer
+
+from compas_timber.connections import JointTopology
+from compas_timber.connections import MaxNCompositeAnalyzer
+from compas_timber.elements import Beam
+from compas_timber.model import TimberModel
+
+
+def create_viewer():
+    # draw inflated centerlines
+    viewer = Viewer()
+    viewer.renderer.camera.far = 1000000.0
+    viewer.renderer.camera.position = [10000.0, 10000.0, 10000.0]
+    viewer.renderer.camera.pandelta = 0.05
+    viewer.renderer.rendermode = "ghosted"
+    return viewer
+
+
+def create_color_map(keys):
+    # map cluster sizes to random colors which are hopefully visually distinct
+    cmap = ColorMap.from_palette("imola")
+    n = len(keys)
+    values = [i / max(n - 1, 1) for i in range(n)]
+    random.shuffle(values)
+    return {key: cmap(val) for key, val in zip(keys, values)}
+
+
+def main():
+    lines = [
+        Line(Point(x=-10.0, y=-10.0, z=0.0), Point(x=300.0, y=200.0, z=0.0)),
+        Line(Point(x=-10.0, y=-10.0, z=0.0), Point(x=-40.0, y=270.0, z=0.0)),
+        Line(Point(x=-10.0, y=-10.0, z=0.0), Point(x=0.0, y=20.0, z=160.0)),
+        Line(Point(x=45.89488087618746, y=234.15459672257862, z=0.0), Point(x=168.58797240614388, y=-95.31137353132192, z=0.0)),
+        Line(Point(x=45.89488087618746, y=234.15459672257862, z=0.0), Point(x=330.0, y=350.0, z=0.0)),
+        Line(Point(x=300.0, y=200.0, z=0.0), Point(x=500.0, y=0.0, z=0.0)),
+        Line(Point(x=300.0, y=200.0, z=0.0), Point(x=220.0, y=170.0, z=-120.0)),
+        Line(Point(x=-10.0, y=-10.0, z=0.0), Point(x=90.0, y=-220.0, z=0.0)),
+        Line(Point(x=45.89488087618746, y=234.15459672257862, z=0.0), Point(x=0.0, y=220.0, z=130.0)),
+        Line(Point(x=45.89488087618746, y=234.15459672257862, z=0.0), Point(x=0.0, y=260.0, z=-120.0)),
+    ]
+
+    model = TimberModel()
+
+    height, width = (12, 6)
+
+    for line in lines:
+        beam = Beam.from_centerline(centerline=line, height=height, width=width)
+        model.add_element(beam)
+
+    # pairs of adjacent beams are connected by GenericJoint instances
+    model.connect_adjacent_beams()
+
+    # setup the viewer
+    viewer = create_viewer()
+
+    for joint in model.joints:
+        topo_name = JointTopology.get_name(joint.topology).split("_")[-1]
+        viewer.scene.add(Tag(text=topo_name, position=joint.location, height=40, color=Color.blue()))
+
+    # draw centerline
+    for beam in model.beams:
+        viewer.scene.add(beam.centerline)
+        viewer.scene.add(beam.geometry)
+        viewer.scene.add(Tag(text=str(beam.graph_node), position=beam.centerline.midpoint, height=40, color=Color.black()))
+
+    tol = Tolerance(absolute=0.01)
+    num_of_beams = len(list(model.beams))
+
+    ### find triplets only
+    # analyzer = TripletAnalyzer(model, tolerance=Tolerance(absolute=0.01))
+
+    ### find quads only
+    # analyzer = QuadAnalyzer(model, tolerance=Tolerance(absolute=0.01))
+
+    ### find all clusters up to n beams, then n-1 beams, then n-2 beams, etc.
+    analyzer = MaxNCompositeAnalyzer(model, n=num_of_beams, tolerance=tol)
+
+    clusters = analyzer.find()
+
+    size_to_color = create_color_map(list(sorted({len(cluster) for cluster in clusters})))
+    for cluster in clusters:
+        size = len(cluster)
+        color = size_to_color[size]
+        viewer.scene.add(cluster.location, pointsize=50, color=color)
+
+    viewer.show()
+
+
+if __name__ == "__main__":
+    main()

requirements-dev.txt

@@ -13,3 +13,4 @@ build
 pythonnet
 tomlkit
 compas_viewer
+pytest-cov

src/compas_timber/connections/__init__.py

@@ -1,11 +1,13 @@
 from .joint import Joint
+from .butt_joint import ButtJoint
 from .l_butt import LButtJoint
 from .l_lap import LLapJoint
 from .l_miter import LMiterJoint
 from .l_french_ridge_lap import LFrenchRidgeLapJoint
 from .lap_joint import LapJoint
-from .null_joint import NullJoint
+from .generic_joint import GenericJoint
 from .solver import ConnectionSolver
+from .solver import PlateConnectionSolver
 from .solver import JointTopology
 from .solver import find_neighboring_elements
 from .t_butt import TButtJoint
@@ -25,10 +27,24 @@
 from .wall_joint import WallJoint
 from .wall_joint import InterfaceLocation
 from .wall_joint import InterfaceRole
+from .plate_joint import PlateJoint
+from .plate_butt_joint import PlateButtJoint
+from .plate_butt_joint import PlateLButtJoint
+from .plate_butt_joint import PlateTButtJoint
+from .plate_miter_joint import PlateMiterJoint
+from .plate_joint import PlateToPlateInterface
+from .analyzers import NBeamKDTreeAnalyzer
+from .analyzers import TripletAnalyzer
+from .analyzers import QuadAnalyzer
+from .analyzers import CompositeAnalyzer
+from .analyzers import Cluster
+from .analyzers import BeamGroupAnalyzer
+from .analyzers import MaxNCompositeAnalyzer
 
 __all__ = [
     "Joint",
     "LapJoint",
+    "ButtJoint",
     "TButtJoint",
     "LButtJoint",
     "TButtJoint",
@@ -39,10 +55,11 @@
     "XNotchJoint",
     "TLapJoint",
     "LLapJoint",
-    "NullJoint",
+    "GenericJoint",
     "LFrenchRidgeLapJoint",
     "JointTopology",
     "ConnectionSolver",
+    "PlateConnectionSolver",
     "find_neighboring_elements",
     "TDovetailJoint",
     "BallNodeJoint",
@@ -55,4 +72,17 @@
     "WallJoint",
     "InterfaceLocation",
     "InterfaceRole",
+    "PlateJoint",
+    "PlateButtJoint",
+    "PlateLButtJoint",
+    "PlateTButtJoint",
+    "PlateMiterJoint",
+    "PlateToPlateInterface",
+    "NBeamKDTreeAnalyzer",
+    "TripletAnalyzer",
+    "QuadAnalyzer",
+    "CompositeAnalyzer",
+    "Cluster",
+    "BeamGroupAnalyzer",
+    "MaxNCompositeAnalyzer",
 ]