honeybee_energy.shw module

Detailed Service Hot Water (SHW) system template used to meet hot water demand.

class honeybee_energy.shw.SHWSystem(identifier, equipment_type='Gas_WaterHeater', heater_efficiency=Autocalculate, ambient_condition=22, ambient_loss_coefficient=6)[source]

Bases: object

Detailed Service Hot Water (SHW) system template used to meet hot water demand.

Parameters:

  • identifier – Text string for the system identifier. 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.

  • equipment_type –

    Text for the specific type of the system and equipment. (Default: Gas_WaterHeater) Choose from.

    • Gas_WaterHeater

    • Electric_WaterHeater

    • HeatPump_WaterHeater

    • Gas_TanklessHeater

    • Electric_TanklessHeater

  • heater_efficiency –

    A number for the efficiency of the heater within the system. For Gas systems, this is the efficiency of the burner. For HeatPump systems, this is the rated COP of the system. For electric systems, this should usually be set to 1. If set to None or Autocalculate, this value will automatically be set based on the equipment_type. See below for the default value for each equipment type. (Default: None).

    • Gas_WaterHeater - 0.8

    • Electric_WaterHeater - 1.0

    • HeatPump_WaterHeater - 3.5

    • Gas_TanklessHeater - 0.8

    • Electric_TanklessHeater - 1.0

  • ambient_condition – A number for the ambient temperature in which the hot water tank is located [C]. This can also be the identifier of a Room in which the tank is located. (Default: 22).

  • ambient_loss_coefficient – A number for the loss of heat from the water heater tank to the surrounding ambient conditions [W/K]. (Default: 6 W/K).

Properties:

  • identifier

  • display_name

  • equipment_type

  • heater_efficiency

  • ambient_condition

  • ambient_loss_coefficient

  • user_data

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a SHWSystem object from a dictionary.

Parameters:

data – A SHWSystem dictionary in following the format below.

{
"type": "SHWSystem",
"identifier": "HP SHW System 3.8",  # identifier for the SHWSystem
"display_name": "Bathroom Service Hot Water",  # name for the SHWSystem
"equipment_type": 'HeatPump_WaterHeater',  # Equipment type
"heater_efficiency": 3.8,  # Heater efficiency/COP
"ambient_condition": "Basement Room",  # Identifier for room with the tank
"ambient_loss_coefficient": 5  # Ambient loss from the tank [W/K]
}
lock()
to_dict()[source]

SHWSystem dictionary representation.

unlock()
DEFAULT_EFFICIENCIES = {'Electric_TanklessHeater': 1.0, 'Electric_WaterHeater': 1.0, 'Gas_TanklessHeater': 0.8, 'Gas_WaterHeater': 0.8, 'HeatPump_WaterHeater': 3.5}
EQUIPMENT_TYPES = ('Gas_WaterHeater', 'Electric_WaterHeater', 'HeatPump_WaterHeater', 'Gas_TanklessHeater', 'Electric_TanklessHeater')
property ambient_condition

Get or set a number for the ambient temperature where the tank is located [C].

This can also be the identifier of a Room in which the tank is located.

property ambient_loss_coefficient

Get or set a number the loss to the surrounding ambient conditions [W/K].

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 equipment_type

Get or set text to indicate the type of the equipment.

property heater_efficiency

Get or set a number for the efficiency of the heater within the system.

property identifier

Get or set the text string for HVAC system identifier.

property properties

Get properties for extensions.

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)