ifctrano 0.2.0__tar.gz → 0.3.0__tar.gz

{ifctrano-0.2.0 → ifctrano-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ifctrano
-Version: 0.2.0
+Version: 0.3.0
 Summary: Package for generating building energy simulation model from IFC
 License: GPL V3
 Keywords: BIM,IFC,energy simulation,modelica,building energy simulation,buildings,ideas
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: ifcopenshell (>=0.8.1.post1,<0.9.0)
 Requires-Dist: open3d (>=0.19.0,<0.20.0)
 Requires-Dist: shapely (>=2.0.7,<3.0.0)
-Requires-Dist: trano (>=0.2.0,<0.3.0)
+Requires-Dist: trano (>=0.5.0,<0.6.0)
 Requires-Dist: typer (>=0.12.5,<0.13.0)
 Requires-Dist: vedo (>=2025.5.3,<2026.0.0)
 Project-URL: Repository, https://github.com/andoludo/ifctrano

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/base.py

@@ -1,5 +1,7 @@
 import json
 import math
+from itertools import combinations
+from multiprocessing import Process
 from pathlib import Path
 from typing import Tuple, Literal, List, Annotated, Any, Dict, cast
 
@@ -18,7 +20,6 @@ from shapely.geometry.polygon import Polygon  # type: ignore
 from vedo import Line, Arrow, Mesh, show, write  # type: ignore
 
 from ifctrano.exceptions import VectorWithNansError
-from multiprocessing import Process
 
 settings = ifcopenshell.geom.settings()  # type: ignore
 Coordinate = Literal["x", "y", "z"]
@@ -147,12 +148,15 @@ class Vector(BasePoint):
         a = self.dot(other) / other.dot(other)
         return Vector(x=a * other.x, y=a * other.y, z=a * other.z)
 
-    def norm(self) -> "Vector":
+    def normalize(self) -> "Vector":
         normalized_vector = self.to_array() / np.linalg.norm(self.to_array())
         return Vector(
             x=normalized_vector[0], y=normalized_vector[1], z=normalized_vector[2]
         )
 
+    def norm(self) -> float:
+        return float(np.linalg.norm(self.to_array()))
+
     def to_array(self) -> np.ndarray:  # type: ignore
         return np.array([self.x, self.y, self.z])
 
@@ -163,7 +167,7 @@ class Vector(BasePoint):
         normal_index_list = [abs(v) for v in self.to_list()]
         return normal_index_list.index(max(normal_index_list))
 
-    def is_a_zero(self, tolerance: float = 0.1) -> bool:
+    def is_null(self, tolerance: float = 0.1) -> bool:
         return all(abs(value) < tolerance for value in self.to_list())
 
     @classmethod
@@ -247,18 +251,23 @@ class Vertices(BaseModel):
         return FaceVertices(points=self.points)
 
     def get_local_coordinate_system(self) -> CoordinateSystem:
-        origin = self.points[0]
-        x = self.points[1] - origin
+        vectors = [
+            (a - b).normalize().to_array() for a, b in combinations(self.points, 2)
+        ]
         found = False
-        for point in self.points[2:]:
-            y = point - origin
-            if abs(x.dot(y)) < 0.00001:
+        for v1, v2, v3 in combinations(vectors, 3):
+            if (
+                np.isclose(abs(np.dot(v1, v2)), 0)
+                and np.isclose(abs(np.dot(v1, v3)), 0)
+                and np.isclose(abs(np.dot(v2, v3)), 0)
+            ):
                 found = True
+                x = Vector.from_array(v1)
+                y = Vector.from_array(v2)
+                z = Vector.from_array(v3)
                 break
         if not found:
-            raise ValueError("No orthogonal vectors found.")
-
-        z = x * y
+            raise ValueError("Cannot find coordinate system")
         return CoordinateSystem(x=x, y=y, z=z)
 
     def get_bounding_box(self) -> "Vertices":

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/bounding_box.py

@@ -14,7 +14,7 @@ from pydantic import (
     Field,
     ConfigDict,
 )
-from shapely import Polygon  # type: ignore
+from scipy.spatial import ConvexHull  # type: ignore
 from vedo import Line  # type: ignore
 
 from ifctrano.base import (
@@ -98,31 +98,28 @@ class OrientedBoundingBox(BaseShow):
                 lines.append(Line(a, b))
         return lines
 
-    def contained(self, poly_1: Polygon, poly_2: Polygon) -> bool:
-        include_1_in_2 = poly_1.contains(poly_2)
-        include_2_in_1 = poly_2.contains(poly_1)
-        return bool(include_2_in_1 or include_1_in_2)
-
     def intersect_faces(self, other: "OrientedBoundingBox") -> Optional[CommonSurface]:
         extend_surfaces = []
         for face in self.faces.faces:
 
             for other_face in other.faces.faces:
                 vector = face.normal * other_face.normal
-                if vector.is_a_zero():
+                if vector.is_null():
                     projected_face_1 = face.vertices.project(face.vertices)
                     projected_face_2 = face.vertices.project(other_face.vertices)
                     polygon_1 = projected_face_1.to_polygon()
                     polygon_2 = projected_face_2.to_polygon()
                     intersection = polygon_2.intersection(polygon_1)
-                    if intersection.area > self.area_tolerance or self.contained(
-                        polygon_1, polygon_2
-                    ):
+                    if intersection.area > self.area_tolerance:
                         distance = projected_face_1.get_distance(projected_face_2)
                         area = intersection.area
                         try:
-                            direction_vector = (other.centroid - self.centroid).norm()
-                            orientation = direction_vector.project(face.normal).norm()
+                            direction_vector = (
+                                other.centroid - self.centroid
+                            ).normalize()
+                            orientation = direction_vector.project(
+                                face.normal
+                            ).normalize()
                         except VectorWithNansError as e:
                             logger.warning(
                                 "Orientation vector was not properly computed when computing the intersection between "
@@ -170,7 +167,9 @@ class OrientedBoundingBox(BaseShow):
         entity: Optional[entity_instance] = None,
     ) -> "OrientedBoundingBox":
         points_ = open3d.utility.Vector3dVector(vertices)
-        mobb = open3d.geometry.OrientedBoundingBox.create_from_points_minimal(points_)
+        mobb = open3d.geometry.OrientedBoundingBox.create_from_points_minimal(
+            points_, robust=True
+        )
         height = (mobb.get_max_bound() - mobb.get_min_bound())[
             2
         ]  # assuming that height is the z axis
@@ -191,6 +190,8 @@ class OrientedBoundingBox(BaseShow):
             entity_shape, entity_shape.geometry  # type: ignore
         )
         vertices_ = Vertices.from_arrays(np.asarray(vertices))
-
-        vertices_ = vertices_.get_bounding_box()
-        return cls.from_vertices(vertices_.to_array(), entity)
+        hull = ConvexHull(vertices_.to_array())
+        vertices_ = Vertices.from_arrays(vertices_.to_array()[hull.vertices])
+        points_ = open3d.utility.Vector3dVector(vertices_.to_array())
+        aab = open3d.geometry.AxisAlignedBoundingBox.create_from_points(points_)
+        return cls.from_vertices(aab.get_box_points(), entity)

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/building.py

@@ -102,11 +102,11 @@ def get_internal_elements(space1_boundaries: List[SpaceBoundaries]) -> InternalE
                         and (
                             boundary.common_surface.orientation
                             * common_surface.orientation
-                        ).is_a_zero()
+                        ).is_null()
                         and (
                             boundary_.common_surface.orientation
                             * common_surface.orientation
-                        ).is_a_zero()
+                        ).is_null()
                     ) and boundary.common_surface.orientation.dot(
                         boundary_.common_surface.orientation
                     ) < 0:
@@ -200,7 +200,7 @@ class Building(BaseShow):
         return get_internal_elements(self.space_boundaries)
 
     @validate_call
-    def create_model(
+    def create_network(
         self,
         library: Libraries = "Buildings",
         north_axis: Optional[Vector] = None,
@@ -232,6 +232,9 @@ class Building(BaseShow):
             )
         return network
 
+    def get_model(self) -> str:
+        return str(self.create_network().model())
+
     def save_model(self, library: Libraries = "Buildings") -> None:
-        model_ = self.create_model(library)
+        model_ = self.create_network(library)
         Path(self.parent_folder.joinpath(f"{self.name}.mo")).write_text(model_.model())

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/exceptions.py

@@ -24,3 +24,7 @@ class InvalidLibraryError(Exception):
 
 class VectorWithNansError(Exception):
     pass
+
+
+class HasWindowsWithoutWallsError(Exception):
+    pass

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/main.py

@@ -58,7 +58,7 @@ def create(
         if show_space_boundaries:
             print(f"{CHECKMARK} Showing space boundaries.")
             building.show()
-        modelica_network = building.create_model(library=library)  # type: ignore
+        modelica_network = building.create_network(library=library)  # type: ignore
         progress.update(task, completed=True)
         task = progress.add_task(description="Writing model to file...", total=None)
         modelica_model_path.write_text(modelica_network.model())
@@ -68,7 +68,7 @@ def create(
             print("Simulating...")
             results = simulate(
                 modelica_model_path.parent,
-                building.create_model(
+                building.create_network(
                     library=library  # type: ignore
                 ),  # TODO: cannot use the network after cretingt he model
             )
@@ -79,7 +79,7 @@ def create(
             result_path = (
                 Path(modelica_model_path.parent)
                 / "results"
-                / f"{modelica_model_path.stem}.building_res.mat"
+                / f"{modelica_model_path.stem.lower()}.building_res.mat"
             )
             if not result_path.exists():
                 print(
@@ -87,7 +87,7 @@ def create(
                 )
                 return
             reporting = ModelDocumentation.from_network(
-                building.create_model(library=library),  # type: ignore
+                building.create_network(library=library),  # type: ignore
                 result=ResultFile(path=result_path),
             )
             html = to_html_reporting(reporting)

{ifctrano-0.2.0 → ifctrano-0.3.0}/ifctrano/space_boundary.py

@@ -5,7 +5,7 @@ import ifcopenshell
 import ifcopenshell.geom
 import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
-from pydantic import Field, BeforeValidator
+from pydantic import Field, BeforeValidator, BaseModel
 from trano.data_models.conversion import SpaceParameter  # type: ignore
 from trano.elements import Space as TranoSpace, ExternalWall, Window, BaseWall, ExternalDoor  # type: ignore
 from trano.elements.system import Occupancy  # type: ignore
@@ -23,6 +23,7 @@ from ifctrano.base import (
 )
 from ifctrano.bounding_box import OrientedBoundingBox
 from ifctrano.construction import glass, Constructions
+from ifctrano.exceptions import HasWindowsWithoutWallsError
 from ifctrano.utils import remove_non_alphanumeric, _round, get_building_elements
 
 ROOF_VECTOR = Vector(x=0, y=0, z=1)
@@ -83,6 +84,87 @@ class Space(GlobalId):
         return f"space_{main_name}{remove_non_alphanumeric(self.entity.GlobalId)}"
 
 
+class ExternalSpaceBoundaryGroup(BaseModelConfig):
+    constructions: List[BaseWall]
+    azimuth: float
+    tilt: Tilt
+
+    def __hash__(self) -> int:
+        return hash((self.azimuth, self.tilt.value))
+
+    def has_window(self) -> bool:
+        return any(
+            isinstance(construction, Window) for construction in self.constructions
+        )
+
+    def has_external_wall(self) -> bool:
+        return any(
+            isinstance(construction, ExternalWall)
+            for construction in self.constructions
+        )
+
+
+class ExternalSpaceBoundaryGroups(BaseModelConfig):
+    space_boundary_groups: List[ExternalSpaceBoundaryGroup] = Field(
+        default_factory=list
+    )
+
+    @classmethod
+    def from_external_boundaries(
+        cls, external_boundaries: List[BaseWall]
+    ) -> "ExternalSpaceBoundaryGroups":
+        boundary_walls = [
+            ex
+            for ex in external_boundaries
+            if isinstance(ex, (ExternalWall, Window)) and ex.tilt == Tilt.wall
+        ]
+        space_boundary_groups = list(
+            {
+                ExternalSpaceBoundaryGroup(
+                    constructions=[
+                        ex_
+                        for ex_ in boundary_walls
+                        if ex_.azimuth == ex.azimuth and ex_.tilt == ex.tilt
+                    ],
+                    azimuth=ex.azimuth,
+                    tilt=ex.tilt,
+                )
+                for ex in boundary_walls
+            }
+        )
+        return cls(space_boundary_groups=space_boundary_groups)
+
+    def has_windows_without_wall(self) -> bool:
+        return all(
+            not (group.has_window() and not group.has_external_wall())
+            for group in self.space_boundary_groups
+        )
+
+
+class Azimuths(BaseModel):
+    north: List[float] = [0.0, 360]
+    east: List[float] = [90.0]
+    south: List[float] = [180.0]
+    west: List[float] = [270.0]
+    northeast: List[float] = [45.0]
+    southeast: List[float] = [135.0]
+    southwest: List[float] = [225.0]
+    northwest: List[float] = [315.0]
+    tolerance: float = 22.5
+
+    def get_azimuth(self, value: float) -> float:
+        fields = [field for field in self.model_fields if field not in ["tolerance"]]
+        for field in fields:
+            possibilities = getattr(self, field)
+            for possibility in possibilities:
+                if (
+                    value >= possibility - self.tolerance
+                    and value <= possibility + self.tolerance
+                ):
+                    return float(possibilities[0])
+        raise ValueError(f"Value {value} is not within tolerance of any azimuths.")
+
+
 class SpaceBoundary(BaseModelConfig):
     bounding_box: OrientedBoundingBox
     entity: entity_instance
@@ -108,7 +190,7 @@ class SpaceBoundary(BaseModelConfig):
             return ExternalWall(
                 name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=azimuth,
+                azimuth=Azimuths().get_azimuth(azimuth),
                 tilt=Tilt.wall,
                 construction=constructions.get_construction(self.entity),
             )
@@ -116,7 +198,7 @@ class SpaceBoundary(BaseModelConfig):
             return ExternalDoor(
                 name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=azimuth,
+                azimuth=Azimuths().get_azimuth(azimuth),
                 tilt=Tilt.wall,
                 construction=constructions.get_construction(self.entity),
             )
@@ -124,7 +206,7 @@ class SpaceBoundary(BaseModelConfig):
             return Window(
                 name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=azimuth,
+                azimuth=Azimuths().get_azimuth(azimuth),
                 tilt=Tilt.wall,
                 construction=glass,
             )
@@ -169,25 +251,6 @@ class SpaceBoundary(BaseModelConfig):
         )
 
 
-def _reassign_constructions(external_boundaries: List[BaseWall]) -> None:
-    results = {
-        tuple(sorted([ex.name, ex_.name])): (ex, ex_)
-        for ex in external_boundaries
-        for ex_ in external_boundaries
-        if ex.construction.name != ex_.construction.name
-        and ex.azimuth == ex_.azimuth
-        and isinstance(ex, ExternalWall)
-        and isinstance(ex_, ExternalWall)
-        and ex.tilt == Tilt.wall
-        and ex_.tilt == Tilt.wall
-    }
-    if results:
-        for walls in results.values():
-            construction = next(w.construction for w in walls)
-            for w in walls:
-                w.construction = construction.model_copy(deep=True)
-
-
 class SpaceBoundaries(BaseShow):
     space: Space
     boundaries: List[SpaceBoundary] = Field(default_factory=list)
@@ -220,8 +283,13 @@ class SpaceBoundaries(BaseShow):
             if boundary_model:
                 external_boundaries.append(boundary_model)
 
-        _reassign_constructions(external_boundaries)
-
+        external_space_boundaries_group = (
+            ExternalSpaceBoundaryGroups.from_external_boundaries(external_boundaries)
+        )
+        if not external_space_boundaries_group.has_windows_without_wall():
+            raise HasWindowsWithoutWallsError(
+                f"Space {self.space.global_id} has a boundary that has a windows but without walls."
+            )
         return TranoSpace(
             name=self.space.space_name(),
             occupancy=Occupancy(),
@@ -258,7 +326,7 @@ class SpaceBoundaries(BaseShow):
             if entity.is_a() not in ["IfcSpace"]
         }
 
-        for element in elements_:
+        for element in list(elements_):
             space_boundary = SpaceBoundary.from_space_and_element(
                 space_.bounding_box, element
             )

{ifctrano-0.2.0 → ifctrano-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ifctrano"
-version = "0.2.0"
+version = "0.3.0"
 description = "Package for generating building energy simulation model from IFC"
 authors = ["Ando Andriamamonjy <andoludovic.andriamamonjy@gmail.com>"]
 license = "GPL V3"
@@ -11,7 +11,7 @@ keywords = ["BIM","IFC","energy simulation", "modelica", "building energy simula
 [tool.poetry.dependencies]
 python = ">=3.10,<3.13"
 ifcopenshell = "^0.8.1.post1"
-trano = "^0.2.0"
+trano = "^0.5.0"
 shapely = "^2.0.7"
 typer = "^0.12.5"
 vedo = "^2025.5.3"