honeybee_energy.constructionset module

Energy Construction Set.

class honeybee_energy.constructionset.ApertureConstructionSet(window_construction=None, interior_construction=None, skylight_construction=None, operable_construction=None)[source]

Bases: object

Set containing all constructions needed to for an energy model’s Apertures.

Parameters

  • window_construction – A WindowConstruction object for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.

  • interior_construction – A WindowConstruction object for all apertures with a Surface boundary condition.

  • skylight_construction – : A WindowConstruction object for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

  • operable_construction – A WindowConstruction object for all apertures with an Outdoors boundary condition and True is_operable property.

Properties:

  • window_construction

  • interior_construction

  • skylight_construction

  • operable_construction

  • constructions

  • modified_constructions

  • is_modified

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this set.

classmethod from_dict(data)[source]

Create a ApertureConstructionSet from a dictionary.

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

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)[source]

Get ApertureConstructionSet as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property constructions

List of all constructions contained within the set.

property interior_construction

Get or set the WindowConstruction for all interior apertures.

property is_modified

Boolean noting whether any constructions are modified from the default.

property modified_constructions

List of all constructions that are not defaulted within the set.

property operable_construction

Get or set the WindowConstruction for all exterior operable windows.

property skylight_construction

Get or set the WindowConstruction for exterior fixed windows in roofs.

property window_construction

Get or set the WindowConstruction for exterior fixed windows in walls.

class honeybee_energy.constructionset.ConstructionSet(identifier, wall_set=None, floor_set=None, roof_ceiling_set=None, aperture_set=None, door_set=None, shade_construction=None, air_boundary_construction=None)[source]

Bases: object

Set containing all energy constructions needed to create an energy model.

Parameters

  • identifier – Text string for a unique ConstructionSet ID. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

  • wall_set – An optional WallConstructionSet object for this ConstructionSet. If None, it will be the honeybee generic default WallConstructionSet.

  • floor_set – An optional FloorConstructionSet object for this ConstructionSet. If None, it will be the honeybee generic default FloorConstructionSet.

  • roof_ceiling_set – An optional RoofCeilingConstructionSet object for this ConstructionSet. If None, it will be the honeybee generic default RoofCeilingConstructionSet.

  • aperture_set – An optional ApertureConstructionSet object for this ConstructionSet. If None, it will be the honeybee generic default ApertureConstructionSet.

  • door_set – An optional DoorConstructionSet object for this ConstructionSet. If None, it will be the honeybee generic default DoorConstructionSet.

  • shade_construction – An optional ShadeConstruction to set the reflectance properties of all outdoor shades to which this ConstructionSet is assigned. If None, it will be the honeybee generic shade construction.

  • air_boundary_construction – An optional AirBoundaryConstruction or OpaqueConstruction to set the properties of Faces with an AirBoundary type. If None, it will be the honeybee generic air boundary construction.

Properties:

  • identifier

  • display_name

  • wall_set

  • floor_set

  • roof_ceiling_set

  • aperture_set

  • door_set

  • shade_construction

  • air_boundary_construction

  • constructions

  • modified_constructions

  • constructions_unique

  • modified_constructions_unique

  • materials_unique

  • modified_materials_unique

  • user_data

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this ConstructionSet.

classmethod from_dict(data)[source]

Create a ConstructionSet from a dictionary.

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

Parameters

data – Dictionary describing the ConstructionSet with the format below.

{
"type": 'ConstructionSet',
"identifier": str,  # ConstructionSet identifier
"display_name": str,  # ConstructionSet display name
"wall_set": {},  # A WallConstructionSet dictionary
"floor_set": {},  # A FloorConstructionSet dictionary
"roof_ceiling_set": {},  # A RoofCeilingConstructionSet dictionary
"aperture_set": {},  # A ApertureConstructionSet dictionary
"door_set": {},  # A DoorConstructionSet dictionary
"shade_construction": {},  # ShadeConstruction dictionary
"air_boundary_construction": {},  # AirBoundaryConstruction dictionary
}
classmethod from_dict_abridged(data, construction_dict)[source]

Create a ConstructionSet from an abridged dictionary.

Parameters

  • data – A ConstructionSetAbridged dictionary.

  • construction_dict – A dictionary with construction identifiers as keys and honeybee construction objects as values. These will be used to assign the constructions to the ConstructionSet object.

{
"type": 'ConstructionSetAbridged',
"identifier": str,  # ConstructionSet identifier
"display_name": str,  # ConstructionSet display name
"wall_set": {},  # A WallConstructionSetAbridged dictionary
"floor_set": {},  # A FloorConstructionSetAbridged dictionary
"roof_ceiling_set": {},  # A RoofCeilingConstructionSetAbridged dictionary
"aperture_set": {},  # A ApertureConstructionSetAbridged dictionary
"door_set": {},  # A DoorConstructionSetAbridged dictionary
"shade_construction": str,  # ShadeConstruction identifier
"air_boundary_construction": str  # AirBoundaryConstruction identifier
}
get_aperture_construction(boundary_condition, is_operable, parent_face_type)[source]

Get a construction object that will be assigned to a given type of aperture.

Parameters

  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’)

  • is_operable – Boolean to note whether the aperture is operable.

  • parent_face_type – Text string for the type of face to which the aperture is a child (eg. ‘Wall’, ‘Floor’, ‘Roof’).

get_door_construction(boundary_condition, is_glass, parent_face_type)[source]

Get a construction object that will be assigned to a given type of door.

Parameters

  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’)

  • is_glass – Boolean to note whether the door is glass (instead of opaque).

  • parent_face_type – Text string for the type of face to which the door is a child (eg. ‘Wall’, ‘Floor’, ‘Roof’).

get_face_construction(face_type, boundary_condition)[source]

Get a construction object that will be assigned to a given type of face.

Parameters

  • face_type – Text string for the type of face (eg. ‘Wall’, ‘Floor’, ‘Roof’, ‘AirBoundary’).

  • boundary_condition – Text string for the boundary condition (eg. ‘Outdoors’, ‘Surface’, ‘Adiabatic’, ‘Ground’)

lock()[source]

The lock() method to will also lock the WallConstructionSet, etc.

to_dict(abridged=False, none_for_defaults=True)[source]

Get ConstructionSet as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

to_radiance_solar_exterior()[source]

Honeybee Radiance modifier set for the exterior solar properties.

to_radiance_solar_interior()[source]

Honeybee Radiance modifier set for the interior solar properties.

to_radiance_visible_exterior()[source]

Honeybee Radiance modifier set for the exterior visible properties.

to_radiance_visible_interior()[source]

Honeybee Radiance modifier set for the interior visible properties.

unlock()[source]

The unlock() method will also unlock the WallConstructionSet, etc.

property air_boundary_construction

Get or set the AirBoundaryConstruction assigned to this ConstructionSet.

property aperture_set

Get or set the ApertureConstructionSet assigned to this ConstructionSet.

property constructions

List of all constructions contained within the set.

property constructions_unique

List of all unique constructions contained within the set.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property door_set

Get or set the DoorConstructionSet assigned to this ConstructionSet.

property floor_set

Get or set the FloorConstructionSet assigned to this ConstructionSet.

property identifier

Get or set a text string for a unique construction set identifier.

property materials_unique

List of all unique materials contained within the set.

property modified_constructions

List of all constructions that are not defaulted within the set.

property modified_constructions_unique

List of all unique constructions that are not defaulted within the set.

property modified_materials_unique

List of all unique materials that are not defaulted within the set.

property roof_ceiling_set

Get or set the RoofCeilingConstructionSet assigned to this ConstructionSet.

property shade_construction

Get or set the ShadeConstruction assigned to this ConstructionSet.

property user_data

Get or set an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)

property wall_set

Get or set the WallConstructionSet assigned to this ConstructionSet.

class honeybee_energy.constructionset.DoorConstructionSet(exterior_construction=None, interior_construction=None, exterior_glass_construction=None, interior_glass_construction=None, overhead_construction=None)[source]

Bases: object

Set containing all energy constructions needed to for an energy model’s Roofs.

Parameters

  • exterior_construction – An OpaqueConstruction object for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.

  • interior_construction – An OpaqueConstruction object for all opaque doors with a Surface boundary condition.

  • exterior_glass_construction – A WindowConstruction object for all glass doors with an Outdoors boundary condition.

  • interior_glass_construction – A WindowConstruction object for all glass doors with a Surface boundary condition.

  • overhead_construction – An OpaqueConstruction object for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

Properties:

  • exterior_construction

  • interior_construction

  • exterior_glass_construction

  • interior_glass_construction

  • overhead_construction

  • constructions

  • modified_constructions

  • is_modified

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this set.

classmethod from_dict(data)[source]

Create a DoorConstructionSet from a dictionary.

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

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)[source]

Get the DoorConstructionSet as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property constructions

List of all constructions contained within the set.

property exterior_construction

Get or set the OpaqueConstruction for exterior opaque doors in walls.

property exterior_glass_construction

Get or set the WindowConstruction for exterior glass doors.

property interior_construction

Get or set the OpaqueConstruction for all interior opaque doors.

property interior_glass_construction

Get or set the WindowConstruction for all interior glass doors.

property is_modified

Boolean noting whether any constructions are modified from the default.

property modified_constructions

List of all constructions that are not defaulted within the set.

property overhead_construction

Get or set the OpaqueConstruction for exterior opaque doors in roofs/floors.

class honeybee_energy.constructionset.FloorConstructionSet(exterior_construction=None, interior_construction=None, ground_construction=None)[source]

Bases: _FaceSetBase

Set containing all energy constructions needed to for an energy model’s Floors.

Properties:

  • exterior_construction

  • interior_construction

  • ground_construction

  • constructions

  • modified_constructions

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

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

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the Set as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property constructions

List of all constructions contained within the set.

property exterior_construction

Get or set the OpaqueConstruction for exterior-exposed floors.

property ground_construction

Get or set the OpaqueConstruction for ground-contact floor slabs.

property interior_construction

Get or set the OpaqueConstruction for interior floors.

property is_modified

Boolean noting whether any constructions are modified from the default.

property modified_constructions

List of all constructions that are not defaulted within the set.

class honeybee_energy.constructionset.RoofCeilingConstructionSet(exterior_construction=None, interior_construction=None, ground_construction=None)[source]

Bases: _FaceSetBase

Set containing all energy constructions needed to for an energy model’s Roofs.

Properties:

  • exterior_construction

  • interior_construction

  • ground_construction

  • constructions

  • modified_constructions

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

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

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the Set as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property constructions

List of all constructions contained within the set.

property exterior_construction

Get or set the OpaqueConstruction for exterior roofs.

property ground_construction

Get or set the OpaqueConstruction for underground roofs.

property interior_construction

Get or set the OpaqueConstruction for interior ceilings.

property is_modified

Boolean noting whether any constructions are modified from the default.

property modified_constructions

List of all constructions that are not defaulted within the set.

class honeybee_energy.constructionset.WallConstructionSet(exterior_construction=None, interior_construction=None, ground_construction=None)[source]

Bases: _FaceSetBase

Set containing all energy constructions needed to for an energy model’s Walls.

Properties:

  • exterior_construction

  • interior_construction

  • ground_construction

  • constructions

  • modified_constructions

  • is_modified

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this set.

classmethod from_dict(data)

Create a SubSet from a dictionary.

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

Parameters

data – Dictionary describing the Set of the object.

lock()
to_dict(abridged=False, none_for_defaults=True)

Get the Set as a dictionary.

Parameters

  • abridged – Boolean noting whether detailed materials and construction objects should be written into the ConstructionSet (False) or just an abridged version (True). Default: False.

  • none_for_defaults – Boolean to note whether default constructions in the set should be included in detail (False) or should be None (True). Default: True.

unlock()
property constructions

List of all constructions contained within the set.

property exterior_construction

Get or set the OpaqueConstruction for exterior walls.

property ground_construction

Get or set the OpaqueConstruction for underground walls.

property interior_construction

Get or set the OpaqueConstruction for interior walls.

property is_modified

Boolean noting whether any constructions are modified from the default.

property modified_constructions

List of all constructions that are not defaulted within the set.