dragonfly_energy.properties.context module

Context Shade Energy Properties.

class dragonfly_energy.properties.context.ContextShadeEnergyProperties(host_shade, construction=None, transmittance_schedule=None)

Bases: object

Energy Properties for Dragonfly ContextShade.

Parameters:

• host_shade – A dragonfly_core ContextShade object that hosts these properties.

• construction – An optional ShadeConstruction object to set the reflectance and specularity of the ContextShade. 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_by_user

ToString()

apply_properties_from_dict(abridged_data, constructions, schedules)

Apply properties from a ContextShadeEnergyPropertiesAbridged dictionary.

Parameters:

• abridged_data – A ContextShadeEnergyPropertiesAbridged 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)

Get a copy of this object.

new_host: A new ContextShade object that hosts these properties.

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

classmethod from_dict(data, host)

Create ContextShadeEnergyProperties from a dictionary.

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

Parameters:

• data – A dictionary representation of ContextShadeEnergyProperties.

• host – A ContextShade object that hosts these properties.

from_honeybee(hb_properties)

Transfer energy attributes from a Honeybee Shade to Dragonfly ContextShade.

Parameters:

hb_properties – The ShadeEnergyProperties of the honeybee Shade that is being translated to a Dragonfly ContextShade.

to_dict(abridged=False)

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.

to_honeybee(new_host)

Get a honeybee version of this object.

Parameters:

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

property construction

Get or set a ShadeConstruction for the context shade.

property host

Get the Shade object hosting these properties.

property is_construction_set_by_user

Boolean noting if construction is user-set.

property transmittance_schedule

Get or set the transmittance schedule of the shade.