honeybee_energy.properties.aperture module

Aperture Energy Properties.

class honeybee_energy.properties.aperture.ApertureEnergyProperties(host, construction=None, vent_opening=None)[source]

Bases: object

Energy Properties for Honeybee Aperture.

Parameters
  • host – A honeybee_core Aperture object that hosts these properties.

  • construction – An optional Honeybee WindowConstruction or WindowConstructionShade object for the aperture. If None, it will be set by the parent Room ConstructionSet or the the Honeybee default generic ConstructionSet.

  • vent_opening – An optional VentilationOpening to specify the operable portion of the Aperture. (Default: None).

Properties:
  • host

  • construction

  • vent_opening

  • is_construction_set_on_object

ToString()[source]
apply_properties_from_dict(abridged_data, constructions)[source]

Apply properties from a ApertureEnergyPropertiesAbridged dictionary.

Parameters
  • abridged_data – A ApertureEnergyPropertiesAbridged dictionary (typically coming from a Model).

  • constructions – A dictionary of constructions with constructions identifiers as keys, which will be used to re-assign constructions.

duplicate(new_host=None)[source]

Get a copy of this object.

new_host: A new Aperture object that hosts these properties.

If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]

Create ApertureEnergyProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters
  • data – A dictionary representation of ApertureEnergyProperties in the format below.

  • host – A Aperture object that hosts these properties.

{
"type": 'ApertureEnergyProperties',
"construction": {},  # WindowConstruction or WindowConstructionShade dict
"vent_opening": {}  # VentilationOpening dict
}
reset_to_default()[source]

Reset a construction assigned at the level of this Aperture to the default.

This means the Aperture’s construction will be assigned by a ConstructionSet.

to_dict(abridged=False)[source]

Return energy properties as a dictionary.

Parameters

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.

property construction

Get or set Aperture Construction.

If the Construction is not set on the aperture-level, then it will be assigned based on the ConstructionSet assigned to the parent Room. If there is no parent Room or the parent Room’s ConstructionSet has no construction for the aperture, it will be assigned using the honeybee default generic construction set.

property host

Get the Aperture object hosting these properties.

property is_construction_set_on_object

Boolean noting if construction is assigned on the level of this Aperture.

This is opposed to having the construction assigned by a ConstructionSet.

property vent_opening

Get or set a VentilationOpening object to specify the operable portion.