ifctrano 0.3.0__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ifctrano
-Version: 0.3.0
+Version: 0.4.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.5.0,<0.6.0)
+Requires-Dist: trano (>=0.6.0,<0.7.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 +23,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 +57,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.3.0 → ifctrano-0.4.0}/README.md

@@ -1,32 +1,10 @@
 # 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**.
@@ -56,10 +34,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.4.0/ifctrano/__init__.py

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

{ifctrano-0.3.0 → ifctrano-0.4.0}/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()
 

{ifctrano-0.3.0 → ifctrano-0.4.0}/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 (
@@ -190,8 +190,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-0.3.0 → ifctrano-0.4.0}/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-0.3.0 → ifctrano-0.4.0}/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-0.3.0 → ifctrano-0.4.0}/ifctrano/space_boundary.py

@@ -24,7 +24,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 +180,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,

{ifctrano-0.3.0 → ifctrano-0.4.0}/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 → ifctrano-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ifctrano"
-version = "0.3.0"
+version = "0.4.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.5.0"
+trano = "^0.6.0"
 shapely = "^2.0.7"
 typer = "^0.12.5"
 vedo = "^2025.5.3"

ifctrano-0.3.0/ifctrano/__init__.py

@@ -1,3 +0,0 @@
-import warnings
-
-warnings.filterwarnings("ignore", category=RuntimeWarning)