dragonfly_radiance.properties.story module

Story Radiance Properties.

class dragonfly_radiance.properties.story.StoryRadianceProperties(host, modifier_set=None)[source]

Bases: object

Radiance Properties for Dragonfly Story.

Parameters:

  • host – A dragonfly_core Story object that hosts these properties.

  • modifier_set – A honeybee ModifierSet object to specify all default modifiers for the Story geometry. If None, it will be the honeybee default modifier set, which is only representative of typical indoor conditions in the visible spectrum. (Default: None).

Properties:

  • host

  • modifier_set

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

Apply properties from a StoryRadiancePropertiesAbridged dictionary.

Parameters:

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

  • modifier_sets – A dictionary of ModifierSets with identifiers of the sets as keys, which will be used to re-assign modifier_sets.

duplicate(new_host=None)[source]

Get a copy of this object.

new_host: A new Story object that hosts these properties.

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

classmethod from_dict(data, host)[source]

Create StoryRadianceProperties from a dictionary.

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

Parameters:

  • data – A dictionary representation of StoryRadianceProperties.

  • host – A Story object that hosts these properties.

to_dict(abridged=False)[source]

Return Story Radiance properties as a dictionary.

Parameters:

abridged – Boolean for whether the full dictionary of the Story should be written (False) or just the identifier of the the individual properties (True). Default: False.

property host

Get the Story object hosting these properties.

property modifier_set

Get or set the Story ModifierSet object.

If not set, it will be set by the parent Building or will be the Honeybee default generic ModifierSet.