honeybee_energy.schedule.dictutil module

Utilities to convert schedule dictionaries to Python objects.

honeybee_energy.schedule.dictutil.dict_abridged_to_schedule(sch_dict, schedule_type_limits, raise_exception=True)[source]

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

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

  • schedule_type_limits – Dictionary of all schedule type limit objects that might be used in the schedule with the type limit identifiers as the keys.

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

Returns

A Python object derived from the input sch_dict.

honeybee_energy.schedule.dictutil.dict_to_schedule(sch_dict, raise_exception=True)[source]

Get a Python object of any Schedule from a dictionary.

Parameters
  • sch_dict – A dictionary of any Honeybee energy schedules. 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 schedule. Default: True.

Returns

A Python object derived from the input sch_dict.