teaser.data.output package

Submodules

teaser.data.output.aixlib_output module

This module contains function for AixLib model generation

teaser.data.output.aixlib_output.export_multizone(buildings, prj, path=None)

Exports models for AixLib library

Exports a building for AixLib.ThermalZones.ReducedOrder.Multizone.MultizoneEquipped models using the ThermalZoneEquipped and supporting models, like tables and weather model. Depending on chosen calculation method the parameter set to 1,2, 3 or 4 element model. By default it uses the correction for solar glazing (corG) and decoupled heat conduction through windows ( merge_windows=False). In contrast to versions < 0.5 TEASER now does not support any other model options, as we observed no need, since single ThermalZones are identical with IBPSA models. If you miss one of the old options please contact us.

This function uses Mako Templates specified in data.output.modelicatemplates.AixLib

Parameters

buildingslist of instances of Building

list of TEASER instances of a Building that is exported to a AixLib MultizoneEquipped models. If you want to export a single building, please pass it over as a list containing only that building.

prjinstance of Project

Instance of TEASER Project object to access Project related information, e.g. name or version of used libraries

pathstring

if the Files should not be stored in default output path of TEASER, an alternative path can be specified as a full path

Attributes

lookupTemplateLookup object

Instance of mako.TemplateLookup to store general functions for templates

zone_template_1Template object

Template for ThermalZoneRecord using 1 element model

zone_template_2Template object

Template for ThermalZoneRecord using 2 element model

zone_template_3Template object

Template for ThermalZoneRecord using 3 element model

zone_template_4Template object

Template for ThermalZoneRecord using 4 element model

model_templateTemplate object

Template for MultiZone model

teaser.data.output.buildingelement_output module

This module contains function to save building element classes.

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

Delete typical element in json.

Deletes typical building elements according to their construction year and their construction type in the the json file for type building 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

elementBuildingElement()

Instance of BuildingElement or inherited Element of TEASER

data_classDataClass()

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)

Save information about building element to json.

Saves typical building elements according to their construction year and their construction type in the json file for type building 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

elementBuildingElement()

Instance of BuildingElement or inherited Element of TEASER

data_classDataClass()

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.ibpsa_output module

ibpsa_output

This module contains function to call Templates for IBPSA model generation

teaser.data.output.ibpsa_output.export_ibpsa(buildings, prj, path=None, library='AixLib')

Exports models for IBPSA library

Export a building to several models for IBPSA.ThermalZones.ReducedOrder. Depending on the chosen calculation method models for 1, 2, 3, or 4 element model are exported. In addition you can specify if windows should be lumped into the walls, like it is done in VDI 6007 (merge_windows=True) or not. For each zone, one model is exported, if you want to combine all thermal zones into one model, consider using AixLib. The export includes internal gains from use conditions ( calculated in teaser.logic.calculation.ibpsa) but does not include any heating or cooling equipment.

Parameters

buildingslist of instances of Building

list of TEASER instances of a Building that are exported If you want to export a single building, please pass it over as a list containing only that building.

prjinstance of Project

Instance of TEASER Project object to access Project related information, e.g. name or version of used libraries

pathstring

if the Files should not be stored in default output path of TEASER, an alternative path can be specified as a full path

librarystr

Used library within the framework of IBPSA library. The models are identical in each library, but IBPSA Modelica library is just a core set of models and should not be used standalone. Valid values are ‘AixLib’ (default), ‘Buildings’, ‘BuildingSystems’ and ‘IDEAS’.

Attributes

lookupTemplateLookup object

Instance of mako.TemplateLookup to store general functions for templates

model_template_1Template object

Template for ThermalZoneRecord using 1 element model

model_template_2Template object

Template for ThermalZoneRecord using 2 element model

model_template_3Template object

Template for ThermalZoneRecord using 3 element model

model_template_4Template object

Template for ThermalZoneRecord using 4 element model

teaser.data.output.material_output module

This module contains function to save material classes.

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

Material saver.

Saves material and their properties the JSON file for type building 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 with Materials. If this file does not exist, a new file is created.

Parameters

materialMaterial()

instance of TEASERS Material class

data_classDataClass()

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.runUnitTests module

teaser.data.output.teaserjson_output module

Saves alls Project data into a json.

teaser.data.output.teaserjson_output.save_teaser_json(path, project)

Save a project to a JSON file.

The function needs to be written.

Parameters

path: string

complete path to the output file

project: Project()

Teaser instance of Project()

teaser.data.output.teaserjson_output.set_basic_data(wall_out, element)

Set basic data of building elements.

Parameters

wall_outcollection.OrderedDict

OrderedDict for walls

elementTEASERClass

teaser class representation of a building element

teaser.data.output.teaserjson_output.set_layer_data(wall_out, element)

Set layer data of building element.

Parameters

wall_outcollection.OrderedDict

OrderedDict for walls

elementTEASERClass

teaser class representation of a building element

teaser.data.output.usecond_output module

This module contains function to save UseConditions classes.

teaser.data.output.usecond_output.save_use_conditions(use_cond, data_class)

Use conditions saver.

Saves use conditions according to their usage type in the the JSON 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_condUseCondtiions()

Instance of TEASERs BuildingObjects.UseCondtiions

data_classDataClass()

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