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

ifctrano/exceptions.py

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

ifctrano/main.py

@@ -1,10 +1,16 @@
 import shutil
+import webbrowser
 from pathlib import Path
 from tempfile import TemporaryDirectory
 from typing import Annotated, get_args
 
 import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
+from trano.reporting.html import to_html_reporting  # type: ignore
+from trano.reporting.reporting import ModelDocumentation  # type: ignore
+from trano.reporting.types import ResultFile  # type: ignore
+from trano.simulate.simulate import simulate  # type: ignore
+from trano.utils.utils import is_success  # type: ignore
 
 from ifctrano.base import Libraries
 from ifctrano.building import Building
@@ -25,6 +31,14 @@ def create(
         str,
         typer.Argument(help="Modelica library to be used for simulation."),
     ] = "Buildings",
+    show_space_boundaries: Annotated[
+        bool,
+        typer.Option(help="Show computed space boundaries."),
+    ] = True,
+    simulate_model: Annotated[
+        bool,
+        typer.Option(help="Simulate the generated model."),
+    ] = True,
 ) -> None:
     with Progress(
         SpinnerColumn(),
@@ -41,12 +55,47 @@ def create(
             total=None,
         )
         building = Building.from_ifc(Path(model))
-        modelica_model = building.create_model(library=library)  # type: ignore
+        if show_space_boundaries:
+            print(f"{CHECKMARK} Showing space boundaries.")
+            building.show()
+        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_model)
+        modelica_model_path.write_text(modelica_network.model())
         progress.remove_task(task)
         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
+            )
+            if not is_success(results):
+                print(f"{CROSS_MARK} Simulation failed. See logs for more information.")
+                return
+
+            result_path = (
+                Path(modelica_model_path.parent)
+                / "results"
+                / f"{modelica_model_path.stem.lower()}.building_res.mat"
+            )
+            if not result_path.exists():
+                print(
+                    f"{CROSS_MARK} Simulation failed. Result file not found in {result_path}."
+                )
+                return
+            reporting = ModelDocumentation.from_network(
+                building.create_network(library=library),  # type: ignore
+                result=ResultFile(path=result_path),
+            )
+            html = to_html_reporting(reporting)
+            report_path = Path(
+                modelica_model_path.parent / f"{modelica_model_path.stem}.html"
+            )
+            report_path.write_text(html)
+            webbrowser.open(f"file://{report_path}")
 
 
 @app.command()
@@ -73,3 +122,7 @@ def verify() -> None:
             print(
                 f"{CROSS_MARK} Model could not be created... please check your system."
             )
+
+
+if __name__ == "__main__":
+    app()

ifctrano/space_boundary.py

@@ -1,37 +1,32 @@
 import multiprocessing
-import re
-from typing import Optional, List, Tuple, Any
+from typing import Optional, List, Tuple, Any, Annotated
 
 import ifcopenshell
 import ifcopenshell.geom
 import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
-from pydantic import BaseModel, Field
+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.construction import (  # type: ignore
-    Construction,
-    Layer,
-    Material,
-    Glass,
-    GlassLayer,
-    GasLayer,
-    GlassMaterial,
-    Gas,
-)
 from trano.elements.system import Occupancy  # type: ignore
 from trano.elements.types import Tilt  # type: ignore
+from vedo import Line  # type: ignore
 
 from ifctrano.base import (
     GlobalId,
     settings,
     BaseModelConfig,
     CommonSurface,
-    ROUNDING_FACTOR,
     CLASH_CLEARANCE,
     Vector,
+    BaseShow,
 )
 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)
 
 
 def initialize_tree(ifc_file: file) -> ifcopenshell.geom.tree:
@@ -48,18 +43,14 @@ def initialize_tree(ifc_file: file) -> ifcopenshell.geom.tree:
     return tree
 
 
-def remove_non_alphanumeric(text: str) -> str:
-    return re.sub(r"[^a-zA-Z0-9]", "", text).lower()
-
-
 class Space(GlobalId):
     name: Optional[str] = None
     bounding_box: OrientedBoundingBox
     entity: entity_instance
-    average_room_height: float
-    floor_area: float
-    bounding_box_height: float
-    bounding_box_volume: float
+    average_room_height: Annotated[float, BeforeValidator(_round)]
+    floor_area: Annotated[float, BeforeValidator(_round)]
+    bounding_box_height: Annotated[float, BeforeValidator(_round)]
+    bounding_box_volume: Annotated[float, BeforeValidator(_round)]
 
     @classmethod
     def from_entity(cls, entity: entity_instance) -> "Space":
@@ -84,8 +75,8 @@ class Space(GlobalId):
         )
 
     def check_volume(self) -> bool:
-        return round(self.bounding_box_volume, ROUNDING_FACTOR) == round(
-            self.floor_area * self.average_room_height, ROUNDING_FACTOR
+        return round(self.bounding_box_volume) == round(
+            self.floor_area * self.average_room_height
         )
 
     def space_name(self) -> str:
@@ -93,46 +84,85 @@ class Space(GlobalId):
         return f"space_{main_name}{remove_non_alphanumeric(self.entity.GlobalId)}"
 
 
-material_1 = Material(
-    name="material_1",
-    thermal_conductivity=0.046,
-    specific_heat_capacity=940,
-    density=80,
-)
-construction = Construction(
-    name="construction_4",
-    layers=[
-        Layer(material=material_1, thickness=0.18),
-    ],
-)
-id_100 = GlassMaterial(
-    name="id_100",
-    thermal_conductivity=1,
-    density=2500,
-    specific_heat_capacity=840,
-    solar_transmittance=[0.646],
-    solar_reflectance_outside_facing=[0.062],
-    solar_reflectance_room_facing=[0.063],
-    infrared_transmissivity=0,
-    infrared_absorptivity_outside_facing=0.84,
-    infrared_absorptivity_room_facing=0.84,
-)
+class ExternalSpaceBoundaryGroup(BaseModelConfig):
+    constructions: List[BaseWall]
+    azimuth: float
+    tilt: Tilt
 
-air = Gas(
-    name="Air",
-    thermal_conductivity=0.025,
-    density=1.2,
-    specific_heat_capacity=1005,
-)
-glass = Glass(
-    name="double_glazing",
-    u_value_frame=1.4,
-    layers=[
-        GlassLayer(thickness=0.003, material=id_100),
-        GasLayer(thickness=0.0127, material=air),
-        GlassLayer(thickness=0.003, material=id_100),
-    ],
-)
+    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):
@@ -141,11 +171,17 @@ class SpaceBoundary(BaseModelConfig):
     common_surface: CommonSurface
     adjacent_spaces: List[Space] = Field(default_factory=list)
 
+    def __hash__(self) -> int:
+        return hash(self.common_surface)
+
     def boundary_name(self) -> str:
         return f"{self.entity.is_a()}_{remove_non_alphanumeric(self.entity.GlobalId)}"
 
-    def model_element(
-        self, exclude_entities: List[str], north_axis: Vector
+    def model_element(  # noqa: PLR0911
+        self,
+        exclude_entities: List[str],
+        north_axis: Vector,
+        constructions: Constructions,
     ) -> Optional[BaseWall]:
         if self.entity.GlobalId in exclude_entities:
             return None
@@ -154,23 +190,23 @@ 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=construction,
+                construction=constructions.get_construction(self.entity),
             )
         if "door" in self.entity.is_a().lower():
             return ExternalDoor(
                 name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=azimuth,
+                azimuth=Azimuths().get_azimuth(azimuth),
                 tilt=Tilt.wall,
-                construction=construction,
+                construction=constructions.get_construction(self.entity),
             )
         if "window" in self.entity.is_a().lower():
             return Window(
                 name=self.boundary_name(),
                 surface=self.common_surface.area,
-                azimuth=azimuth,
+                azimuth=Azimuths().get_azimuth(azimuth),
                 tilt=Tilt.wall,
                 construction=glass,
             )
@@ -180,7 +216,16 @@ class SpaceBoundary(BaseModelConfig):
                 surface=self.common_surface.area,
                 azimuth=azimuth,
                 tilt=Tilt.ceiling,
-                construction=construction,
+                construction=constructions.get_construction(self.entity),
+            )
+        if "slab" in self.entity.is_a().lower():
+            orientation = self.common_surface.orientation.dot(ROOF_VECTOR)
+            return ExternalWall(
+                name=self.boundary_name(),
+                surface=self.common_surface.area,
+                azimuth=azimuth,
+                tilt=Tilt.ceiling if orientation > 0 else Tilt.floor,
+                construction=constructions.get_construction(self.entity),
             )
 
         return None
@@ -206,20 +251,45 @@ class SpaceBoundary(BaseModelConfig):
         )
 
 
-class SpaceBoundaries(BaseModel):
+class SpaceBoundaries(BaseShow):
     space: Space
     boundaries: List[SpaceBoundary] = Field(default_factory=list)
 
+    def description(self) -> set[tuple[float, tuple[float, ...], Any, str]]:
+        return {b.description() for b in self.boundaries}
+
+    def lines(self) -> List[Line]:
+        lines = []
+        for boundary in self.boundaries:
+            lines += boundary.common_surface.lines()
+        return lines
+
+    def remove(self, space_boundaries: List[SpaceBoundary]) -> None:
+        for space_boundary in space_boundaries:
+            if space_boundary in self.boundaries:
+                self.boundaries.remove(space_boundary)
+
     def model(
-        self, exclude_entities: List[str], north_axis: Vector
+        self,
+        exclude_entities: List[str],
+        north_axis: Vector,
+        constructions: Constructions,
     ) -> Optional[TranoSpace]:
-        external_boundaries = [
-            boundary.model_element(exclude_entities, north_axis)
-            for boundary in self.boundaries
-            if boundary.model_element(exclude_entities, north_axis)
-        ]
-        if not external_boundaries:
-            return None
+        external_boundaries = []
+        for boundary in self.boundaries:
+            boundary_model = boundary.model_element(
+                exclude_entities, north_axis, constructions
+            )
+            if boundary_model:
+                external_boundaries.append(boundary_model)
+
+        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(),
@@ -238,28 +308,28 @@ class SpaceBoundaries(BaseModel):
         space: entity_instance,
     ) -> "SpaceBoundaries":
         space_ = Space.from_entity(space)
+
+        elements = get_building_elements(ifcopenshell_file)
         clashes = tree.clash_clearance_many(
             [space],
-            ifcopenshell_file.by_type("IfcWall")
-            + ifcopenshell_file.by_type("IfcSlab")
-            + ifcopenshell_file.by_type("IfcRoof")
-            + ifcopenshell_file.by_type("IfcDoor")
-            + ifcopenshell_file.by_type("IfcWindow"),
+            elements,
             clearance=CLASH_CLEARANCE,
         )
         space_boundaries = []
-
-        for clash in clashes:
-            elements = [
-                ifcopenshell_file.by_guid(clash.a.get_argument(0)),
-                ifcopenshell_file.by_guid(clash.b.get_argument(0)),
+        elements_ = {
+            entity
+            for c in clashes
+            for entity in [
+                ifcopenshell_file.by_guid(c.a.get_argument(0)),
+                ifcopenshell_file.by_guid(c.b.get_argument(0)),
             ]
-            for element in elements:
-                if element.GlobalId == space.GlobalId:
-                    continue
-                space_boundary = SpaceBoundary.from_space_and_element(
-                    space_.bounding_box, element
-                )
-                if space_boundary:
-                    space_boundaries.append(space_boundary)
+            if entity.is_a() not in ["IfcSpace"]
+        }
+
+        for element in list(elements_):
+            space_boundary = SpaceBoundary.from_space_and_element(
+                space_.bounding_box, element
+            )
+            if space_boundary:
+                space_boundaries.append(space_boundary)
         return cls(space=space_, boundaries=space_boundaries)

ifctrano/types.py

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

ifctrano/utils.py

@@ -0,0 +1,29 @@
+import re
+import uuid
+from typing import get_args
+
+from ifcopenshell import file, entity_instance
+
+from ifctrano.base import ROUNDING_FACTOR
+from ifctrano.types import BuildingElements
+
+
+def remove_non_alphanumeric(text: str) -> str:
+    text = text.replace(" ", "_")
+    return re.sub(r"[^a-zA-Z0-9_]", "", text).lower()
+
+
+def generate_alphanumeric_uuid() -> str:
+    return str(uuid.uuid4().hex).lower()
+
+
+def _round(value: float) -> float:
+    return round(value, ROUNDING_FACTOR)
+
+
+def get_building_elements(ifcopenshell_file: file) -> list[entity_instance]:
+    return [
+        e
+        for building_element in get_args(BuildingElements)
+        for e in ifcopenshell_file.by_type(building_element)
+    ]

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

@@ -1,8 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: ifctrano
-Version: 0.1.12
+Version: 0.3.0
 Summary: Package for generating building energy simulation model from IFC
-Home-page: https://github.com/andoludo/ifctrano
 License: GPL V3
 Keywords: BIM,IFC,energy simulation,modelica,building energy simulation,buildings,ideas
 Author: Ando Andriamamonjy
@@ -12,11 +11,13 @@ Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: ifcopenshell (>=0.8.1.post1,<0.9.0)
-Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: open3d (>=0.19.0,<0.20.0)
 Requires-Dist: shapely (>=2.0.7,<3.0.0)
-Requires-Dist: trano (>=0.1.50,<0.2.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
 Description-Content-Type: text/markdown
 

ifctrano-0.3.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+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,,

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

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

ifctrano-0.1.12.dist-info/RECORD

@@ -1,13 +0,0 @@
-ifctrano/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ifctrano/base.py,sha256=xpfZ27dZ5SZ5z2fz3N4GonkGWvXRYhMfOjoy94R4Yt8,5748
-ifctrano/bounding_box.py,sha256=OnkOR3NOyVRFSdo0d9BeFm93ZU40TV_gQSxYHOEPCYE,9382
-ifctrano/building.py,sha256=NoF0V5H_jDoyl0zkWPrSQa4xX0HIA23Kqu_TbH4Q56M,7134
-ifctrano/example/verification.ifc,sha256=L6YRD_rny7IEB4myA7uCLO6eI-xXOn2jp_67lw3lUrE,128600
-ifctrano/exceptions.py,sha256=1FQeuuq_lVZ4CawwewQvkE8OlDQwhBTbKfmc2FiZodo,431
-ifctrano/main.py,sha256=QH5KI8wFM4KsIRXNz_CVNtr3DWP3GdETtAAZGL84VEI,2703
-ifctrano/space_boundary.py,sha256=SxVXkBi8TNZfmPDFT-6epuewk8E9V1astVgcD3FT8ew,8617
-ifctrano-0.1.12.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ifctrano-0.1.12.dist-info/METADATA,sha256=aSroySKHppxHxEyq0v-RvwAEPhy70AqTL4gTRsP5oig,3490
-ifctrano-0.1.12.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ifctrano-0.1.12.dist-info/entry_points.txt,sha256=_2daDejazkphufyEu0m3lOeTio53WYmjol3KmSN0JM4,46
-ifctrano-0.1.12.dist-info/RECORD,,