clean up

Author: chg-ext

bim2sim/plugins/PluginTEASER/bim2sim_teaser/examples/e1_simple_project_bps_teaser.py

@@ -16,8 +16,8 @@ def run_example_simple_building_teaser():
     """
     # Create a temp directory for the project, feel free to use a "normal"
     # directory
-    # ToDo set your project directory here
-    project_path = Path(r"/home/chris/src/bim2sim_up/projects/e1")
+    project_path = Path(tempfile.TemporaryDirectory(
+        prefix='bim2sim_teaser_example_e1_').name)
 
     # Set the ifc path to use and define which domain the IFC belongs to
     ifc_paths = {
@@ -50,9 +50,8 @@ def run_example_simple_building_teaser():
             Path(bim2sim.__file__).parent.parent /
             'test/resources/weather_files/DEU_NW_Aachen.105010_TMYx.mos')
     # Run a simulation directly with dymola after model creation
-    project.sim_settings.dymola_simulation = False
-    project.sim_settings.create_plots = False
-
+    project.sim_settings.dymola_simulation = True
+    project.sim_settings.create_plots = True
     # Select results to output:
     project.sim_settings.sim_results = [
         "heat_demand_total", "cool_demand_total",

bim2sim/project.py

@@ -49,7 +49,6 @@ def add_config_section(
                   if not callable(getattr(sim_settings, attr)) and not
                   attr.startswith('__')]
     for attr in attributes:
-        # ToDo (chg-ext): value(defaul) here maybe already overwritten?
         default_value = getattr(sim_settings, attr).value
         if isinstance(default_value, Enum):
             default_value = str(default_value)
@@ -422,7 +421,6 @@ def run(self, interactive=False, cleanup=True):
             raise AssertionError("Project ist not set correctly!")
 
         self.sim_settings.check_mandatory()
-
         success = False
         if interactive:
             run = self._run_interactive
@@ -506,7 +504,6 @@ def finalize(self, success=False):
             self.logger.info(f'Project "{self.name}" finished successful')
 
         # reset sim_settings:
-        # Todo (chg-ext): Why load default settings here
         self.playground.sim_settings.load_default_settings()
         # clean logger
         log.teardown_loggers()

bim2sim/sim_settings.py

@@ -8,12 +8,10 @@
 import os.path
 from typing import Union, Optional, List
 import sys
-
 from pydantic import BaseModel, Field, model_validator, field_validator, FilePath, DirectoryPath
 from pydantic_core import PydanticCustomError
 from typing_extensions import Self
 from enum import Enum
-
 from bim2sim.utilities import types
 from bim2sim.utilities.types import LOD
 from bim2sim.elements.base_elements import Material
@@ -68,7 +66,7 @@ def _create_settings(self):
             self[name] = setting
 
             # Store predefined default values in the defaults dict,
-            # so they can be set back to the default later
+            # so they can be set back to their defaults later
             self.defaults[setting.name] = setting.value
 
     @property
@@ -84,12 +82,13 @@ def names(self):
 
 
 class Setting(BaseModel, validate_assignment=True, validate_default=True):
-    """ Base class for all simulation settings.
-    The attribute value which holds the payload of the setting is introduced in derived classes,
-    e.g. NumberSetting(Setting).
+    """Base class for all simulation settings.
+
+    The attribute "value", which contains the payload of the simulation setting, is added in
+    the derived classes for the different data types (e.g. NumberSetting(Setting)).
 
-    The value which is assigned to the attribute "value", when instancing the setting, serves
-    as a default and can be changed according to the use case, if necessary.
+    The value, which is assigned to the attribute "value", when instancing the setting, serves
+    as a default value and can be changed according to the use case, if necessary.
 
     Args:
         name: Name of the setting. Is set automatically by AutoSettingNameMeta(type)
@@ -106,8 +105,8 @@ class Setting(BaseModel, validate_assignment=True, validate_default=True):
     mandatory: bool = Field(default=False)
 
     def __set__(self, bound_simulation_settings, value):
-        """Creates a new attribute with name and value of the complete setting instance,
-        stored in sim_settings. This makes it easier to access the value of a setting.
+        """Creates a new attribute with the name and value of the simulation setting instance,
+        stored in sim_settings. This makes it easier to access the setting's payload.
         
         Example:
         

bim2sim/tasks/base.py

@@ -75,7 +75,6 @@ class Playground:
     def __init__(self, project: Project):
         self.project = project
         self.sim_settings = project.plugin_cls.sim_settings()
-
         self.sim_settings.update_from_config(config=project.config)
         self.state = {}
         self.history = []

test/unit/tasks/__init__.py

@@ -51,7 +51,6 @@ def setUp(self) -> None:
     def tearDown(self) -> None:
         """Clean up after each test method."""
         self.helper.reset()
-        #self.playground.sim_settings.load_default_settings()
         self.playground.sim_settings.load_default_settings()
 
     def run_task(self, answers, reads):

test/unit/tasks/bps/test_enrich_use_cond.py

@@ -54,7 +54,6 @@ def test_enrichment_single_office_common_conditions(self):
 
     def test_enrichment_sim_setting_without_overwrite(self):
         """Tests enrichment of single office without overwrite via settings."""
-        # Todo (chg-ext): Side effect. Test runs separately, but not in context of the whole class
         print(self.playground.sim_settings.heating_tz_overwrite)
         print(self.playground.sim_settings.cooling_tz_overwrite)
         print(self.playground.sim_settings.ahu_tz_overwrite)