Merge pull request #837 from RWTH-EBC/836-custom-data-input-files

closes #836

Author: HoeppJ

teaser/data/dataclass.py

@@ -2,6 +2,8 @@
 import os
 import sys
 import warnings
+from typing import Union
+from pathlib import Path
 
 import teaser.logic.utilities as utils
 import json
@@ -19,13 +21,22 @@ class DataClass(object):
     """Class for JSON data.
 
     This class loads all JSON files with statistic or template data needed
-    for statistical data enrichment.
+    for statistical data enrichment. For loading a custom TypeElements JSON files,
+    use ConstructionData.custom as input.
 
     Parameters
     ----------
     construction_data : ConstructionData
         The prefix of this parameter indicates which statistical data about building
         elements should be used. Its type is the enum class ConstructionData.
+        To utilize custom TypeElements via a JSON file via parameter custom_path_type_elements (cf. below)
+        use ConstructionData.custom.
+    custom_path_type_elements: str or Path
+        Custom path to JSON file of TypeElements. Default: None
+    custom_path_material_templates: str or Path
+        Custom path to JSON file of MaterialTemplates. Default: None
+    custom_path_use_conditions: str or Path
+        Custom path to JSON file of UseConditions. Default: None
 
     Attributes
     ----------
@@ -47,50 +58,65 @@ class DataClass(object):
 
     """
 
-    def __init__(self, construction_data: ConstructionData) -> object:
+    def __init__(self,
+                 construction_data: ConstructionData,
+                 custom_path_type_elements: Union[str, Path]=None,
+                 custom_path_material_templates: Union[str, Path]=None,
+                 custom_path_use_conditions: Union[str, Path]=None) -> object:
+
         """Construct DataClass."""
         self.element_bind = None
-        if construction_data.is_iwu():
+        if construction_data.is_custom():
+            if custom_path_type_elements:
+                self.path_tb = custom_path_type_elements
+            elif not custom_path_type_elements:
+                raise KeyError("Provide path to custom type elements JSON file "
+                               "or change ConstructionData to a known construction type")
+        elif construction_data.is_iwu():
             self.path_tb = utils.get_full_path(
                 "data/input/inputdata/TypeElements_IWU.json"
             )
-            self.load_tb_binding()
         elif construction_data.is_tabula_de():
             self.path_tb = utils.get_full_path(
                 os.path.join(
                     "data", "input", "inputdata", "TypeElements_TABULA_DE.json"
                 )
             )
-            self.load_tb_binding()
         elif construction_data.is_tabula_dk():
             self.path_tb = utils.get_full_path(
                 os.path.join(
                     "data", "input", "inputdata", "TypeElements_TABULA_DK.json"
                 )
             )
-            self.load_tb_binding()
         elif construction_data.is_kfw():
             self.path_tb = utils.get_full_path(
                 os.path.join(
                     "data", "input", "inputdata", "TypeElements_KFW.json"
                 )
             )
-            self.load_tb_binding()
         elif construction_data is None:
             pass
+
         self.material_bind = None
-        self.path_mat = utils.get_full_path(
-            "data/input/inputdata/MaterialTemplates.json"
-        )
+        if custom_path_material_templates:
+            self.path_mat = custom_path_material_templates
+        else:
+            self.path_mat = utils.get_full_path(
+                "data/input/inputdata/MaterialTemplates.json")
+
         self.conditions_bind = None
-        self.path_uc = utils.get_full_path("data/input/inputdata/UseConditions.json")
+        if custom_path_use_conditions:
+            self.path_uc = custom_path_use_conditions
+        else:
+            self.path_uc = utils.get_full_path("data/input/inputdata/UseConditions.json")
 
+        self.load_tb_binding()
         self.load_uc_binding()
         self.load_mat_binding()
 
     def load_tb_binding(self):
         """Load TypeBuildingElement json into binding classes."""
-        if self.path_tb.endswith("json"):
+        if str(self.path_tb).endswith("json"):
             if os.path.isfile(self.path_tb):
                 try:
                     with open(self.path_tb, "r") as f:
@@ -105,7 +131,7 @@ def load_tb_binding(self):
 
     def load_uc_binding(self):
         """Load UseConditions json into binding classes."""
-        if self.path_uc.endswith("json"):
+        if str(self.path_uc).endswith("json"):
             if os.path.isfile(self.path_uc):
                 try:
                     with open(self.path_uc, "r") as f:
@@ -120,7 +146,7 @@ def load_uc_binding(self):
 
     def load_mat_binding(self):
         """Load MaterialTemplates json into binding classes."""
-        if self.path_mat.endswith("json"):
+        if str(self.path_mat).endswith("json"):
             if os.path.isfile(self.path_mat):
                 try:
                     with open(self.path_mat, "r") as f:

teaser/data/input/buildingelement_input_json.py

@@ -29,7 +29,7 @@ def load_type_element(element, year, construction, data_class,
         Year of construction
 
     construction : str
-        Construction type, code list ('iwu_heavy', 'iwu_light', 'tabula_de_standard', 'kfw_40', ...)
+        Construction type defined in data_class, code list (e.g. 'heavy', 'light' or custom)
 
     data_class : DataClass()
         DataClass containing the bindings for TypeBuildingElement and

teaser/data/utilities.py

@@ -77,6 +77,8 @@ class ConstructionData(Enum):
     The ConstructionData enumeration combines the former parameters “method” and “construction_type”.
     The prefix of each value is used to select the appropriate json file as input data.
     The complete value is used to search for the appropriate element within the json file.
+    To utilize custom TypeElements via a JSON file via parameter custom_path_type_elements (cf. below)
+    use ConstructionData.custom.
     """
     iwu_heavy = "iwu_heavy"
     iwu_light = "iwu_light"
@@ -91,6 +93,7 @@ class ConstructionData(Enum):
     kfw_70 = "kfw_70"
     kfw_85 = "kfw_85"
     kfw_100 = "kfw_100"
+    custom = "custom"
 
     def get_prefix(self):
         parts = self.value.split("_", 2)
@@ -112,6 +115,9 @@ def is_tabula_dk(self):
     def is_kfw(self):
         return self.get_prefix() == "kfw"
 
+    def is_custom(self):
+        return self.value == "custom"
+
 # Dictionary that maps GeometryData enumeration values to their corresponding building classes.
 geometries = {
     #non residential:

teaser/logic/buildingobjects/buildingphysics/buildingelement.py

@@ -296,7 +296,7 @@ def load_type_element(
             Year of construction
 
         construction : str
-            Construction type, code list ('heavy', 'light')
+            Construction type defined in data_class, code list (e.g. 'heavy', 'light' or custom)
 
         data_class : DataClass()
             DataClass containing the bindings for TypeBuildingElement and

teaser/logic/buildingobjects/buildingphysics/interzonalwall.py

@@ -180,14 +180,14 @@ def load_type_element(
             Year of construction
 
         construction : str
-            Construction type, code list ('heavy', 'light')
+            Construction type defined in data_class, code list (e.g. 'heavy', 'light' or custom)
 
         data_class : DataClass()
             DataClass containing the bindings for TypeBuildingElement and
             Material (typically this is the data class stored in prj.data,
             but the user can individually change that. Default is
             self.parent.parent.parent.data (which is data_class in current
-            project)
+            project).
 
         element_type : str
             Element type to load - only to specify if the json entry for a