compas-timber 2.0.0.dev0__tar.gz → 2.1.1.dev0__tar.gz

{compas_timber-2.0.0.dev0/src/compas_timber.egg-info → compas_timber-2.1.1.dev0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: compas_timber
-Version: 2.0.0.dev0
+Version: 2.1.1.dev0
 Summary: COMPAS package for modeling, designing and fabricating timber assemblies.
-Author-email: Aleksandra Anna Apolinarska <apolinarska@arch.ethz.ch>, Chen Kasirer <kasirer@arch.ethz.ch>, Gonzalo Casas <casas@arch.ethz.ch>, Jonas Haldemann <haldemann@arch.ethz.ch>, Oliver Appling Bucklin <bucklin@arch.ethz.ch>, "Aurèle L. Gheyselinck" <gheyselinck@arch.ethz.ch>, Panayiotis Papacharalambous <papacharalambous@arch.ethz.ch>, Anastasiia Stryzhevska <astryzhevska@arch.ethz.ch>, Jelle Feringa <jelleferinga@gmail.com>, Joseph Kenny <jk6372@princeton.edu>, Beverly Lytle <lytle@arch.ethz.ch>, Eric Gozzi <eric.gozzi@arch.ethz.ch>, Rodrigo Arca Zimmermann <rodrigo.arca@gmail.com>
+Author-email: Aleksandra Anna Apolinarska <apolinarska@arch.ethz.ch>, Chen Kasirer <kasirer@arch.ethz.ch>, Gonzalo Casas <casas@arch.ethz.ch>, Jonas Haldemann <haldemann@arch.ethz.ch>, Oliver Appling Bucklin <bucklin@arch.ethz.ch>, "Aurèle L. Gheyselinck" <gheyselinck@arch.ethz.ch>, Panayiotis Papacharalambous <papacharalambous@arch.ethz.ch>, Anastasiia Stryzhevska <astryzhevska@arch.ethz.ch>, Jelle Feringa <jelleferinga@gmail.com>, Joseph Kenny <jk6372@princeton.edu>, Beverly Lytle <lytle@arch.ethz.ch>, Eric Gozzi <eric.gozzi@arch.ethz.ch>, Rodrigo Arca Zimmermann <rodrigo.arca@gmail.com>, Nicolas Benjamin Boscoboinik <boscoboinik@arch.ethz.ch>
 License-Expression: MIT
 Project-URL: Homepage, https://gramaziokohler.github.io/compas_timber/latest/
 Project-URL: Repository, https://github.com/gramaziokohler/compas_timber
@@ -19,20 +19,18 @@ License-File: LICENSE
 Requires-Dist: rtree
 Requires-Dist: compas<3.0,>=2.0
 Requires-Dist: compas_model==0.9.1
+Requires-Dist: scipy>=1.1
 Provides-Extra: dev
 Requires-Dist: bump-my-version; extra == "dev"
-Requires-Dist: compas_invocations2; extra == "dev"
+Requires-Dist: compas_invocations2[mkdocs]>=1.0.2; extra == "dev"
 Requires-Dist: invoke>=0.14; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
-Requires-Dist: sphinx_compas2_theme; extra == "dev"
-Requires-Dist: sphinxcontrib-mermaid; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: wheel; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: tomlkit; extra == "dev"
-Requires-Dist: compas_viewer; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: pytest-randomly; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/pyproject.toml

@@ -18,7 +18,8 @@ authors = [
     { name = "Joseph Kenny", email = "jk6372@princeton.edu" },
     { name = "Beverly Lytle", email = "lytle@arch.ethz.ch" },
     { name = "Eric Gozzi", email = "eric.gozzi@arch.ethz.ch" },
-    { name = "Rodrigo Arca Zimmermann", email = "rodrigo.arca@gmail.com" }
+    { name = "Rodrigo Arca Zimmermann", email = "rodrigo.arca@gmail.com" },
+    { name = "Nicolas Benjamin Boscoboinik", email = "boscoboinik@arch.ethz.ch" }
 ]
 license = "MIT"
 readme = "README.md"
@@ -38,23 +39,21 @@ dependencies = [
     "rtree",
     "compas >=2.0, <3.0",
     "compas_model == 0.9.1", # pin until first release
+    "scipy >= 1.1"
 ]
 
 [project.optional-dependencies]
 dev = [
     "bump-my-version",
-    "compas_invocations2",
+    "compas_invocations2[mkdocs]>=1.0.2",
     "invoke >=0.14",
     "ruff",
-    "sphinx_compas2_theme",
-    "sphinxcontrib-mermaid",
     "twine",
     "wheel",
     "pytest-mock",
     "pytest>=8.0",
     "build",
     "tomlkit",
-    "compas_viewer",
     "pytest-cov",
     "pytest-randomly",
     "pre-commit",
@@ -73,6 +72,9 @@ Repository = "https://github.com/gramaziokohler/compas_timber"
 # ============================================================================
 # Setup and build
 # ============================================================================
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
 package-dir = { "" = "src" }
@@ -94,7 +96,7 @@ where = ["src"]
 # ============================================================================
 
 [tool.bumpversion]
-current_version = "2.0.0-dev0"
+current_version = "2.1.1-dev0"
 message = "Bump version to {new_version}"
 commit = true
 tag = true

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/src/compas_timber/__init__.py

@@ -1,7 +1,7 @@
 import os
 import compas
 
-__version__ = "2.0.0-dev0"
+__version__ = "2.1.1-dev0"
 
 HERE = os.path.dirname(__file__)
 HOME = os.path.abspath(os.path.join(HERE, "..", ".."))

{compas_timber-2.0.0.dev0/src/compas_timber/connections → compas_timber-2.1.1.dev0/src/compas_timber}/analyzers.py

@@ -1,14 +1,15 @@
+from __future__ import annotations
+
 import math
+from weakref import WeakKeyDictionary
 
-import compas.geometry
-import compas.tolerance  # noqa: F401
-import compas_model.elements  # noqa: F401
-from compas.geometry import KDTree
+from compas.geometry import Point
 from compas.tolerance import TOL
+from compas_model.elements import Element
 
-import compas_timber.connections  # noqa: F401
-import compas_timber.elements  # noqa: F401
 from compas_timber.connections import JointTopology
+from compas_timber.geometry import KDTree
+from compas_timber.model import TimberModel
 
 
 class Cluster(object):
@@ -40,8 +41,7 @@ class Cluster(object):
         return len(self.elements)
 
     @property
-    def elements(self):
-        # type: () -> set[compas_model.elements.Element]
+    def elements(self) -> set[Element]:
         if not self._elements:
             self._elements = set()
             for joint in self.joints:
@@ -49,8 +49,7 @@ class Cluster(object):
         return self._elements
 
     @property
-    def location(self):
-        # type: () -> compas.geometry.Point
+    def location(self) -> Point:
         return self.joints[0].location
 
     @property
@@ -81,6 +80,57 @@ class BeamGroupAnalyzer(object):
         raise NotImplementedError
 
 
+class _CacheEntry(object):
+    def __init__(self, fingerprint: frozenset, joints: list, tree: KDTree) -> None:
+        self.fingerprint = fingerprint
+        self.joints = joints
+        self.tree = tree
+
+
+class _KDTreeCache(object):
+    """Caches a :class:`KDTree` per model instance, rebuilding it when the joint set changes.
+
+    The cache is keyed by model identity (via a :class:`~weakref.WeakKeyDictionary`) so the
+    tree is automatically released when the model is garbage-collected.  A fingerprint of
+    the current joint-candidate identities detects structural changes: if joints have been
+    added or removed since the tree was built, the tree is transparently rebuilt.
+
+    Crucially, the cache also stores the *canonical ordering* of joints used when the tree
+    was first built.  Every caller receives that same list so that KDTree indices are always
+    consistent with ``self._joints``, regardless of the iteration order of the underlying set.
+    """
+
+    _store = WeakKeyDictionary()  # type: WeakKeyDictionary  # model -> _CacheEntry
+
+    @classmethod
+    def get(cls, model: TimberModel, joints: list) -> tuple[list, KDTree]:
+        """Return the canonical joints list and :class:`KDTree` for *model*.
+
+        If the joint set has changed since the last call (joints added or removed),
+        a new tree is built and the canonical list is updated.
+
+        Parameters
+        ----------
+        model : :class:`~compas_timber.model.TimberModel`
+            The model whose joint candidates the tree covers.
+        joints : list
+            The current joint candidates used only to compute the fingerprint and,
+            on a cache miss, to build the new tree.
+
+        Returns
+        -------
+        tuple[list, :class:`KDTree`]
+            ``(canonical_joints, tree)`` – the ordering and tree that all callers
+            for this model generation must share.
+        """
+        fingerprint = frozenset(id(j) for j in joints)
+        cached = cls._store.get(model)
+        if cached is None or cached.fingerprint != fingerprint:
+            cls._store[model] = _CacheEntry(fingerprint, joints, KDTree([j.location for j in joints]))
+        entry = cls._store[model]
+        return entry.joints, entry.tree
+
+
 class NBeamKDTreeAnalyzer(BeamGroupAnalyzer):
     """Finds clusters of N beams connected pairwise at the same point within a given max_distance.
 
@@ -96,14 +146,13 @@ class NBeamKDTreeAnalyzer(BeamGroupAnalyzer):
 
     def __init__(self, model, n=2, max_distance=None):
         super(NBeamKDTreeAnalyzer, self).__init__()
-        self._joints = list(model.joint_candidates)
-        if not self._joints:
+        joints = list(model.joint_candidates)
+        if not joints:
             raise ValueError("The model has no joint candidates to analyze. Forgot to call `model.connect_adjacent_beams()`?")
 
-        self._kdtree = KDTree([joint.location for joint in self._joints])
+        self._joints, self._kdtree = _KDTreeCache.get(model, joints)
         self._n = n
         self.max_distance = max_distance or TOL.absolute
-
         # TODO: add parameter to specify groupwise clustering, i.e only look at joints of elements within the same group
 
     def find(self, exclude=None):
@@ -231,14 +280,14 @@ def MaxNCompositeAnalyzer(model, n, max_distance=None):
         The TimberModel to analyze.
     n : int
         The maximum cluster size.
-    tolerance : :class:`~compas.tolerance.Tolerance` | None
-        The tolerance to use for the analysis. If None, a default tolerance is used.
+    max_distance : float | None
+        The max distance to use for the analysis. If None, a default max distance is used.
 
     Returns
     -------
     CompositeAnalyzer
         An instance of CompositeAnalyzer that finds clusters of size n down to 2.
     """
-    analyzers_cls = [lambda m, t, k=k: NBeamKDTreeAnalyzer(m, n=k, max_distance=t) for k in range(n, 1, -1)]
-    # Use lambdas to capture k at each step
-    return CompositeAnalyzer([cls(model, max_distance) for cls in analyzers_cls])
+    # All analyzers share the same KDTree automatically via the class-level cache keyed on model
+    max_cluster_size = max(n, 2)
+    return CompositeAnalyzer([NBeamKDTreeAnalyzer(model, n=k, max_distance=max_distance) for k in range(max_cluster_size, 1, -1)])

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/src/compas_timber/base.py

@@ -201,7 +201,7 @@ class TimberElement(Element, abc.ABC):
 
         Parameters
         ----------
-        feature : :class:`~compas_timber.fabrication.BTLxProcessing` | list(:class:`~compas_timber.fabrication.BTLxProcessing`) | None
+        features : :class:`~compas_timber.fabrication.BTLxProcessing` | list(:class:`~compas_timber.fabrication.BTLxProcessing`) | None
             The feature or features to be removed described as a BTLxProcessing or a list of BTLxProcessings.
             If None, all features will be removed.
 
@@ -351,7 +351,7 @@ class TimberElement(Element, abc.ABC):
 
     def get_dimensions_relative_to_side(self, ref_side_index):
         # type: (int) -> tuple[float, float]
-        """Returns the perpendicular and parallel dimensions of the beam to the given reference side.
+        """Returns the dimensions of a timber element with respect to the Y- axis and Normal of the given reference side.
 
         Parameters
         ----------
@@ -361,9 +361,9 @@ class TimberElement(Element, abc.ABC):
         Returns
         -------
         tuple(float, float)
-            The perpendicular and parallel dimensions of the beam to the reference side.
-                - Perpendicular dimension: The measurement normal to the reference side.
-                - Parallel dimension: The measurement along y-axis of reference side.
+            Y-axis dimension, Normal direction dimension.
+                - Y-axis dimension: The element dimension along y-axis of reference side.
+                - Normal dimension: The element dimension normal to the reference side.
         """
         if ref_side_index in [1, 3]:
             return self.height, self.width

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/src/compas_timber/connections/__init__.py

@@ -18,10 +18,12 @@ from .t_lap import TLapJoint
 from .x_lap import XLapJoint
 from .x_notch import XNotchJoint
 from .t_dovetail import TDovetailJoint
-from .t_tenon_mortise import TenonMortiseJoint
+from .mortise_tenon import MortiseTenonJoint
+from .t_tenon_mortise import TTenonMortiseJoint
+from .l_tenon_mortise import LTenonMortiseJoint
 from .ball_node import BallNodeJoint
 from .y_butt import YButtJoint
-from .oligina import OliGinaJoint
+from .oligina import TOliGinaJoint
 from .utilities import beam_ref_side_incidence
 from .utilities import beam_ref_side_incidence_with_vector
 from .utilities import point_centerline_towards_joint
@@ -34,13 +36,6 @@ from .plate_miter_joint import PlateMiterJoint
 from .panel_butt_joint import PanelLButtJoint
 from .panel_butt_joint import PanelTButtJoint
 from .panel_miter_joint import PanelMiterJoint
-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",
@@ -64,10 +59,12 @@ __all__ = [
     "PlateConnectionSolver",
     "find_neighboring_elements",
     "TDovetailJoint",
+    "MortiseTenonJoint",
     "BallNodeJoint",
-    "TenonMortiseJoint",
+    "TTenonMortiseJoint",
+    "LTenonMortiseJoint",
     "YButtJoint",
-    "OliGinaJoint",
+    "TOliGinaJoint",
     "beam_ref_side_incidence",
     "beam_ref_side_incidence_with_vector",
     "point_centerline_towards_joint",
@@ -80,11 +77,4 @@ __all__ = [
     "PanelLButtJoint",
     "PanelTButtJoint",
     "PanelMiterJoint",
-    "NBeamKDTreeAnalyzer",
-    "TripletAnalyzer",
-    "QuadAnalyzer",
-    "CompositeAnalyzer",
-    "Cluster",
-    "BeamGroupAnalyzer",
-    "MaxNCompositeAnalyzer",
 ]

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/src/compas_timber/connections/joint.py

@@ -3,12 +3,43 @@ from itertools import combinations
 from compas.data import Data
 from compas.geometry import Point
 from compas.geometry import distance_point_line
+from compas.tolerance import TOL
 
 from compas_timber.errors import BeamJoiningError
+from compas_timber.utils import distance_segment_segment_points
 
 from .solver import JointTopology
 
 
+def location_from_centerlines(beams):
+    """Compute the approximate joint location from two beam centerlines.
+
+    Returns the closest point between the two centerlines, or the midpoint
+    between them when the beams are skew (non-intersecting).
+
+    Parameters
+    ----------
+    beams : list(:class:`~compas_timber.elements.Beam`)
+        A list of two beams for which to calculate the joint location.
+
+    Returns
+    -------
+    :class:`~compas.geometry.Point`
+
+    """
+    if len(beams) != 2:
+        raise ValueError(
+            "Automatic location calculation only works for joints connecting 2 elements. "
+            "Please set the location manually or implement a custom location calculation for your joint type."
+        )
+    beam_a, beam_b = beams
+    distance, point_a, point_b = distance_segment_segment_points(beam_a.centerline, beam_b.centerline)
+    point_a, point_b = Point(*point_a), Point(*point_b)
+    if not TOL.is_zero(distance):
+        return (point_a + point_b) / 2.0
+    return point_a
+
+
 class Joint(Data):
     """Base class for a joint connecting two beams.
 
@@ -48,13 +79,16 @@ class Joint(Data):
 
     def __init__(self, topology=None, location=None, name=None, **kwargs):
         super().__init__(name=name)
-        self._topology = topology if topology is not None else JointTopology.TOPO_UNKNOWN
-        self._location = location or Point(0, 0, 0)
+        self._topology = None
+        self._location = None
+        self.topology = topology
+        if location:
+            self.location = location
 
     @property
     def __data__(self):
         # type: () -> dict
-        return {"name": self.name}
+        return {"name": self.name, "topology": self.topology, "location": self._location}
 
     def __repr__(self):
         return '{}(name="{}")'.format(self.__class__.__name__, self.name)
@@ -65,11 +99,16 @@ class Joint(Data):
 
     @topology.setter
     def topology(self, value):
-        """Set the topology of the joint."""
-        self._topology = value
+        self._topology = value or JointTopology.TOPO_UNKNOWN
 
     @property
     def location(self):
+        if self._location is None and all(self.elements):
+            self._location = location_from_centerlines(self.elements)
+
+        if self._location is None:
+            raise ValueError("Location of the joint could not be determined. Please set it manually.")
+
         return self._location
 
     @location.setter

{compas_timber-2.0.0.dev0 → compas_timber-2.1.1.dev0}/src/compas_timber/connections/joint_candidate.py

@@ -5,7 +5,7 @@ from .plate_joint import PlateJoint
 class JointCandidate(Joint):
     """A JointCandidate is an information-only joint, which does not add any features to the elements it connects.
 
-    It is used to create a first-pass joinery information which can be later used to perform analysis using :class:`~compas_timber.connections.analyzers.BeamGroupAnalyzer`.
+    It is used to create a first-pass joinery information which can be later used to perform analysis using :class:`~compas_timber.analyzers.BeamGroupAnalyzer`.
 
     Please use `JointCandidate.create()` to properly create an instance of this class and associate it with an model.
 
@@ -70,7 +70,7 @@ class JointCandidate(Joint):
 class PlateJointCandidate(PlateJoint, JointCandidate):
     """A PlateJointCandidate is an information-only joint for plate connections.
 
-    It is used to create a first-pass joinery information which can be later used to perform analysis using :class:`~compas_timber.connections.analyzers.BeamGroupAnalyzer`.
+    It is used to create a first-pass joinery information which can be later used to perform analysis using :class:`~compas_timber.analyzers.BeamGroupAnalyzer`.
 
     Parameters
     ----------