dragonfly_energy.properties.model module

Model Energy Properties.

class dragonfly_energy.properties.model.ModelEnergyProperties(host)[source]

Bases: object

Energy Properties for Dragonfly Model.

Parameters

host – A dragonfly_core Model object that hosts these properties.

Properties:

  • host

  • materials

  • constructions

  • shade_constructions

  • construction_sets

  • global_construction_set

  • schedule_type_limits

  • schedules

  • shade_schedules

  • program_type_schedules

  • hvac_schedules

  • program_types

  • hvacs

  • shws

ToString()[source]
apply_properties_from_dict(data)[source]

Apply the energy properties of a dictionary to the host Model of this object.

Parameters

data – A dictionary representation of an entire dragonfly-core Model. Note that this dictionary must have ModelEnergyProperties in order for this method to successfully apply the energy properties.

check_all(raise_exception=True)[source]

Check all of the aspects of the Model energy properties.

Parameters

raise_exception – Boolean to note whether a ValueError should be raised if any errors are found. If False, this method will simply return a text string with all errors that were found.

Returns

A text string with all errors that were found. This string will be empty of no errors were found.

check_duplicate_construction_set_identifiers(raise_exception=True, detailed=False)[source]

Check that there are no duplicate ConstructionSet identifiers in the model.

Parameters

  • raise_exception – Boolean to note whether a ValueError should be raised if duplicate identifiers are found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns

A string with the message or a list with a dictionary if detailed is True.

check_duplicate_hvac_identifiers(raise_exception=True, detailed=False)[source]

Check that there are no duplicate HVAC identifiers in the model.

Parameters

  • raise_exception – Boolean to note whether a ValueError should be raised if duplicate identifiers are found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns

A string with the message or a list with a dictionary if detailed is True.

check_duplicate_program_type_identifiers(raise_exception=True, detailed=False)[source]

Check that there are no duplicate ProgramType identifiers in the model.

Parameters

  • raise_exception – Boolean to note whether a ValueError should be raised if duplicate identifiers are found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns

A string with the message or a list with a dictionary if detailed is True.

check_duplicate_shw_identifiers(raise_exception=True, detailed=False)[source]

Check that there are no duplicate SHW identifiers in the model.

Parameters

  • raise_exception – Boolean to note whether a ValueError should be raised if duplicate identifiers are found. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns

A string with the message or a list with a dictionary if detailed is True.

duplicate(new_host=None)[source]

Get a copy of this Model.

Parameters

new_host – A new Model object that hosts these properties. If None, the properties will be duplicated with the same host.

to_dict()[source]

Return Model energy properties as a dictionary.

to_honeybee(new_host)[source]

Get a honeybee version of this object.

Parameters

new_host – A honeybee-core Model object that will host these properties.

property construction_sets

A list of all unique Building-Assigned ConstructionSets in the Model.

Note that this includes ConstructionSets assigned to individual Stories and Room2Ds in the Building.

property constructions

A list of all unique constructions in the model.

This includes materials across all Room2Ds, Stories, and Building ConstructionSets but it does NOT include the Honeybee generic default construction set.

property global_construction_set

The global energy construction set.

This is what is used whenever there is no construction_set assigned to a Room2D, a parent Story, or a parent Building.

property host

Get the Model object hosting these properties.

property hvac_schedules

A list of all unique HVAC-assigned schedules in the model.

property hvacs

A list of all unique HVAC systems in the Model.

property materials

List of all unique materials contained within the model.

This includes materials across all Room2Ds, Stories, and Building ConstructionSets but it does NOT include the Honeybee generic default construction set.

property program_type_schedules

A list of all unique schedules assigned to ProgramTypes in the model.

property program_types

A list of all unique ProgramTypes in the Model.

property schedule_type_limits

List of all unique schedule type limits contained within the model.

This includes schedules across all ContextShades and Room2Ds.

property schedules

A list of all unique schedules in the model.

This includes schedules across all ProgramTypes and ContextShades.

property shade_constructions

A list of all unique constructions assigned to ContextShades in the model.

property shade_schedules

A list of all unique schedules assigned to ContextShades in the model.

property shws

A list of all unique Service Hot Water (SHW) systems in the Model.