honeybee_doe2.load module

honeybee-doe2 load translators.

honeybee_doe2.load.electric_equipment_to_inp(electric_equip)[source]

Translate an ElectricEquipment into INP (Keywords, Values).

Parameters:

electric_equip – A honeybee-energy ElectricEquipment definition.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining the equipment for a Space.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.hot_water_and_gas_to_inp(hot_water, gas_equip, room_floor_area)[source]

Translate a ServiceHotWater and/or GasEquipment into INP (Keywords, Values).

Parameters:
  • hot_water – A honeybee-energy ServiceHotWater definition. None is allowed. None is allowed.

  • gas_equip – gas_equip: A honeybee-energy GasEquipment definition. None is allowed.

  • room_floor_area – The host Room floor area in square feet, which will be used to convert the hot water flow per unit floor area to an absolute load in BTU/h.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining the hot water SOURCE load for a Space.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.infiltration_to_inp(infiltration)[source]

Translate an Infiltration definition into INP (Keywords, Values).

Parameters:

infiltration – A honeybee-energy Infiltration definition. None is allowed.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining infiltration for a Space.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.lighting_to_inp(lighting)[source]

Translate a Lighting definition into INP (Keywords, Values).

Parameters:

lighting – A honeybee-energy Lighting definition. None is allowed.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining lighting for a Space.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.people_to_inp(people)[source]

Translate a People definition into INP (Keywords, Values).

Parameters:

people – A honeybee-energy People definition. None is allowed.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining people for a Space.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.setpoint_to_inp(setpoint)[source]

Translate a Setpoint definition into INP (Keywords, Values).

Parameters:

setpoint – A honeybee-energy Setpoint definition. None is allowed.

Returns:

A tuple with two elements.

  • keywords: A tuple of text strings for keywords related to defining setpoints for a Zone.

  • values: A tuple of text strings that aligns with the keywords and denotes the value for each keyword.

honeybee_doe2.load.ventilation_to_inp(ventilation)[source]

Translate a Ventilation definition into INP (Keywords, Values).

Parameters:

ventilation – A honeybee-energy Ventilation definition. None is allowed.

Returns:

A tuple with two elements.

  • keywords: A list of text strings for keywords related to defining ventilation for a Space.

  • values: A list of text strings that aligns with the keywords and denotes the value for each keyword.