honeybee_energy.properties.shade module

Shade Energy Properties.

class honeybee_energy.properties.shade.ShadeEnergyProperties(host_shade, construction=None, transmittance_schedule=None)[source]

Bases: object

Energy Properties for Honeybee Shade.

Parameters
  • host_shade – A honeybee_core Shade object that hosts these properties.

  • construction – An optional ShadeConstruction object to set the reflectance and specularity of the Shade. The default is set by a ConstructionSet if the shade is the parent to an object. Otherwise, if it is an orphaned shade, the default is a completely diffuse construction with 0.2 visible and solar reflectance.

  • transmittance_schedule – An optional schedule to set the transmittance of the shade, which can vary throughout the day or year. Default is a completely opaque object.

Properties:
  • host

  • construction

  • transmittance_schedule

  • is_construction_set_on_object

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

Apply properties from a ShadeEnergyPropertiesAbridged dictionary.

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

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

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

duplicate(new_host=None)[source]

Get a copy of this object.

Parameters

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

classmethod from_dict(data, host)[source]

Create ShadeEnergyProperties from a dictionary.

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

Parameters
  • data – A dictionary representation of ShadeEnergyProperties with the format below.

  • host – A Shade object that hosts these properties.

{
"type": 'ShadeEnergyProperties',
"construction": {},  # A ShadeConstruction dictionary
"transmittance_schedule": {}  # A transmittance schedule dictionary
}
radiance_modifier_solar()[source]

Get a Radiance modifier that combines the construction and transmittance.

Note that only the first value from the transmittance schedule will be used to create the Trans modifier and so this method is really only intended for cases of constant transmittance schedules. If there is no transmittance schedule, a plastic material will be returned.

radiance_modifier_visible()[source]

Get a Radiance modifier that combines the construction and transmittance.

Note that only the first value from the transmittance schedule will be used to create the Trans modifier and so this method is really only intended for cases of constant transmittance schedules. If there is no transmittance schedule, a plastic material will be returned.

reset_to_default()[source]

Reset the construction and transmittance schedule of this Shade to default.

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 a ShadeConstruction for the shade.

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

property host

Get the Shade object hosting these properties.

property is_construction_set_on_object

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

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

property transmittance_schedule

Get or set the transmittance schedule of the shade.