teaser.data package

Subpackages

Submodules

teaser.data.dataclass module

This module holds file paths and bindings for json data.

class teaser.data.dataclass.DataClass(construction_data: ConstructionData)[source]

Bases: object

Class for JSON data.

This class loads all JSON files with statistic or template data needed for statistical data enrichment.

Parameters:
construction_dataConstructionData

The prefix of this parameter indicates which statistical data about building elements should be used. Its type is the enum class ConstructionData.

Attributes:
element_bindcollections.OrderedDict

Ordered dictionary of the TypeBuildingElements binding.

path_tbstr

Full path to TypeElements_IWU.json. Default is teaser/data/input/inputdata/TypeElements_IWU.json.

material_bindcollections.OrderedDict

Ordered dictionary of the Material binding.

path_matstr

Full path to MaterialTemplates.json. Default is teaser/data/input/inputdata/MaterialTemplates.json.

conditions_bindcollections.OrderedDict

Ordered dictionary of the UseConditions binding.

path_ucstr

Full path to UseConditions.json. Default is teaser/data/input/inputdata/UseConditions.json

load_mat_binding()[source]

Load MaterialTemplates json into binding classes.

load_tb_binding()[source]

Load TypeBuildingElement json into binding classes.

load_uc_binding()[source]

Load UseConditions json into binding classes.

teaser.data.utilities module

This module provides the definitions and mappings for various building archetypes and construction standards used in the TEASER framework. The module includes enumerations for different geometry types of buildings and construction data types, as well as dictionaries that map these enumerations to their corresponding building classes. Additionally, it defines which construction data types are allowed for each building geometry data and includes functions to set the suitable construction_data.

class teaser.data.utilities.ConstructionData(value)[source]

Bases: 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.

get_prefix()[source]
is_iwu()[source]
is_kfw()[source]
is_tabula_de()[source]
is_tabula_dk()[source]
iwu_heavy = 'iwu_heavy'
iwu_light = 'iwu_light'
kfw_100 = 'kfw_100'
kfw_40 = 'kfw_40'
kfw_55 = 'kfw_55'
kfw_70 = 'kfw_70'
kfw_85 = 'kfw_85'
tabula_de_adv_retrofit = 'tabula_de_adv_retrofit'
tabula_de_retrofit = 'tabula_de_retrofit'
tabula_de_standard = 'tabula_de_standard'
tabula_dk_adv_retrofit = 'tabula_dk_adv_retrofit'
tabula_dk_retrofit = 'tabula_dk_retrofit'
tabula_dk_standard = 'tabula_dk_standard'
class teaser.data.utilities.GeometryData(value)[source]

Bases: Enum

The GeometryData enumeration replaces the former parameter “usage” and represents different archetypes of residential and non-residential buildings.

BmvbsInstitute = 'bmvbs_institute'
BmvbsInstitute4 = 'bmvbs_institute4'
BmvbsInstitute8 = 'bmvbs_institute8'
BmvbsOffice = 'bmvbs_office'
IwuSingleFamilyDwelling = 'iwu_single_family_dwelling'
TabulaDeApartmentBlock = 'tabula_de_apartment_block'
TabulaDeMultiFamilyHouse = 'tabula_de_multi_family_house'
TabulaDeSingleFamilyHouse = 'tabula_de_single_family_house'
TabulaDeTerracedHouse = 'tabula_de_terraced_house'
TabulaDkApartmentBlock = 'tabula_dk_apartment_block'
TabulaDkSingleFamilyHouse = 'tabula_dk_single_family_house'
TabulaDkTerracedHouse = 'tabula_dk_terraced_house'
UrbanrenetEst1a = 'urbanrenet_est1a'
UrbanrenetEst1b = 'urbanrenet_est1b'
UrbanrenetEst2 = 'urbanrenet_est2'
UrbanrenetEst3 = 'urbanrenet_est3'
UrbanrenetEst4a = 'urbanrenet_est4a'
UrbanrenetEst4b = 'urbanrenet_est4b'
UrbanrenetEst5 = 'urbanrenet_est5'
UrbanrenetEst6 = 'urbanrenet_est6'
UrbanrenetEst7 = 'urbanrenet_est7'
UrbanrenetEst8a = 'urbanrenet_est8a'
UrbanrenetEst8b = 'urbanrenet_est8b'
teaser.data.utilities.check_construction_data_setter_iwu(value)[source]

This function validates and sets the construction_data for buildings using the iwu construction_data.

teaser.data.utilities.check_construction_data_setter_tabula_de(value)[source]

This function validates and sets the construction_data for buildings using the tabula_de construction_data.

teaser.data.utilities.check_construction_data_setter_tabula_dk(value)[source]

This function validates and sets the construction_data for buildings using the tabula_dk construction_data.