output

The output package holds python modules, files and folders needed for export out of teaser.

ModelicaTemplate folder

This folder holds a collection of Modelica model templates. Currently we support the MultiZoneBuilding of AixLib, including boundary conditions and an optional central air handlingunit. Further the given examples of Annex library are supported, which can be then used for own purposes.

TextTemplate folder

This folder holds one template for the output of model parameters in a text file. Currently only the two element model is supported, but more are to come.

aixlib_export

aixlib_output

This module contains function to call Templates for AixLib model generation

teaser.data.output.aixlib_output.export_aixlib(prj, number_of_elements=2, building_model='None', zone_model='None', corG=None, internal_id=None, path=None)

Exports values to a record file for Modelica simulation

The Export function for creating a AixLib LOM Multizone model

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

annex60_export

annex60_output

This module contains function to call Templates for Annex60 model generation

teaser.data.output.annex60_output.export_annex60(prj, number_of_elements=2, merge_windows=False, internal_id=None, path=None)

Exports values to a record file for Annex60 simulation

The Export function for creating a Annex60 example model

Parameters:

number_of_elements : int

defines the number of elements, that area aggregated, between 1 and 4, default is 2

merge_windows : bool

True for merging the windows into the outer walls, False for separate resistance for window, default is False

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

TeaserXML_output

TeaserXML_output

This module contains function to save Projects in the proprietary TEASER file format .tXML

teaser.data.output.teaserxml_output.save_teaser_xml(path, project)

This function saves a project to a tXML

The function needs the Python Package PyXB.

Parameters:

path: string

complete path to the output file

project: Project()

Teaser instance of Project()

teaser.data.output.teaserxml_output.set_basic_data_pyxb(pyxb_class, element)

Helper function for save_teaser_xml to set the basic data

Parameters:

pyxb_class : PyXBClass

pyxb class represantation of xml

element : TEASERClass

teaser class representation of a building element

teaser.data.output.teaserxml_output.set_layer_data_pyxb(pyxb_class, element)

Helper function for save_teaser_xml to set the layer data

Parameters:

pyxb_class : PyXBClass

pyxb class represantation of xml

element : TEASERClass

teaser class representation of a building element

CityGML_output

CityGML

This module contains function to save and load Projects in the non proprietary CityGML file format .gml

teaser.data.output.citygml_output.save_gml(project, path, ref_coordinates=None)

This function saves a project to a cityGML file

The function needs the Python Package PyXB. And the opengis bundle for GML and CityGML.

Parameters:

project: Project()

Teaser instance of Project()

path: string

complete path to the output file

ref_coordinates: list

list with lower and one upper reference coordinates. Each coordiante should contain 3 ints or floats for x, y, and z coordinates of the point. e.g: [[458877,,5438353, -0.2], [458889,5438363,6.317669]]

teaser.data.output.citygml_output.set_reference_boundary(gml_out, lower_coords, upper_coords)

Adds a reference coordinate system with Envelope‘s corners

The gml file includes a reference coordinate system defined in the boundedBy object, within which the Envelope object contains both a lowerCorner and an upperCorner. Both corners extend gml.DirectPositionType. This method sets all necessary parts of the boundedBy in a given gml file.

Parameters:

gml_out : citygml.CityModel() object

A CityModel object, where citygml is a reference to pyxb.bundles.opengis.citygml.base. The reference coordinate system will be added to this object.

lower_coords : list

A list that contains the coordinates of the point for the lowerCorner definition. It should contain 3 ints or floats for x, y, and z coordinates of the point.

upper_coords : list

A list that contains the coordinates of the point for the upperCorner definition. It should contain 3 ints or floats for x, y, and z coordinates of the point.

Returns:

gml_out : citygml.CityModel() object

Returns the modified CityModel object

Text_output

Text_output

This module contains function to call Templates for textual output

teaser.data.output.text_output.export_parameters_txt(prj, path)

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

boundcond_output

boundcond_output.py

This module contains function to save boundary conditions classes

teaser.data.output.boundcond_output.save_bound_conditions(bound_cond, data_class)

Use conditions saver.

Saves use conditions according to their usage type in the the XML file for use conditions in InputData. If the Project parent is set, it automatically saves it to the file given in Project.data. Alternatively you can specify a path to a file of UseConditions. If this file does not exist, a new file is created.

Parameters:

bound_cond : BoundaryConditions()

Instance of TEASERs BuildingObjects.BoundaryConditions.BoundaryConditions

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.ile

buildingelement_output

buildingelement_ouput.py

This module contains function to save building element classes

teaser.data.output.buildingelement_output.delete_type_element(element, data_class)

Deletes typical element.

Deletes typical building elements according to their construction year and their construction type in the the XML file for type buidling elements. If the Project parent is set, it automatically saves it to the file given in Project.data. Alternatively you can specify a path to a file of TypeBuildingElements. If this file does not exist, a new file is created.

Parameters:

element : BuildingElement()

Instance of BuildingElement or inherited Element of TEASER

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.

teaser.data.output.buildingelement_output.save_type_element(element, data_class)

Typical element saver.

Saves typical building elements according to their construction year and their construction type in the the XML file for type buidling elements. If the Project parent is set, it automatically saves it to the file given in Project.data. Alternatively you can specify a path to a file of TypeBuildingElements. If this file does not exist, a new file is created.

Parameters:

element : BuildingElement()

Instance of BuildingElement or inherited Element of TEASER

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.

material_output

material_output.py

This module contains function to save material classes

teaser.data.output.material_output.save_material(material, data_class)

Material saver.

Saves Material specified in the XML.

Parameters:

material : Material()

instance of TEASERS Material class

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.