project - teaser API

This module includes the Project class, which serves as base class and API

class teaser.project.Project(load_data=True)

Bases: object

Base class for each project, serves also as API

The Project class is the root class for each action in TEASER and should be instantiated only once for each project. It also contains all API function to use main functionality of TEASER4

Parameters:

load_data : boolean

boolean if data bindings for type elements and use conditions should be loaded (default = True)

Attributes

buildings	(list) list of all buildings in one project, instances of Building()
data	(list) instance of Data containing the XML binding classes, instance of DataClass()
modelica_project	(str) name of the Modelica Project used in type building creation (default: self.name)
weather_file_path	(str) path to weather file used for Modelica simulation (default: “TRY_5_Essen.txt”)
number_of_elements_calc	(int) defines the number of elements, that area aggregated, between 1 and 4, default is 2
merge_windows_calc	(bool) True for merging the windows into the outer walls, False for separate resistance for window, default is False
used_library_calc	(str) used library (AixLib and Annex60 are supported)

Methods

calc_all_buildings(raise_errors=False)

Calculates values for all project buildings

You need to set the following parameters in the Project class.

number_of_elements_calc : int

defines the number of elements, that area aggregated, between 1 and 4, default is 2 For AixLib you should always use 2 elements!!!

merge_windows_calc : bool

True for merging the windows into the outer walls, False for separate resistance for window, default is False For AixLib vdi calculation is True, ebc calculation is False

used_library_calc : str

used library (AixLib and Annex60 are supported)

export_aixlib(building_model='None', zone_model='None', corG=None, internal_id=None, path=None)

Exports values to a record file for Modelica simulation

Parameters:

building_model : string

setter of the used Aixlib building model (None, MultizoneEquipped, Multizone)

zone_model : string

setter of the used Aixlib zone model (ThermalZoneEquipped, ThermalZone)

corG : boolean

setter of the used g value calculation in the model

internal_id : float

setter of the used building which will be exported, if None then all buildings will be exported

path : string

if the Files should not be stored in OutputData, an alternative path can be specified as a full and absolute path

export_annex(internal_id=None, path=None)

Exports values to a record file for Modelica simulation

Parameters:

internal_id : float

setter of the used building which will be exported, if None then all buildings will be exported

path : string

if the Files should not be stored in OutputData, an alternative path can be specified as a full and absolute path

export_parameters_txt(path=None)

Exports parameters of all buildings in a readable text file

Parameters:

path : string

if the Files should not be stored in OutputData, an alternative can be specified

instantiate_data_class()

Initialization of DataClass

Returns:DataClass : Instance of DataClass()

load_citygml(path=None)

Loads buildings from a citygml file

calls the function load_gml in data.CityGML we make use of CityGML core and possibly not all kinds of CityGML modelling techniques are supported.

If the fucntion of the building is given as Residential (1000) or Office (1120) the importer directly converts the building to archetype buildings. If not only the citygml geometry is imported and you need take care of either the material properties and zoning or you may use the _convert_bldg fucntion in citygml_input module.

Parameters:

path : string

full path to a CityGML file

load_project(path)

Loads the project from a teaserXML file (new format)

calls the function load_teaser_xml in data.TeaserXML.py

Parameters:

path : string

full path to a teaserXML file

retrofit_all_buildings(year_of_retrofit, window_type=None, material=None)

Retrofits all buildings in the project

All Buildings in the project are retrofitted in the following manner:

• replace all windows of the building to retrofitted window according to the year of retrofit.
• add an additional insulation layer to all outer walls (including roof, and ground floor). The thickness of the insulation layer is calculated that the U-Value of the wall corresponds to the retrofit standard of the year of retrofit.

The needed parameters for the Modelica Model are calculated automatically, using the calculation_method specified in the first scenario.

Note: To Calculate U-Value, the standard TEASER coefficients for outer and inner heat transfer are used.

Parameters:

year_of_retrofit : int

the year the buildings are retrofitted

window_type : str

Default: EnEv 2014

material : str

Default: EPS035

save_citygml(file_name=None, path=None)

Saves the project to a citygml file

calls the function save_gml in data.CityGML we make use of CityGML core and EnergyADE to store semantic information

Parameters:

file_name : string

name of the new file

path : string

if the Files should not be stored in OutputData, an alternative can be specified

save_project(file_name=None, path=None)

Saves the project to a tXML file

calls the function save_teaser_xml in data.TeaserXML.py

Parameters:

file_name : string

name of the new file

path : string

if the Files should not be stored in OutputData, an alternative can be specified

set_default()

sets all attributes except self.data to default

type_bldg_est1a(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=False, neighbour_buildings=None, construction_type=None)

Create and calculate an est1a building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

neighbour_buildings : int

neighbour (default = 0)

0: no neighbour 1: one neighbour 2: two neighbours

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of EST1a()

type_bldg_est1b(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=False, neighbour_buildings=None, construction_type=None, number_of_apartments=None)

Create and calculate an est1a building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

neighbour_buildings : int

neighbour (default = 0)

0: no neighbour 1: one neighbour 2: two neighbours

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of EST1a()

type_bldg_est4b(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=False, neighbour_buildings=None, construction_type=None, number_of_apartments=None)

Create and calculate an est1a building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

neighbour_buildings : int

neighbour (default = 0)

0: no neighbour 1: one neighbour 2: two neighbours

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of EST1a()

type_bldg_est7(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=False, neighbour_buildings=None, construction_type=None, number_of_apartments=None)

Create and calculate an est1a building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

neighbour_buildings : int

neighbour (default = 0)

0: no neighbour 1: one neighbour 2: two neighbours

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of EST1a()

type_bldg_institute(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=True, office_layout=None, window_layout=None, construction_type=None)

Create and calculate an institute building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

office_layout : int

type of floor plan (default = 0)

0: use default values 1: elongated 1 floor 2: elongated 2 floors 3: compact

window_layout : int

type of window layout (default = 0)

0: use default values 1: punctuated facade 2: banner facade 3: full glazing

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of Institute()

type_bldg_institute4(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=True, office_layout=None, window_layout=None, construction_type=None)

Create and calculate an institute4 building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

office_layout : int

type of floor plan (default = 0)

0: use default values 1: elongated 1 floor 2: elongated 2 floors 3: compact

window_layout : int

type of window layout (default = 0)

0: use default values 1: punctuated facade 2: banner facade 3: full glazing

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of Institute4()

type_bldg_institute8(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=True, office_layout=None, window_layout=None, construction_type=None)

Create and calculate an institute8 building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

office_layout : int

type of floor plan (default = 0)

0: use default values 1: elongated 1 floor 2: elongated 2 floors 3: compact

window_layout : int

type of window layout (default = 0)

0: use default values 1: punctuated facade 2: banner facade 3: full glazing

construction_type : str (default = “heavy”)

construction type

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of Institute8()

type_bldg_office(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=True, office_layout=None, window_layout=None, construction_type=None)

Create and calculate an office building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

office_layout : int

type of floor plan (default = 0)

0: use default values 1: elongated 1 floor 2: elongated 2 floors 3: compact

window_layout : int

type of window layout (default = 0)

0: use default values 1: punctuated facade 2: banner facade 3: full glazing

construction_type : str

construction type (default = “heavy”)

heavy: heavy construction light: light construction

Returns:

type_bldg : Instance of Office()

type_bldg_residential(name, year_of_construction, number_of_floors, height_of_floors, net_leased_area, with_ahu=False, residential_layout=None, neighbour_buildings=None, attic=None, cellar=None, dormer=None, construction_type=None)

Create and calculate an residential building

Parameters:

name : str

individual name

year_of_construction : int

year of first construction

number_of_floors : int

number of floors above ground

height_of_floors : float

average height of the floors

net_leased_area : float

total net leased area of building

with_ahu : boolean

if building has a central AHU or not

residential_layout : int

type of floor plan (default = 0)

0: compact 1: elongated/complex

neighbour_buildings : int

neighbour (default = 0)

0: no neighbour 1: one neighbour 2: two neighbours

attic : int

type of attic (default = 0)

0: flat roof 1: non heated attic 2: partly heated attic 3: heated attic

cellar : int

type of cellar (default = 0)

0: no cellar 1: non heated cellar 2: partly heated cellar 3: heated cellar

construction_type : str

construction type (default = “heavy”)

heavy: heavy construction light: light construction

dormer : str

construction type

0: no dormer 1: dormer

Returns:

type_bldg : Instance of SingleFamilyDwelling()