honeybee_energy.construction.shade module

Shade Construction.

class honeybee_energy.construction.shade.ShadeConstruction(identifier, solar_reflectance=0.2, visible_reflectance=0.2, is_specular=False)[source]

Bases: object

Construction for Shade objects.

Parameters

  • identifier – Text string for a unique Construction 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.

  • solar_reflectance – A number between 0 and 1 for the solar reflectance of the construction. Default: 0.2.

  • visible_reflectance – A number between 0 and 1 for the visible reflectance of the construction. Default: 0.2.

  • is_specular – A boolean to note whether the reflection off the shade should be diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material. Default: False.

Properties:

  • identifier

  • display_name

  • solar_reflectance

  • visible_reflectance

  • is_specular

  • is_default

  • inside_solar_reflectance

  • inside_visible_reflectance

  • outside_solar_reflectance

  • outside_visible_reflectance

  • user_data

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this construction.

classmethod from_dict(data)[source]

Create a ShadeConstruction from a dictionary.

Parameters

data – A python dictionary in the following format

{
"type": 'ShadeConstruction',
"identifier": 'Diffuse Overhang Construction 035',
"display_name": 'Overhang Construction',
"solar_reflectance": 0.35,
"visible_reflectance": 0.35,
"is_specular": False
}
glazing_construction()[source]

Get a WindowConstruction that EnergyPlus uses for specular reflection.

Will be None if is_specular is False.

lock()
to_dict()[source]

Shade construction dictionary representation.

to_idf(host_shade_identifier)[source]

IDF string for the ShadingProperty:Reflectance of this construction.

Note that, if is_specular is True, the glazing_construction() method must be used to also write the glazing construction into the IDF.

Parameters

host_shade_identifier – Text string for the identifier of a Shade object that possesses this ShadeConstruction.

to_radiance_solar()[source]

Honeybee Radiance material with the solar reflectance.

to_radiance_visible()[source]

Honeybee Radiance material with the visible reflectance.

unlock()
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 identifier

Get or set the text string for construction identifier.

property inside_solar_reflectance

Get the solar reflectance of the construction.

property inside_visible_reflectance

Get the visible reflectance of the construction.

property is_default

Get a Boolean for whether all properties follow the EnergyPlus default.

property is_specular

Get or set a boolean to note whether the reflection is diffuse or specular.

property outside_solar_reflectance

Get the solar reflectance of the construction.

property outside_visible_reflectance

Get the visible reflectance of the construction.

property properties

Get properties for extensions.

property solar_reflectance

Get or set the solar reflectance of the shade.

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 visible_reflectance

Get or set the visible reflectance of the shade.