honeybee_energy.hvac.doas.wshp module

Water Source Heat Pump (WSHP) with DOAS HVAC system.

class honeybee_energy.hvac.doas.wshp.WSHPwithDOAS(identifier, vintage='ASHRAE_2013', equipment_type=None, sensible_heat_recovery=0, latent_heat_recovery=0, demand_controlled_ventilation=False, doas_availability_schedule=None)[source]

Bases: honeybee_energy.hvac.doas._base._DOASBase

Water Source Heat Pump (WSHP) with DOAS HVAC system.

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

  • vintage

    Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Choose from the following.

    • DOE_Ref_Pre_1980

    • DOE_Ref_1980_2004

    • ASHRAE_2004

    • ASHRAE_2007

    • ASHRAE_2010

    • ASHRAE_2013

  • equipment_type

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

    • DOAS_WSHP_FluidCooler_Boiler

    • DOAS_WSHP_CoolingTower_Boiler

    • DOAS_WSHP_GSHP

    • DOAS_WSHP_DCW_DHW

  • sensible_heat_recovery – A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. (Default: 0).

  • latent_heat_recovery – A number between 0 and 1 for the effectiveness of latent heat recovery within the system. (Default: 0).

  • demand_controlled_ventilation – Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms. (Default: False).

  • doas_availability_schedule – An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on. (Default: None).

Properties:
  • identifier

  • display_name

  • vintage

  • equipment_type

  • sensible_heat_recovery

  • latent_heat_recovery

  • demand_controlled_ventilation

  • doas_availability_schedule

  • schedules

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

classmethod from_dict(data)

Create a HVAC object from a dictionary.

Parameters

data – A DOAS dictionary in following the format below.

{
"type": "",  # text for the class name of the HVAC
"identifier": "Classroom1_System",  # identifier for the HVAC
"display_name": "Standard System",  # name for the HVAC
"vintage": "ASHRAE_2013",  # text for the vintage of the template
"equipment_type": "",  # text for the HVAC equipment type
"sensible_heat_recovery": 0.75,  # Sensible heat recovery effectiveness
"latent_heat_recovery": 0.7,  # Latent heat recovery effectiveness
"demand_controlled_ventilation": False  # Boolean for DCV
"doas_availability_schedule": {}  # Schedule for DOAS availability or None
}
classmethod from_dict_abridged(data, schedule_dict)

Create a HVAC object from an abridged dictionary.

Parameters
  • data – A DOAS abridged dictionary in following the format below.

  • schedule_dict – A dictionary with schedule identifiers as keys and honeybee schedule objects as values (either ScheduleRuleset or ScheduleFixedInterval). These will be used to assign the schedules to the Setpoint object.

{
"type": "",  # text for the class name of the HVAC
"identifier": "Classroom1_System",  # identifier for the HVAC
"display_name": "Standard System",  # name for the HVAC
"vintage": "ASHRAE_2013",  # text for the vintage of the template
"equipment_type": "",  # text for the HVAC equipment type
"sensible_heat_recovery": 0.75,  # Sensible heat recovery effectiveness
"latent_heat_recovery": 0.7,  # Latent heat recovery effectiveness
"demand_controlled_ventilation": False  # Boolean for DCV
"doas_availability_schedule": ""  # Schedule id for DOAS availability
}
lock()
to_dict(abridged=False)

All air system dictionary representation.

Parameters

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). This input currently has no effect but may eventually have one if schedule-type properties are exposed on this template.

unlock()
EQUIPMENT_TYPES = ('DOAS_WSHP_FluidCooler_Boiler', 'DOAS_WSHP_CoolingTower_Boiler', 'DOAS_WSHP_GSHP', 'DOAS_WSHP_DCW_DHW')
VINTAGES = ('DOE_Ref_Pre_1980', 'DOE_Ref_1980_2004', 'ASHRAE_2004', 'ASHRAE_2007', 'ASHRAE_2010', 'ASHRAE_2013')
property demand_controlled_ventilation

Get or set a boolean for whether demand controlled ventilation is present.

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 doas_availability_schedule

Get or set am on/off schedule for availability of the DOAS air loop.

property equipment_type

Get or set text for the system’s equipment specification.

For example, ‘VAV chiller with gas boiler reheat’.

property identifier

Get or set the text string for HVAC system identifier.

property latent_heat_recovery

Get or set a number for the effectiveness of latent heat recovery.

property schedules

Get an array of all the schedules associated with the HVAC system.

property sensible_heat_recovery

Get or set a number for the effectiveness of sensible heat recovery.

property vintage

Get or set text to indicate the vintage of the template system.

Choose from the following options:

  • DOE_Ref_Pre_1980

  • DOE_Ref_1980_2004

  • ASHRAE_2004

  • ASHRAE_2007

  • ASHRAE_2010

  • ASHRAE_2013