honeybee_energy.construction.dictutil module

Utilities to convert construction dictionaries to Python objects.

honeybee_energy.construction.dictutil.dict_abridged_to_construction(constr_dict, materials, schedules, raise_exception=True)[source]

Get a Python object of any Construction from an abridged dictionary.

Parameters:

  • constr_dict – An abridged dictionary of any Honeybee energy construction.

  • materials – Dictionary of all material objects that might be used in the construction with the material identifiers as the keys.

  • schedules – Dictionary of all schedule objects that might be used in the construction with the schedule identifiers as the keys.

  • raise_exception – Boolean to note whether an exception should be raised if the object is not identified as a construction. Default: True.

Returns:

A Python object derived from the input constr_dict.

honeybee_energy.construction.dictutil.dict_to_construction(constr_dict, raise_exception=True, materials=None, schedules=None)[source]

Get a Python object of any Construction from a dictionary.

Parameters:

  • constr_dict – A dictionary of any Honeybee energy construction. Note that this should be a non-abridged dictionary to be valid.

  • raise_exception – Boolean to note whether an excpetion should be raised if the object is not identified as a construction. Default: True.

  • materials – Optional dictionary of material objects that might be used in the construction with the material identifiers as the keys. When specified, these will be prioritized over the child objects underneath their unabridged specification.

  • schedules – Optional dictionary of schedule objects that might be used in the construction with the schedule identifiers as the keys. When specified, these will be prioritized over the child objects underneath their unabridged specification.

Returns:

A Python object derived from the input constr_dict.