ifctrano 0.3.0__py3-none-any.whl → 0.7.0__py3-none-any.whl

ifctrano/__init__.py

@@ -1,3 +1,8 @@
 import warnings
 
 warnings.filterwarnings("ignore", category=RuntimeWarning)
+warnings.filterwarnings(
+    "ignore",
+    message=".*Pydantic serializer warnings.*",
+    category=UserWarning,
+)

ifctrano/base.py

@@ -1,5 +1,6 @@
 import json
 import math
+import sys
 from itertools import combinations
 from multiprocessing import Process
 from pathlib import Path
@@ -54,6 +55,9 @@ class BaseShow(BaseModel):
     def description(self) -> Any: ...  # noqa: ANN401
 
     def show(self, interactive: bool = True) -> None:
+        if sys.platform == "win32":
+            _show(self.lines(), interactive)
+            return
         p = Process(target=_show, args=(self.lines(), interactive))
         p.start()
 
@@ -394,6 +398,7 @@ class CommonSurface(BaseShow):
     main_vertices: FaceVertices
     common_vertices: FaceVertices
     exterior: bool = True
+    polygon: str
 
     def __hash__(self) -> int:
         return hash(

ifctrano/bounding_box.py

@@ -14,7 +14,7 @@ from pydantic import (
     Field,
     ConfigDict,
 )
-from scipy.spatial import ConvexHull  # type: ignore
+from scipy.spatial import ConvexHull, QhullError  # type: ignore
 from vedo import Line  # type: ignore
 
 from ifctrano.base import (
@@ -78,6 +78,7 @@ class ExtendCommonSurface(CommonSurface):
             orientation=self.orientation,
             main_vertices=self.main_vertices,
             common_vertices=self.common_vertices,
+            polygon=self.polygon,
         )
 
 
@@ -137,6 +138,7 @@ class OrientedBoundingBox(BaseShow):
                                 common_vertices=projected_face_1.common_vertices(
                                     intersection
                                 ),
+                                polygon=intersection.wkt,
                             )
                         )
 
@@ -190,8 +192,14 @@ class OrientedBoundingBox(BaseShow):
             entity_shape, entity_shape.geometry  # type: ignore
         )
         vertices_ = Vertices.from_arrays(np.asarray(vertices))
-        hull = ConvexHull(vertices_.to_array())
-        vertices_ = Vertices.from_arrays(vertices_.to_array()[hull.vertices])
+        try:
+            hull = ConvexHull(vertices_.to_array())
+            vertices_ = Vertices.from_arrays(vertices_.to_array()[hull.vertices])
+
+        except QhullError:
+            logger.error(
+                f"Convex hull failed for {entity.GlobalId} ({entity.is_a()}).... Continuing without it."
+            )
         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/building.py

@@ -1,3 +1,4 @@
+import logging
 import re
 from pathlib import Path
 from typing import List, Tuple, Any, Optional, Set
@@ -12,7 +13,11 @@ from trano.topology import Network  # type: ignore
 from vedo import Line  # type: ignore
 
 from ifctrano.base import BaseModelConfig, Libraries, Vector, BaseShow, CommonSurface
-from ifctrano.exceptions import IfcFileNotFoundError, NoIfcSpaceFoundError
+from ifctrano.exceptions import (
+    IfcFileNotFoundError,
+    NoIfcSpaceFoundError,
+    NoSpaceBoundariesError,
+)
 from ifctrano.space_boundary import (
     SpaceBoundaries,
     initialize_tree,
@@ -20,6 +25,8 @@ from ifctrano.space_boundary import (
 )
 from ifctrano.construction import Constructions, default_construction
 
+logger = logging.getLogger(__name__)
+
 
 def get_spaces(ifcopenshell_file: file) -> List[entity_instance]:
     return ifcopenshell_file.by_type("IfcSpace")
@@ -180,9 +187,18 @@ class Building(BaseShow):
             ]
         if not spaces:
             raise NoIfcSpaceFoundError("No IfcSpace found in the file.")
-        space_boundaries = [
-            SpaceBoundaries.from_space_entity(ifc_file, tree, space) for space in spaces
-        ]
+        space_boundaries = []
+        for space in spaces:
+            try:
+                space_boundaries.append(
+                    SpaceBoundaries.from_space_entity(ifc_file, tree, space)
+                )
+            except Exception as e:  # noqa: PERF203
+                logger.error(f"Cannot process space {space.id()}. Reason {e}")
+                continue
+        if not space_boundaries:
+            raise NoSpaceBoundariesError("No valid space boundaries found.")
+
         return cls(
             space_boundaries=space_boundaries,
             ifc_file=ifc_file,

ifctrano/construction.py

@@ -189,9 +189,9 @@ class Constructions(BaseModel):
     def get_construction(self, entity: entity_instance) -> Construction:
         construction_id = self._get_construction_id(entity)
         if construction_id is None:
-            logger.error(
-                f"Construction ID not found for {entity.GlobalId} ({entity.is_a()}) "
-                f"({entity.Name}). Using default construction."
+            logger.warning(
+                f"Construction ID not found for {entity.GlobalId} ({entity.is_a()}). "
+                f"Using default construction."
             )
             return default_construction
         constructions = [
@@ -210,11 +210,11 @@ class Constructions(BaseModel):
             if association.is_a() == "IfcRelAssociatesMaterial"
         ]
         if not associates_materials:
-            logger.error(f"Associate materials not found for {entity.GlobalId}.")
+            logger.warning(f"Associate materials not found for {entity.GlobalId}.")
             return None
         relating_material = associates_materials[0].RelatingMaterial
         if relating_material.is_a() == "IfcMaterialList":
-            logger.error(
+            logger.warning(
                 f"Material list found for {entity.GlobalId}, but no construction ID available."
             )
             return None

ifctrano/exceptions.py

@@ -18,6 +18,10 @@ class NoIfcSpaceFoundError(Exception):
     pass
 
 
+class NoSpaceBoundariesError(Exception):
+    pass
+
+
 class InvalidLibraryError(Exception):
     pass
 

ifctrano/main.py

@@ -15,6 +15,7 @@ from trano.utils.utils import is_success  # type: ignore
 from ifctrano.base import Libraries
 from ifctrano.building import Building
 from ifctrano.exceptions import InvalidLibraryError
+from rich import print
 
 app = typer.Typer()
 CHECKMARK = "[green]✔[/green]"
@@ -34,11 +35,11 @@ def create(
     show_space_boundaries: Annotated[
         bool,
         typer.Option(help="Show computed space boundaries."),
-    ] = True,
+    ] = False,
     simulate_model: Annotated[
         bool,
         typer.Option(help="Simulate the generated model."),
-    ] = True,
+    ] = False,
 ) -> None:
     with Progress(
         SpinnerColumn(),
@@ -66,12 +67,16 @@ def create(
         print(f"{CHECKMARK} Model generated at {modelica_model_path}")
         if simulate_model:
             print("Simulating...")
-            results = simulate(
-                modelica_model_path.parent,
-                building.create_network(
-                    library=library  # type: ignore
-                ),  # TODO: cannot use the network after cretingt he model
-            )
+            try:
+                results = simulate(
+                    modelica_model_path.parent,
+                    building.create_network(
+                        library=library  # type: ignore
+                    ),  # TODO: cannot use the network after creating he model
+                )
+            except Exception as e:
+                print(f"{CROSS_MARK} Simulation failed: {e}")
+                return
             if not is_success(results):
                 print(f"{CROSS_MARK} Simulation failed. See logs for more information.")
                 return

ifctrano/space_boundary.py

@@ -5,7 +5,8 @@ import ifcopenshell
 import ifcopenshell.geom
 import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
-from pydantic import Field, BeforeValidator, BaseModel
+from pydantic import Field, BeforeValidator, BaseModel, ConfigDict
+from shapely import wkt  # type: ignore
 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
@@ -24,7 +25,12 @@ 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
+from ifctrano.utils import (
+    remove_non_alphanumeric,
+    _round,
+    get_building_elements,
+    short_uuid,
+)
 
 ROOF_VECTOR = Vector(x=0, y=0, z=1)
 
@@ -175,7 +181,10 @@ class SpaceBoundary(BaseModelConfig):
         return hash(self.common_surface)
 
     def boundary_name(self) -> str:
-        return f"{self.entity.is_a()}_{remove_non_alphanumeric(self.entity.GlobalId)}"
+        return (
+            f"{remove_non_alphanumeric(self.entity.Name) or self.entity.is_a().lower()}_"
+            f"__{remove_non_alphanumeric(self.entity.GlobalId)}{short_uuid()}"
+        )
 
     def model_element(  # noqa: PLR0911
         self,
@@ -332,4 +341,109 @@ class SpaceBoundaries(BaseShow):
             )
             if space_boundary:
                 space_boundaries.append(space_boundary)
-        return cls(space=space_, boundaries=space_boundaries)
+        merged_boundaries = MergedSpaceBoundaries.from_boundaries(space_boundaries)
+        space_boundaries_ = merged_boundaries.merge_boundaries_from_part()
+        space_boundaries__ = remove_duplicate_boundaries(space_boundaries_)
+        return cls(space=space_, boundaries=space_boundaries__)
+
+
+def remove_duplicate_boundaries(
+    boundaries: List[SpaceBoundary],
+) -> List[SpaceBoundary]:
+    types = ["IfcRoof", "IfcSlab"]
+    boundaries = sorted(boundaries, key=lambda b: b.entity.GlobalId)
+    boundaries_without_types = [
+        sp for sp in boundaries if sp.entity.is_a() not in types
+    ]
+    new_boundaries = []
+    for type_ in types:
+        references = [sp for sp in boundaries if sp.entity.is_a() == type_]
+        while True:
+            reference = next(iter(references), None)
+            if not reference:
+                break
+            others = [p_ for p_ in references if p_ != reference]
+            intersecting = [
+                o
+                for o in others
+                if (
+                    wkt.loads(o.common_surface.polygon).intersects(
+                        wkt.loads(reference.common_surface.polygon)
+                    )
+                    and o.common_surface.orientation
+                    == reference.common_surface.orientation
+                )
+                and (
+                    wkt.loads(o.common_surface.polygon).intersection(
+                        wkt.loads(reference.common_surface.polygon)
+                    )
+                ).area
+                > 0
+            ]
+            current_group = sorted(
+                [*intersecting, reference], key=lambda p: p.entity.GlobalId
+            )
+            new_boundaries.append(next(iter(current_group)))
+            references = [p_ for p_ in references if p_ not in current_group]
+    return [*boundaries_without_types, *new_boundaries]
+
+
+class MergedSpaceBoundary(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+    parent: entity_instance
+    related_boundaries: List[SpaceBoundary]
+
+    def get_new_boundary(self) -> Optional[SpaceBoundary]:
+        related_boundaries = sorted(
+            self.related_boundaries, key=lambda b: b.entity.GlobalId
+        )
+        boundary = next(iter(related_boundaries), None)
+        if boundary:
+            return SpaceBoundary.model_validate(
+                boundary.model_dump() | {"entity": self.parent}
+            )
+        return None
+
+
+class MergedSpaceBoundaries(BaseModel):
+    part_boundaries: List[MergedSpaceBoundary]
+    original_boundaries: List[SpaceBoundary]
+
+    @classmethod
+    def from_boundaries(
+        cls, space_boundaries: List[SpaceBoundary]
+    ) -> "MergedSpaceBoundaries":
+        building_element_part_boundaries = [
+            boundary
+            for boundary in space_boundaries
+            if boundary.entity.is_a() in ["IfcBuildingElementPart"]
+        ]
+        existing_parent_entities = {
+            decompose.RelatingObject
+            for b in building_element_part_boundaries
+            for decompose in b.entity.Decomposes
+        }
+        part_boundaries = [
+            MergedSpaceBoundary(
+                parent=parent,
+                related_boundaries=[
+                    b
+                    for b in building_element_part_boundaries
+                    for decompose in b.entity.Decomposes
+                    if decompose.RelatingObject == parent
+                ],
+            )
+            for parent in existing_parent_entities
+        ]
+        return cls(
+            part_boundaries=part_boundaries, original_boundaries=space_boundaries
+        )
+
+    def merge_boundaries_from_part(self) -> List[SpaceBoundary]:
+        new_boundaries = [b.get_new_boundary() for b in self.part_boundaries]
+        new_boundaries_ = [nb for nb in new_boundaries if nb is not None]
+        return [
+            b
+            for b in self.original_boundaries
+            if b.entity.is_a() not in ["IfcBuildingElementPart"]
+        ] + new_boundaries_

ifctrano/types.py

@@ -1,5 +1,11 @@
 from typing import Literal
 
 BuildingElements = Literal[
-    "IfcWall", "IfcSlab", "IfcRoof", "IfcDoor", "IfcWindow", "IfcPlate"
+    "IfcWall",
+    "IfcSlab",
+    "IfcRoof",
+    "IfcDoor",
+    "IfcWindow",
+    "IfcPlate",
+    "IfcBuildingElementPart",
 ]

ifctrano/utils.py

@@ -1,4 +1,6 @@
+import random
 import re
+import string
 import uuid
 from typing import get_args
 
@@ -13,6 +15,12 @@ def remove_non_alphanumeric(text: str) -> str:
     return re.sub(r"[^a-zA-Z0-9_]", "", text).lower()
 
 
+def short_uuid() -> str:
+    return "".join(
+        random.choices(string.ascii_letters + string.digits, k=3)  # noqa: S311
+    )
+
+
 def generate_alphanumeric_uuid() -> str:
     return str(uuid.uuid4().hex).lower()
 

{ifctrano-0.3.0.dist-info → ifctrano-0.7.0.dist-info}/METADATA

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: ifctrano
-Version: 0.3.0
+Version: 0.7.0
 Summary: Package for generating building energy simulation model from IFC
 License: GPL V3
+License-File: LICENSE
 Keywords: BIM,IFC,energy simulation,modelica,building energy simulation,buildings,ideas
 Author: Ando Andriamamonjy
 Author-email: andoludovic.andriamamonjy@gmail.com
@@ -15,7 +16,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.5.0,<0.6.0)
+Requires-Dist: trano (>=0.10.0,<0.11.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
@@ -23,33 +24,11 @@ Description-Content-Type: text/markdown
 
 # ifctrano - IFC to Energy Simulation Tool
 
+---
 📖 **Full Documentation:** 👉 [ifctrano Docs](https://andoludo.github.io/ifctrano/) 
+---
 
-```bash
-pip install ifctrano
-```
-
-To check the installation, run the following commands:
-
-```bash
-ifctrano --help
-
-ifctrano verify
-```
-
-# ⚠️ WARNING ⚠️
-
-**This package is still under construction and is largely a work in progress.**  
-There are still several aspects that need further development, including:  
-
-- Material and construction extraction  
-- Slab and roof boundaries  
-- Systems integration  
-- Additional validation  
-- Bug fixes  
-- ...
-- 
-Help and contribution are more than appreciated! 🚧  
+Generate Modelica building models directly from IFC files — with support for simulation, visualization, and multiple libraries.
 
 ## Overview
 ifctrano is yet another **IFC to energy simulation** tool designed to translate **Industry Foundation Classes (IFC)** models into energy simulation models in **Modelica**.
@@ -79,10 +58,104 @@ ifctrano has been tested using open-source IFC files from various repositories:
 - 🕸️ [Ifc2Graph Test Files](https://github.com/JBjoernskov/Ifc2Graph/tree/main/test_ifc_files)
 - 🔓 [Open Source BIM](https://github.com/opensourceBIM)
 
-## Installation & Usage
-(Installation and usage instructions will be provided here, depending on the package distribution method.)
+## 🚀 Installation
+
+### 📦 Install `ifctrano`
+
+!!! warning
+    Trano requires python 3.9 or higher and docker to be installed on the system.
+            
+
+ifctrano is a Python package that can be installed via pip.
+
+```bash
+pip install ifctrano
+```
+
+### ✅ Verify Installation
+
+Run the following commands to ensure everything is working:
+
+```bash
+ifctrano --help
+ifctrano verify
+```
+
+---
+
+## 🔧 Optional Dependencies
+
+### 🐳 Docker (for simulation)
+
+To enable model simulation using the official OpenModelica Docker image, install Docker Desktop:
+
+👉 [https://docs.docker.com/desktop/](https://docs.docker.com/desktop/)
+
+Required for using the `--simulate-model` flag.
+
+---
 
+### 🧠 Graphviz (for layout visualization)
+
+`ifctrano` leverages Graphviz to optimize component layout in generated Modelica models. It is optional, but **recommended**.
+
+#### 📥 Install on Windows
+
+- Download and install from: [https://graphviz.org/download/](https://graphviz.org/download/)
+- Add the Graphviz `bin` folder to your **system `PATH`**.
+
+#### 🐧 Install on Linux
+
+```bash
+sudo apt update
+sudo apt install graphviz
+```
+
+---
+
+## ⚙️ Usage
+
+### 📁 Generate Modelica models from IFC
+
+#### 🏢 Using the **Buildings** library
+
+```bash
+ifctrano create /path/to/your.ifc
+```
+
+#### 🏫 Using the **IDEAS** library
+
+```bash
+ifctrano create /path/to/your.ifc IDEAS
+```
+
+#### 🧮 Using the **Reduced Order** library
+
+```bash
+ifctrano create /path/to/your.ifc reduced_order
+```
+
+---
+
+### 🧱 Show Space Boundaries
+
+To visualize the computed space boundaries:
+
+```bash
+ifctrano create /path/to/your.ifc --show-space-boundaries
+```
+
+---
+
+### 🔁 Simulate the Model
+
+Run a full simulation after model generation:
+
+```bash
+ifctrano create /path/to/your.ifc --simulate-model
+```
 
+Make sure Docker is installed and running before simulating.
 
 ---
 💡 **ifctrano** aims to make energy simulation model generation from IFC files **simpler, more accessible, and less reliant on incomplete IFC attributes**. 🚀

ifctrano-0.7.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+ifctrano/__init__.py,sha256=6wK0Qa_5Xe0KSk5Spn98AjTNCTIXtenZ3C0k8ZaVcn8,191
+ifctrano/base.py,sha256=s8BSnQqd6v_NFvkQFRriHCine6iylUBQai2FduC4IFk,14352
+ifctrano/bounding_box.py,sha256=64jlzY60ZDUX4ipR34WkOICpPhxLP-5w-FP42yBONRs,7729
+ifctrano/building.py,sha256=tBctMyrsvwRiDk5bDhAdfgRlbyvnbCCeA8rcdUjMbU8,9355
+ifctrano/construction.py,sha256=Lyh_o37znrDyxtKgw7dOqVsQk1S3btCPDh2YTJ8h6T0,7234
+ifctrano/example/verification.ifc,sha256=tQ9QcubT_wrbb-sc1WRRwYpb2cbkWm3dnRfXdP5GTTg,131
+ifctrano/exceptions.py,sha256=JDy_0HV7_FLfr92DkrN8F59zUHl9KdMa_lfIcfBJG6I,540
+ifctrano/main.py,sha256=YTp7RaWRMKt_UC2DRt_oXXLGTLCAc9FPg6Tsqg1zgpk,4979
+ifctrano/space_boundary.py,sha256=PmiKhcJo6iyxXKNab5NCphQgBQwatoNsqsi-BYHOONs,16055
+ifctrano/types.py,sha256=FBSWrD66EL7uHvv0GveCXmYyLtCr8gGRlT7-5j7aZD8,181
+ifctrano/utils.py,sha256=zLQUGVo15RSQQ-vfOuHsJBkHy4QhpxKSAH7Au72s0s0,873
+ifctrano-0.7.0.dist-info/METADATA,sha256=VAynLl3eaecRmVSgvU3XVSmO-_weipMqdfbw-pq3Blw,4884
+ifctrano-0.7.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ifctrano-0.7.0.dist-info/entry_points.txt,sha256=_2daDejazkphufyEu0m3lOeTio53WYmjol3KmSN0JM4,46
+ifctrano-0.7.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ifctrano-0.7.0.dist-info/RECORD,,

{ifctrano-0.3.0.dist-info → ifctrano-0.7.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 2.2.1
 Root-Is-Purelib: true
 Tag: py3-none-any

ifctrano-0.3.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-ifctrano/__init__.py,sha256=UT1-izHuXPq06nSeKzgs6qoVRfc6RqIhabf-ZKgAXf4,76
-ifctrano/base.py,sha256=BQpMZwSq0tiUN0g56CfzF11lIlijwi7VuLjC2XY4mx0,14224
-ifctrano/bounding_box.py,sha256=k74UIutxaNxfdfAjSqvr6Jj3gu6OP4sbQB_kTnZlltw,7431
-ifctrano/building.py,sha256=MUaSqWQP_4kZbH6-yrjRahm8poxLBHiBlMjOFNUV88o,8910
-ifctrano/construction.py,sha256=KGiJJ6L0D7mK254GYl6CO7TKoTNoUSJeZCSHzbkhslo,7244
-ifctrano/example/verification.ifc,sha256=tQ9QcubT_wrbb-sc1WRRwYpb2cbkWm3dnRfXdP5GTTg,131
-ifctrano/exceptions.py,sha256=SKFiFEhn0bW2Dm4fVHeMGIQ1C84nlLhapxy8y46SkfM,488
-ifctrano/main.py,sha256=cXev3w-uC_wgi4lxtvn4zrAogX-6pUSR0GNav3s0Z5g,4793
-ifctrano/space_boundary.py,sha256=lDhq05FC8BMZ07vGhU9smXj-gnOy-zoqIpkoW0QFCeI,11922
-ifctrano/types.py,sha256=wxKVb2R4Dz58YzN4PzgXhuuVw-UYobSh9fnYWQrYlqQ,130
-ifctrano/utils.py,sha256=AjQrIqbKAk4CWCcfeRHSZtWT6AAxQLyj-uDWPdUU6UU,712
-ifctrano-0.3.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ifctrano-0.3.0.dist-info/METADATA,sha256=5hdAUTbC0kirbMFK_uvxKk76HGHHf-f8sHKJxkhkaWs,3533
-ifctrano-0.3.0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-ifctrano-0.3.0.dist-info/entry_points.txt,sha256=_2daDejazkphufyEu0m3lOeTio53WYmjol3KmSN0JM4,46
-ifctrano-0.3.0.dist-info/RECORD,,