ifctrano 0.1.6__tar.gz → 0.1.8__tar.gz

{ifctrano-0.1.6 → ifctrano-0.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ifctrano
-Version: 0.1.6
+Version: 0.1.8
 Summary: Package for generating building energy simulation model from IFC
 Home-page: https://github.com/andoludo/ifctrano
 License: GPL V3
@@ -22,6 +22,12 @@ Description-Content-Type: text/markdown
 
 # ifctrano - IFC to Energy Simulation Tool
 
+📖 **Full Documentation:** 👉 [Trano Docs](https://andoludo.github.io/ifctrano/) 
+
+```bash
+pip install ifctrano
+```
+
 ## Overview
 ifctrano is yet another **IFC to energy simulation** tool designed to translate **Industry Foundation Classes (IFC)** models into energy simulation models in **Modelica**.
 

{ifctrano-0.1.6 → ifctrano-0.1.8}/README.md

@@ -1,5 +1,11 @@
 # ifctrano - IFC to Energy Simulation Tool
 
+📖 **Full Documentation:** 👉 [Trano Docs](https://andoludo.github.io/ifctrano/) 
+
+```bash
+pip install ifctrano
+```
+
 ## Overview
 ifctrano is yet another **IFC to energy simulation** tool designed to translate **Industry Foundation Classes (IFC)** models into energy simulation models in **Modelica**.
 

{ifctrano-0.1.6 → ifctrano-0.1.8}/ifctrano/base.py

@@ -8,6 +8,7 @@ from pydantic import BaseModel, BeforeValidator, ConfigDict
 settings = ifcopenshell.geom.settings()  # type: ignore
 Coordinate = Literal["x", "y", "z"]
 AREA_TOLERANCE = 0.5
+ROUNDING_FACTOR = 5
 
 
 class BaseModelConfig(BaseModel):

{ifctrano-0.1.6 → ifctrano-0.1.8}/ifctrano/bounding_box.py

@@ -1,5 +1,5 @@
 from logging import getLogger
-from typing import List, Optional, Any, Tuple
+from typing import List, Optional, Any, Tuple, cast
 
 import ifcopenshell
 import numpy as np
@@ -23,6 +23,7 @@ from ifctrano.base import (
     settings,
     CommonSurface,
     AREA_TOLERANCE,
+    ROUNDING_FACTOR,
 )
 from ifctrano.exceptions import BoundingBoxFaceError
 
@@ -77,7 +78,12 @@ class BoundingBoxFace(BaseModelConfig):
             vertices=vertices, normal=normal, coordinate_system=coordinate_system
         )
 
+    def get_face_area(self) -> float:
+        polygon_2d = self.get_2d_polygon(self.coordinate_system)
+        return cast(float, round(polygon_2d.polygon.area, ROUNDING_FACTOR))
+
     def get_2d_polygon(self, coordinate_system: CoordinateSystem) -> Polygon2D:
+
         projected_vertices = coordinate_system.inverse(self.vertices.to_array())
         projected_normal_index = Vector.from_array(
             coordinate_system.inverse(self.normal.to_array())
@@ -152,6 +158,8 @@ class OrientedBoundingBox(BaseModel):
     faces: BoundingBoxFaces
     centroid: Point
     area_tolerance: float = Field(default=AREA_TOLERANCE)
+    volume: float
+    height: float
 
     def intersect_faces(self, other: "OrientedBoundingBox") -> Optional[CommonSurface]:
         extend_surfaces = []
@@ -160,11 +168,9 @@ class OrientedBoundingBox(BaseModel):
             for other_face in other.faces.faces:
                 vector = face.normal * other_face.normal
                 if vector.is_a_zero():
-
                     polygon_1 = other_face.get_2d_polygon(face.coordinate_system)
                     polygon_2 = face.get_2d_polygon(face.coordinate_system)
                     intersection = polygon_2.polygon.intersection(polygon_1.polygon)
-
                     if intersection.area > self.area_tolerance:
                         distance = abs(polygon_1.length - polygon_2.length)
                         area = intersection.area
@@ -194,8 +200,8 @@ class OrientedBoundingBox(BaseModel):
     ) -> "OrientedBoundingBox":
         vertices_np = np.array(vertices)
         points = np.asarray(vertices_np)
-        cov = np.cov(points, y=None, rowvar=0, bias=1)  # type: ignore
-        v, vect = np.linalg.eig(cov)
+        cov = np.cov(points, y=None, rowvar=0, bias=0)  # type: ignore
+        v, vect = np.linalg.eig(np.round(cov, ROUNDING_FACTOR))
         tvect = np.transpose(vect)
         points_r = np.dot(points, np.linalg.inv(tvect))
 
@@ -206,9 +212,12 @@ class OrientedBoundingBox(BaseModel):
         ymin, ymax = co_min[1], co_max[1]
         zmin, zmax = co_min[2], co_max[2]
 
-        xdif = (xmax - xmin) * 0.5
-        ydif = (ymax - ymin) * 0.5
-        zdif = (zmax - zmin) * 0.5
+        x_len = xmax - xmin
+        y_len = ymax - ymin
+        z_len = zmax - zmin
+        xdif = x_len * 0.5
+        ydif = y_len * 0.5
+        zdif = z_len * 0.5
 
         cx = xmin + xdif
         cy = ymin + ydif
@@ -225,7 +234,11 @@ class OrientedBoundingBox(BaseModel):
                 [cx + xdif, cy - ydif, cz - zdif],
             ]
         )
-        corners = np.dot(corners, tvect)
+        corners_ = np.dot(corners, tvect)
+        dims = np.transpose(corners_)
+        x_size = np.max(dims[0]) - np.min(dims[0])
+        y_size = np.max(dims[1]) - np.min(dims[1])
+        z_size = np.max(dims[2]) - np.min(dims[2])
         coordinate_system = CoordinateSystem.from_array(tvect)
         c = P(x=cx, y=cy, z=cz)
         d = P(x=xdif, y=ydif, z=zdif)
@@ -233,6 +246,8 @@ class OrientedBoundingBox(BaseModel):
         return cls(
             faces=faces,
             centroid=Point.from_array(coordinate_system.project(c.to_array())),
+            volume=x_size * y_size * z_size,
+            height=z_size,
         )
 
     @classmethod

ifctrano-0.1.8/ifctrano/building.py

@@ -0,0 +1,133 @@
+from pathlib import Path
+from typing import List
+
+import ifcopenshell
+from ifcopenshell import file, entity_instance
+from pydantic import validate_call, Field, model_validator
+from trano.elements import InternalElement  # type: ignore
+from trano.elements.library.library import Library  # type: ignore
+from trano.elements.types import Tilt  # type: ignore
+from trano.topology import Network  # type: ignore
+
+from ifctrano.base import BaseModelConfig, Libraries
+from ifctrano.exceptions import IfcFileNotFoundError
+from ifctrano.space_boundary import (
+    SpaceBoundaries,
+    initialize_tree,
+    Space,
+    construction,
+)
+
+
+def get_spaces(ifcopenshell_file: file) -> List[entity_instance]:
+    return ifcopenshell_file.by_type("IfcSpace")
+
+
+class IfcInternalElement(BaseModelConfig):
+    spaces: List[Space]
+    element: entity_instance
+    area: float
+
+
+class InternalElements(BaseModelConfig):
+    elements: List[IfcInternalElement] = Field(default_factory=list)
+
+    def internal_element_ids(self) -> List[str]:
+        return list({e.element.GlobalId for e in self.elements})
+
+
+class Building(BaseModelConfig):
+    name: str
+    space_boundaries: List[SpaceBoundaries]
+    ifc_file: file
+    parent_folder: Path
+    internal_elements: InternalElements = Field(default_factory=InternalElements)
+
+    @classmethod
+    def from_ifc(cls, ifc_file_path: Path) -> "Building":
+        if not ifc_file_path.exists():
+            raise IfcFileNotFoundError(
+                f"File specified {ifc_file_path} does not exist."
+            )
+        ifc_file = ifcopenshell.open(str(ifc_file_path))
+        tree = initialize_tree(ifc_file)
+        spaces = get_spaces(ifc_file)
+        space_boundaries = [
+            SpaceBoundaries.from_space_entity(ifc_file, tree, space) for space in spaces
+        ]
+        return cls(
+            space_boundaries=space_boundaries,
+            ifc_file=ifc_file,
+            parent_folder=ifc_file_path.parent,
+            name=ifc_file_path.stem,
+        )
+
+    @model_validator(mode="after")
+    def _validator(self) -> "Building":
+        self.internal_elements = self.get_adjacency()
+        return self
+
+    def get_adjacency(self) -> InternalElements:
+        elements = []
+        for space_boundaries_ in self.space_boundaries:
+            for space_boundaries__ in self.space_boundaries:
+                space_1 = space_boundaries_.space
+                space_2 = space_boundaries__.space
+                if space_1.global_id == space_2.global_id:
+                    continue
+                common_surface = space_1.bounding_box.intersect_faces(
+                    space_2.bounding_box
+                )
+                for boundary in space_boundaries_.boundaries:
+                    for boundary_ in space_boundaries__.boundaries:
+                        if (
+                            boundary.entity.GlobalId == boundary_.entity.GlobalId
+                            and boundary.common_surface
+                            and boundary_.common_surface
+                            and common_surface
+                            and (
+                                boundary.common_surface.orientation
+                                * common_surface.orientation
+                            ).is_a_zero()
+                            and (
+                                boundary_.common_surface.orientation
+                                * common_surface.orientation
+                            ).is_a_zero()
+                        ):
+                            elements.append(  # noqa: PERF401
+                                IfcInternalElement(
+                                    spaces=[space_1, space_2],
+                                    element=boundary_.entity,
+                                    area=common_surface.area,
+                                )
+                            )
+        return InternalElements(elements=elements)
+
+    @validate_call
+    def create_model(self, library: Libraries = "Buildings") -> str:
+        network = Network(name=self.name, library=Library.from_configuration(library))
+        spaces = {
+            space_boundary.space.global_id: space_boundary.model(
+                self.internal_elements.internal_element_ids()
+            )
+            for space_boundary in self.space_boundaries
+        }
+        network.add_boiler_plate_spaces(list(spaces.values()))
+        for internal_element in self.internal_elements.elements:
+            space_1 = internal_element.spaces[0]
+            space_2 = internal_element.spaces[1]
+            network.connect_spaces(
+                spaces[space_1.global_id],
+                spaces[space_2.global_id],
+                InternalElement(
+                    azimuth=10,
+                    construction=construction,
+                    surface=internal_element.area,
+                    tilt=Tilt.wall,
+                ),
+            )
+        return network.model()  # type: ignore
+
+    def save_model(self, library: Libraries = "Buildings") -> None:
+        model_ = self.create_model(library)
+        Path(self.parent_folder.joinpath(f"{self.name}.mo")).write_text(model_)

{ifctrano-0.1.6 → ifctrano-0.1.8}/ifctrano/exceptions.py

@@ -8,3 +8,11 @@ class BoundingBoxFaceError(Exception):
 
 class IfcFileNotFoundError(FileNotFoundError):
     pass
+
+
+class SpaceSurfaceAreaNullError(Exception):
+    pass
+
+
+class InvalidLibraryError(Exception):
+    pass

{ifctrano-0.1.6 → ifctrano-0.1.8}/ifctrano/main.py

@@ -1,12 +1,12 @@
 from pathlib import Path
-from typing import Annotated
+from typing import Annotated, get_args
 
 import typer
-from pydantic import validate_call
 from rich.progress import Progress, SpinnerColumn, TextColumn
 
 from ifctrano.base import Libraries
 from ifctrano.building import Building
+from ifctrano.exceptions import InvalidLibraryError
 
 app = typer.Typer()
 CHECKMARK = "[green]✔[/green]"
@@ -14,14 +14,13 @@ CROSS_MARK = "[red]✘[/red]"
 
 
 @app.command()
-@validate_call
 def create(
     model: Annotated[
         str,
         typer.Argument(help="Local path to the ifc file."),
     ],
     library: Annotated[
-        Libraries,
+        str,
         typer.Argument(help="Modelica library to be used for simulation."),
     ] = "Buildings",
 ) -> None:
@@ -30,6 +29,10 @@ def create(
         TextColumn("[progress.description]{task.description}"),
         transient=True,
     ) as progress:
+        if library not in get_args(Libraries):
+            raise InvalidLibraryError(
+                f"Invalid library {library}. Valid libraries are {get_args(Libraries)}"
+            )
         modelica_model_path = Path(model).resolve().with_suffix(".mo")
         task = progress.add_task(
             description=f"Generating model {modelica_model_path.name} with library {library} from {model}",

{ifctrano-0.1.6 → ifctrano-0.1.8}/ifctrano/space_boundary.py

@@ -7,17 +7,23 @@ import ifcopenshell.geom
 import ifcopenshell.util.shape
 from ifcopenshell import entity_instance, file
 from pydantic import BaseModel, Field
+from trano.data_models.conversion import SpaceParameter  # type: ignore
 from trano.elements import Space as TranoSpace, ExternalWall, Window, BaseWall  # type: ignore
 from trano.elements.construction import Construction, Layer, Material  # type: ignore
 from trano.elements.system import Occupancy  # type: ignore
 from trano.elements.types import Azimuth, Tilt  # type: ignore
 
-from ifctrano.base import GlobalId, settings, BaseModelConfig, CommonSurface
+from ifctrano.base import (
+    GlobalId,
+    settings,
+    BaseModelConfig,
+    CommonSurface,
+    ROUNDING_FACTOR,
+)
 from ifctrano.bounding_box import OrientedBoundingBox
 
 
 def initialize_tree(ifc_file: file) -> ifcopenshell.geom.tree:
-
     tree = ifcopenshell.geom.tree()
 
     iterator = ifcopenshell.geom.iterator(
@@ -39,6 +45,37 @@ 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
+
+    @classmethod
+    def from_entity(cls, entity: entity_instance) -> "Space":
+        bounding_box = OrientedBoundingBox.from_entity(entity)
+        entity_shape = ifcopenshell.geom.create_shape(settings, entity)
+        area = ifcopenshell.util.shape.get_footprint_area(entity_shape.geometry)  # type: ignore
+        volume = ifcopenshell.util.shape.get_volume(entity_shape.geometry)  # type: ignore
+        if area:
+            average_room_height = volume / area
+        else:
+            area = bounding_box.volume / bounding_box.height
+            average_room_height = bounding_box.height
+        return cls(
+            global_id=entity.GlobalId,
+            name=entity.Name,
+            bounding_box=bounding_box,
+            entity=entity,
+            average_room_height=average_room_height,
+            floor_area=area,
+            bounding_box_height=bounding_box.height,
+            bounding_box_volume=bounding_box.volume,
+        )
+
+    def check_volume(self) -> bool:
+        return round(self.bounding_box_volume, ROUNDING_FACTOR) == round(
+            self.floor_area * self.average_room_height, ROUNDING_FACTOR
+        )
 
     def space_name(self) -> str:
         main_name = (
@@ -67,23 +104,32 @@ class SpaceBoundary(BaseModelConfig):
     bounding_box: OrientedBoundingBox
     entity: entity_instance
     common_surface: CommonSurface
-    adjacent_space: Optional[Space] = None
+    adjacent_spaces: List[Space] = Field(default_factory=list)
 
-    def model_element(self) -> Optional[BaseWall]:
+    def model_element(self, exclude_entities: List[str]) -> Optional[BaseWall]:
+        if self.entity.GlobalId in exclude_entities:
+            return None
         if "wall" in self.entity.is_a().lower():
             return ExternalWall(
-                surface=6.44,
+                surface=self.common_surface.area,
                 azimuth=Azimuth.south,
                 tilt=Tilt.wall,
                 construction=construction,
             )
         if "window" in self.entity.is_a().lower():
             return Window(
-                surface=6.44,
+                surface=self.common_surface.area,
                 azimuth=Azimuth.south,
                 tilt=Tilt.wall,
                 construction=construction,
             )
+        if "roof" in self.entity.is_a().lower():
+            return ExternalWall(
+                surface=self.common_surface.area,
+                azimuth=Azimuth.south,
+                tilt=Tilt.ceiling,
+                construction=construction,
+            )
 
         return None
 
@@ -112,14 +158,18 @@ class SpaceBoundaries(BaseModel):
     space: Space
     boundaries: List[SpaceBoundary] = Field(default_factory=list)
 
-    def model(self) -> TranoSpace:
+    def model(self, exclude_entities: List[str]) -> TranoSpace:
         return TranoSpace(
             name=self.space.space_name(),
             occupancy=Occupancy(),
+            parameters=SpaceParameter(
+                floor_area=self.space.floor_area,
+                average_room_height=self.space.average_room_height,
+            ),
             external_boundaries=[
-                boundary.model_element()
+                boundary.model_element(exclude_entities)
                 for boundary in self.boundaries
-                if boundary.model_element()
+                if boundary.model_element(exclude_entities)
             ],
         )
 
@@ -130,13 +180,7 @@ class SpaceBoundaries(BaseModel):
         tree: ifcopenshell.geom.tree,
         space: entity_instance,
     ) -> "SpaceBoundaries":
-        bounding_box = OrientedBoundingBox.from_entity(space)
-        space_ = Space(
-            global_id=space.GlobalId,
-            name=space.Name,
-            bounding_box=bounding_box,
-            entity=space,
-        )
+        space_ = Space.from_entity(space)
         clashes = tree.clash_clearance_many(
             [space],
             ifcopenshell_file.by_type("IfcWall")
@@ -157,7 +201,7 @@ class SpaceBoundaries(BaseModel):
                 if element.GlobalId == space.GlobalId:
                     continue
                 space_boundary = SpaceBoundary.from_space_and_element(
-                    bounding_box, element
+                    space_.bounding_box, element
                 )
                 if space_boundary:
                     space_boundaries.append(space_boundary)

{ifctrano-0.1.6 → ifctrano-0.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ifctrano"
-version = "0.1.6"
+version = "0.1.8"
 description = "Package for generating building energy simulation model from IFC"
 authors = ["Ando Andriamamonjy <andoludovic.andriamamonjy@gmail.com>"]
 license = "GPL V3"
@@ -34,7 +34,7 @@ black = "^24.10.0"
 pytest = "^7.4.3"
 
 [tool.poetry.scripts]
-trano = "ifctrano.main:app"
+ifctrano = "ifctrano.main:app"
 
 
 [tool.poetry.group.docs.dependencies]

ifctrano-0.1.6/ifctrano/building.py

@@ -1,55 +0,0 @@
-from pathlib import Path
-from typing import List
-
-import ifcopenshell
-from ifcopenshell import file, entity_instance
-from pydantic import validate_call
-from trano.elements.library.library import Library  # type: ignore
-
-from trano.topology import Network  # type: ignore
-
-from ifctrano.base import BaseModelConfig, Libraries
-from ifctrano.exceptions import IfcFileNotFoundError
-from ifctrano.space_boundary import SpaceBoundaries, initialize_tree
-
-
-def get_spaces(ifcopenshell_file: file) -> List[entity_instance]:
-    return ifcopenshell_file.by_type("IfcSpace")
-
-
-class Building(BaseModelConfig):
-    name: str
-    space_boundaries: List[SpaceBoundaries]
-    ifc_file: file
-    parent_folder: Path
-
-    @classmethod
-    def from_ifc(cls, ifc_file_path: Path) -> "Building":
-        if not ifc_file_path.exists():
-            raise IfcFileNotFoundError(
-                f"File specified {ifc_file_path} does not exist."
-            )
-        ifc_file = ifcopenshell.open(str(ifc_file_path))
-        tree = initialize_tree(ifc_file)
-        spaces = get_spaces(ifc_file)
-        space_boundaries = [
-            SpaceBoundaries.from_space_entity(ifc_file, tree, space) for space in spaces
-        ]
-        return cls(
-            space_boundaries=space_boundaries,
-            ifc_file=ifc_file,
-            parent_folder=ifc_file_path.parent,
-            name=ifc_file_path.stem,
-        )
-
-    @validate_call
-    def create_model(self, library: Libraries = "Buildings") -> str:
-        network = Network(name=self.name, library=Library.from_configuration(library))
-        network.add_boiler_plate_spaces(
-            [space_boundary.model() for space_boundary in self.space_boundaries]
-        )
-        return network.model()  # type: ignore
-
-    def save_model(self, library: Libraries = "Buildings") -> None:
-        model_ = self.create_model(library)
-        Path(self.parent_folder.joinpath(f"{self.name}.mo")).write_text(model_)