HVAC Templates¶

32 object types from idfpy.models.hvac_templates · EnergyPlus 26.2

Object	Summary
HVACTemplate:Plant:Boiler	This object adds a boiler to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop.
HVACTemplate:Plant:Boiler:ObjectReference	This object references a detailed boiler object and adds it to an HVACTemplate:Plant:HotWaterLoop or …
HVACTemplate:Plant:ChilledWaterLoop	Plant and condenser loops to serve all HVACTemplate chilled water coils, chillers, and towers.
HVACTemplate:Plant:Chiller	This object adds a chiller to an HVACTemplate:Plant:ChilledWaterLoop.
HVACTemplate:Plant:Chiller:ObjectReference	This object references a detailed chiller object and adds it to an HVACTemplate:Plant:ChilledWaterLoop.
HVACTemplate:Plant:HotWaterLoop	Plant loop to serve all HVACTemplate hot water coils and boilers.
HVACTemplate:Plant:MixedWaterLoop	Central plant loop portion of a water source heat pump system.
HVACTemplate:Plant:Tower	This object adds a cooling tower to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop.
HVACTemplate:Plant:Tower:ObjectReference	This object references a detailed cooling tower object and adds it to an HVACTemplate:Plant:ChilledWaterLoop …
HVACTemplate:System:ConstantVolume	Constant Air Volume air loop with optional chilled water cooling coil, optional heating coil and optional …
HVACTemplate:System:DedicatedOutdoorAir	This object creates a dedicated outdoor air system that must be used with HVACTemplate:Zone:* objects for …
HVACTemplate:System:DualDuct	Dual-duct constant volume or variable volume air loop
HVACTemplate:System:PackagedVAV	Packaged Variable Air Volume (PVAV) air loop with optional heating coil and optional preheat.
HVACTemplate:System:Unitary	Unitary furnace with air conditioner
HVACTemplate:System:UnitaryHeatPump:AirToAir	Unitary furnace with electric air-to-air heat pump
HVACTemplate:System:UnitarySystem	Unitary HVAC system with optional cooling and heating.
HVACTemplate:System:VAV	Variable Air Volume (VAV) air loop with optional heating coil and optional preheat.
HVACTemplate:System:VRF	Variable refrigerant flow (VRF) heat pump condensing unit.
HVACTemplate:Thermostat	Zone thermostat control.
HVACTemplate:Zone:BaseboardHeat	Zone baseboard heating system.
HVACTemplate:Zone:ConstantVolume	Zone terminal unit, constant volume, reheat optional.
HVACTemplate:Zone:DualDuct	Zone terminal unit, dual-duct, constant or variable volume.
HVACTemplate:Zone:FanCoil	4 pipe fan coil unit with optional outdoor air.
HVACTemplate:Zone:IdealLoadsAirSystem	Zone with ideal air system that meets heating or cooling loads
HVACTemplate:Zone:PTAC	Packaged Terminal Air Conditioner
HVACTemplate:Zone:PTHP	Packaged Terminal Heat Pump
HVACTemplate:Zone:Unitary	Zone terminal unit, constant volume, no controls.
HVACTemplate:Zone:VAV	Zone terminal unit, variable volume, reheat optional.
HVACTemplate:Zone:VAV:FanPowered	Zone terminal unit, fan powered variable volume, reheat optional.
HVACTemplate:Zone:VAV:HeatAndCool	VAV system with VAV for both heating and cooling and optional reheat coil.
HVACTemplate:Zone:VRF	Zone terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air or …
HVACTemplate:Zone:WaterToAirHeatPump	Water to Air Heat Pump to be used with HVACTemplate:Plant:MixedWaterLoop

HVACTemplate:Plant:Boiler¶

from idfpy.models import HVACTemplatePlantBoiler

This object adds a boiler to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop.

Field	Type	Default	Details
`name` Name required	string
`boiler_type` Boiler Type required	choice		One of `CondensingHotWaterBoiler`, `DistrictHotWater`, `HotWaterBoiler`
`capacity` Capacity	number or `Autosize` W	`Autosize`
`efficiency` Efficiency	number	`0.8`	Not applicable if Boiler Type is DistrictHotWater Range: ≥ 0, ≤ 1
`fuel_type` Fuel Type	choice		Not applicable if Boiler Type is DistrictHotWater One of `Coal`, `Diesel`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`priority` Priority	string		If Hot Water Plant Operation Scheme Type=Default in HVACTemplate:Plant:HotWaterLoop, then equipment operates in priority order, 1, 2, 3, etc.
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.1`	Range: ≥ 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	Range: ≥ 0
`water_outlet_upper_temperature_limit` Water Outlet Upper Temperature Limit	number C	`100.0`
`template_plant_loop_type` Template Plant Loop Type	choice		Specifies if this boiler serves a template hot water loop or mixed water loop If left blank, will serve a hot water loop if present, or a mixed water loop (if no hot water loop is present). One of `HotWater`, `MixedWater`

HVACTemplate:Plant:Boiler:ObjectReference¶

from idfpy.models import HVACTemplatePlantBoilerObjectReference

This object references a detailed boiler object and adds it to an HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop. The user must create a complete detailed boiler object with all required curve or performance objects.

Field	Type	Default	Details
`name` Name required	string		The name of this object.
`boiler_object_type` Boiler Object Type	choice	`Boiler:HotWater`	One of `Boiler:HotWater`
`boiler_name` Boiler Name required	reference		The name of the detailed boiler object. Names a Boiler:HotWater
`priority` Priority	number		If Hot Water Plant Operation Scheme Type=Default in HVACTemplate:Plant:HotWaterLoop or MixedWaterLoop, then equipment operates in Priority order, 1, 2, 3, etc.
`template_plant_loop_type` Template Plant Loop Type	choice		Specifies if this boiler serves a template hot water loop or mixed water loop If left blank, will serve a hot water loop if present, or a mixed water loop (if no hot water loop is present). One of `HotWater`, `MixedWater`

HVACTemplate:Plant:ChilledWaterLoop¶

from idfpy.models import HVACTemplatePlantChilledWaterLoop unique

Plant and condenser loops to serve all HVACTemplate chilled water coils, chillers, and towers.

Field	Type	Default	Details
`name` Name required	string
`pump_schedule_name` Pump Schedule Name	reference		If blank, always available Applies to both chilled water and condenser loop pumps Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pump_control_type` Pump Control Type	choice	`Intermittent`	Applies to both chilled water and condenser loop pumps One of `Continuous`, `Intermittent`
`chiller_plant_operation_scheme_type` Chiller Plant Operation Scheme Type	choice	`Default`	Default operation type makes all equipment available at all times operating in order of Priority specified in HVACTemplate:Plant:Chiller objects. One of `Default`, `UserDefined`
`chiller_plant_equipment_operation_schemes_name` Chiller Plant Equipment Operation Schemes Name	reference		Name of a PlantEquipmentOperationSchemes object Ignored if Chiller Plant Operation Scheme Type = Default Names a PlantEquipmentOperationSchemes
`chilled_water_setpoint_schedule_name` Chilled Water Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`chilled_water_design_setpoint` Chilled Water Design Setpoint	number C	`7.22`	Used for sizing and as constant setpoint if no Chilled Water Setpoint Schedule Name is specified.
`chilled_water_pump_configuration` Chilled Water Pump Configuration	choice	`ConstantPrimaryNoSecondary`	VariablePrimaryNoSecondary - variable flow to chillers and coils ConstantPrimaryNoSecondary - constant flow to chillers and coils, excess bypassed ConstantPrimaryVariableSecondary - constant flow to chillers, variable flow to coils VariablePrimaryConstantSecondary - currently unsupported - variable flow to chillers, constant flow to coils One of `ConstantPrimaryNoSecondary`, `ConstantPrimaryVariableSecondary`, `VariablePrimaryNoSecondary`
`primary_chilled_water_pump_rated_head` Primary Chilled Water Pump Rated Head	number Pa	`179352.0`	default head is 60 feet H2O Range: ≥ 0
`secondary_chilled_water_pump_rated_head` Secondary Chilled Water Pump Rated Head	number Pa	`179352.0`	default head is 60 feet H2O Range: ≥ 0
`condenser_plant_operation_scheme_type` Condenser Plant Operation Scheme Type	choice	`Default`	Default operation type makes all equipment available at all times operating in order of Priority specified in HVACTemplate:Plant:Tower objects. May be left blank if not serving any water cooled chillers One of `Default`, `UserDefined`
`condenser_equipment_operation_schemes_name` Condenser Equipment Operation Schemes Name	reference		Name of a CondenserEquipmentOperationSchemes object Ignored if Condenser Plant Operation Scheme Type = Default May be left blank if not serving any water cooled chillers Names a CondenserEquipmentOperationSchemes
`condenser_water_temperature_control_type` Condenser Water Temperature Control Type	choice		May be left blank if not serving any water cooled chillers One of `OutdoorWetBulbTemperature`, `SpecifiedSetpoint`
`condenser_water_setpoint_schedule_name` Condenser Water Setpoint Schedule Name	reference		Leave blank if constant setpoint May be left blank if not serving any water cooled chillers Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`condenser_water_design_setpoint` Condenser Water Design Setpoint	number C	`29.4`	Used for sizing and as constant setpoint if no Condenser Water Setpoint Schedule Name is specified. May be left blank if not serving any water cooled chillers
`condenser_water_pump_rated_head` Condenser Water Pump Rated Head	number Pa	`179352.0`	May be left blank if not serving any water cooled chillers default head is 60 feet H2O Range: ≥ 0
`chilled_water_setpoint_reset_type` Chilled Water Setpoint Reset Type	choice	`None`	Overrides Chilled Water Setpoint Schedule Name One of `None`, `OutdoorAirTemperatureReset`
`chilled_water_setpoint_at_outdoor_dry_bulb_low` Chilled Water Setpoint at Outdoor Dry-Bulb Low	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`chilled_water_reset_outdoor_dry_bulb_low` Chilled Water Reset Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control.
`chilled_water_setpoint_at_outdoor_dry_bulb_high` Chilled Water Setpoint at Outdoor Dry-Bulb High	number C	`6.7`	Applicable only for OutdoorAirTemperatureReset control.
`chilled_water_reset_outdoor_dry_bulb_high` Chilled Water Reset Outdoor Dry-Bulb High	number C	`26.7`	Applicable only for OutdoorAirTemperatureReset control.
`chilled_water_primary_pump_type` Chilled Water Primary Pump Type	choice	`SinglePump`	Describes the type of pump configuration used for the primary portion of the chilled water loop. One of `FiveHeaderedPumps`, `FourHeaderedPumps`, `PumpPerChiller`, `SinglePump`, `ThreeHeaderedPumps`, `TwoHeaderedPumps`
`chilled_water_secondary_pump_type` Chilled Water Secondary Pump Type	choice	`SinglePump`	Describes the type of pump configuration used for the secondary portion of the chilled water loop. One of `FiveHeaderedPumps`, `FourHeaderedPumps`, `SinglePump`, `ThreeHeaderedPumps`, `TwoHeaderedPumps`
`condenser_water_pump_type` Condenser Water Pump Type	choice	`SinglePump`	Describes the type of pump configuration used for the condenser water loop. One of `FiveHeaderedPumps`, `FourHeaderedPumps`, `PumpPerTower`, `SinglePump`, `ThreeHeaderedPumps`, `TwoHeaderedPumps`
`chilled_water_supply_side_bypass_pipe` Chilled Water Supply Side Bypass Pipe	choice	`Yes`	Determines if a supply side bypass pipe is present in the chilled water loop. One of `No`, `Yes`
`chilled_water_demand_side_bypass_pipe` Chilled Water Demand Side Bypass Pipe	choice	`Yes`	Determines if a demand side bypass pipe is present in the chilled water loop. One of `No`, `Yes`
`condenser_water_supply_side_bypass_pipe` Condenser Water Supply Side Bypass Pipe	choice	`Yes`	Determines if a supply side bypass pipe is present in the condenser water loop. One of `No`, `Yes`
`condenser_water_demand_side_bypass_pipe` Condenser Water Demand Side Bypass Pipe	choice	`Yes`	Determines if a demand side bypass pipe is present in the condenser water loop. One of `No`, `Yes`
`fluid_type` Fluid Type	choice	`Water`	One of `EthyleneGlycol30`, `EthyleneGlycol40`, `EthyleneGlycol50`, `EthyleneGlycol60`, `PropyleneGlycol30`, `PropyleneGlycol40`, `PropyleneGlycol50`, `PropyleneGlycol60`, `Water`
`loop_design_delta_temperature` Loop Design Delta Temperature	number deltaC	`6.67`	The temperature difference used in sizing the loop flow rate.
`minimum_outdoor_dry_bulb_temperature` Minimum Outdoor Dry Bulb Temperature	number C		The minimum outdoor dry-bulb temperature that the chilled water loops operate. Leave blank for no limit.
`chilled_water_load_distribution_scheme` Chilled Water Load Distribution Scheme	choice	`SequentialLoad`	One of `Optimal`, `SequentialLoad`, `SequentialUniformPLR`, `UniformLoad`, `UniformPLR`
`condenser_water_load_distribution_scheme` Condenser Water Load Distribution Scheme	choice	`SequentialLoad`	One of `Optimal`, `SequentialLoad`, `SequentialUniformPLR`, `UniformLoad`, `UniformPLR`

HVACTemplate:Plant:Chiller¶

from idfpy.models import HVACTemplatePlantChiller

This object adds a chiller to an HVACTemplate:Plant:ChilledWaterLoop.

Field	Type	Default	Details
`name` Name required	string
`chiller_type` Chiller Type required	choice		One of `DistrictChilledWater`, `ElectricCentrifugalChiller`, `ElectricReciprocatingChiller`, `ElectricScrewChiller`
`capacity` Capacity	number or `Autosize` W	`Autosize`
`nominal_cop` Nominal COP required	number W/W		Not applicable if Chiller Type is DistrictChilledWater Electric Reciprocating Chiller Range: > 0
`condenser_type` Condenser Type	choice	`WaterCooled`	Not applicable if Chiller Type is DistrictChilledWater One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`priority` Priority	string		If Chiller Plant Operation Scheme Type=Default in HVACTemplate:Plant:ChilledWaterLoop, then equipment operates in Priority order, 1, 2, 3, etc.
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`minimum_part_load_ratio` Minimum Part Load Ratio	number	`0.0`	Part load ratio below which the chiller starts cycling on/off to meet the load. Must be less than or equal to Maximum Part Load Ratio. Range: ≥ 0
`maximum_part_load_ratio` Maximum Part Load Ratio	number	`1.0`	Maximum allowable part load ratio. Must be greater than or equal to Minimum Part Load Ratio. Range: > 0
`optimum_part_load_ratio` Optimum Part Load Ratio	number	`1.0`	Optimum part load ratio where the chiller is most efficient. Must be greater than or equal to the Minimum Part Load Ratio and less than or equal to the Maximum Part Load Ratio. Range: > 0
`minimum_unloading_ratio` Minimum Unloading Ratio	number	`0.25`	Part load ratio where the chiller can no longer unload and false loading begins. Minimum unloading ratio must be greater than or equal to the Minimum Part Load Ratio and less than or equal to the Maximum Part Load Ratio. Range: ≥ 0
`leaving_chilled_water_lower_temperature_limit` Leaving Chilled Water Lower Temperature Limit	number C	`5.0`

HVACTemplate:Plant:Chiller:ObjectReference¶

from idfpy.models import HVACTemplatePlantChillerObjectReference

This object references a detailed chiller object and adds it to an HVACTemplate:Plant:ChilledWaterLoop. The user must create a complete detailed chiller object with all required curve or performance objects.

Field	Type	Default	Details
`name` Name required	string		The name of this object.
`chiller_object_type` Chiller Object Type	choice	`Chiller:Electric:EIR`	One of `Chiller:Electric:EIR`, `Chiller:Electric:ReformulatedEIR`
`chiller_name` Chiller Name required	reference		The name of the detailed chiller object. Names a Chiller:Absorption, Chiller:Absorption:Indirect, Chiller:CombustionTurbine, Chiller:ConstantCOP, Chiller:Electric, Chiller:Electric:ASHRAE205, Chiller:Electric:EIR, Chiller:Electric:ReformulatedEIR, Chiller:EngineDriven
`priority` Priority	number		If Chiller Plant Operation Scheme Type=Default in HVACTemplate:Plant:ChilledWaterLoop, then equipment operates in Priority order, 1, 2, 3, etc.

HVACTemplate:Plant:HotWaterLoop¶

from idfpy.models import HVACTemplatePlantHotWaterLoop unique

Plant loop to serve all HVACTemplate hot water coils and boilers.

Field	Type	Default	Details
`name` Name required	string
`pump_schedule_name` Pump Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pump_control_type` Pump Control Type	choice	`Intermittent`	One of `Continuous`, `Intermittent`
`hot_water_plant_operation_scheme_type` Hot Water Plant Operation Scheme Type	choice	`Default`	Default operation type makes all equipment available at all times operating in order of Priority specified in HVACTemplate:Plant:Boiler objects. One of `Default`, `UserDefined`
`hot_water_plant_equipment_operation_schemes_name` Hot Water Plant Equipment Operation Schemes Name	reference		Name of a PlantEquipmentOperationSchemes object Ignored if Plant Operation Scheme Type = Default Names a PlantEquipmentOperationSchemes
`hot_water_setpoint_schedule_name` Hot Water Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`hot_water_design_setpoint` Hot Water Design Setpoint	number C	`82.0`	Used for sizing and as constant setpoint if no Setpoint Schedule Name is specified.
`hot_water_pump_configuration` Hot Water Pump Configuration	choice	`ConstantFlow`	VariableFlow - variable flow to boilers and coils, excess bypassed ConstantFlow - constant flow to boilers and coils, excess bypassed One of `ConstantFlow`, `VariableFlow`
`hot_water_pump_rated_head` Hot Water Pump Rated Head	number Pa	`179352.0`	Default head is 60 feet H2O Range: ≥ 0
`hot_water_setpoint_reset_type` Hot Water Setpoint Reset Type	choice	`None`	Overrides Hot Water Setpoint Schedule Name One of `None`, `OutdoorAirTemperatureReset`
`hot_water_setpoint_at_outdoor_dry_bulb_low` Hot Water Setpoint at Outdoor Dry-Bulb Low	number C	`82.2`	Applicable only for OutdoorAirTemperatureReset control.
`hot_water_reset_outdoor_dry_bulb_low` Hot Water Reset Outdoor Dry-Bulb Low	number C	`-6.7`	Applicable only for OutdoorAirTemperatureReset control.
`hot_water_setpoint_at_outdoor_dry_bulb_high` Hot Water Setpoint at Outdoor Dry-Bulb High	number C	`65.6`	Applicable only for OutdoorAirTemperatureReset control.
`hot_water_reset_outdoor_dry_bulb_high` Hot Water Reset Outdoor Dry-Bulb High	number C	`10.0`	Applicable only for OutdoorAirTemperatureReset control.
`hot_water_pump_type` Hot Water Pump Type	choice	`SinglePump`	Describes the type of pump configuration used for the hot water loop. One of `FiveHeaderedPumps`, `FourHeaderedPumps`, `PumpPerBoiler`, `SinglePump`, `ThreeHeaderedPumps`, `TwoHeaderedPumps`
`supply_side_bypass_pipe` Supply Side Bypass Pipe	choice	`Yes`	Determines if a supply side bypass pipe is present in the hot water loop. One of `No`, `Yes`
`demand_side_bypass_pipe` Demand Side Bypass Pipe	choice	`Yes`	Determines if a demand side bypass pipe is present in the hot water loop. One of `No`, `Yes`
`fluid_type` Fluid Type	choice	`Water`	One of `EthyleneGlycol30`, `EthyleneGlycol40`, `EthyleneGlycol50`, `EthyleneGlycol60`, `PropyleneGlycol30`, `PropyleneGlycol40`, `PropyleneGlycol50`, `PropyleneGlycol60`, `Water`
`loop_design_delta_temperature` Loop Design Delta Temperature	number deltaC	`11.0`	The temperature difference used in sizing the loop flow rate.
`maximum_outdoor_dry_bulb_temperature` Maximum Outdoor Dry Bulb Temperature	number C		The maximum outdoor dry-bulb temperature that the hot water loops operate. Leave blank for no limit.
`load_distribution_scheme` Load Distribution Scheme	choice	`SequentialLoad`	One of `Optimal`, `SequentialLoad`, `SequentialUniformPLR`, `UniformLoad`, `UniformPLR`

HVACTemplate:Plant:MixedWaterLoop¶

from idfpy.models import HVACTemplatePlantMixedWaterLoop unique

Central plant loop portion of a water source heat pump system.

Field	Type	Default	Details
`name` Name required	string
`pump_schedule_name` Pump Schedule Name	reference		If blank, always available Applies to both chilled water and condenser loop pumps Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`pump_control_type` Pump Control Type	choice	`Intermittent`	Applies to both chilled water and condenser loop pumps One of `Continuous`, `Intermittent`
`operation_scheme_type` Operation Scheme Type	choice	`Default`	Default operation type makes all equipment available at all times operating in order of Priority specified in HVACTemplate:Plant:Boiler and HVACTemplate:Plant:Tower objects. One of `Default`, `UserDefined`
`equipment_operation_schemes_name` Equipment Operation Schemes Name	reference		Name of a PlantEquipmentOperationSchemes object Ignored if Plant Operation Scheme Type = Default Names a PlantEquipmentOperationSchemes
`high_temperature_setpoint_schedule_name` High Temperature Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`high_temperature_design_setpoint` High Temperature Design Setpoint	number C	`33.0`	Used for sizing and as constant setpoint if no Setpoint Schedule Name is specified.
`low_temperature_setpoint_schedule_name` Low Temperature Setpoint Schedule Name	reference		Leave blank if constant setpoint May be left blank if not serving any water cooled chillers Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`low_temperature_design_setpoint` Low Temperature Design Setpoint	number C	`20.0`	Used for sizing and as constant setpoint if no Condenser Water Setpoint Schedule Name is specified. May be left blank if not serving any water cooled chillers
`water_pump_configuration` Water Pump Configuration	choice	`ConstantFlow`	VariableFlow - variable flow to boilers and coils, excess bypassed ConstantFlow - constant flow to boilers and coils, excess bypassed One of `ConstantFlow`, `VariableFlow`
`water_pump_rated_head` Water Pump Rated Head	number Pa	`179352.0`	May be left blank if not serving any water cooled chillers default head is 60 feet H2O Range: ≥ 0
`water_pump_type` Water Pump Type	choice	`SinglePump`	Describes the type of pump configuration used for the mixed water loop. One of `FiveHeaderedPumps`, `FourHeaderedPumps`, `PumpPerTowerOrBoiler`, `SinglePump`, `ThreeHeaderedPumps`, `TwoHeaderedPumps`
`supply_side_bypass_pipe` Supply Side Bypass Pipe	choice	`Yes`	Determines if a supply side bypass pipe is present in the hot water loop. One of `No`, `Yes`
`demand_side_bypass_pipe` Demand Side Bypass Pipe	choice	`Yes`	Determines if a demand side bypass pipe is present in the hot water loop. One of `No`, `Yes`
`fluid_type` Fluid Type	choice	`Water`	One of `EthyleneGlycol30`, `EthyleneGlycol40`, `EthyleneGlycol50`, `EthyleneGlycol60`, `PropyleneGlycol30`, `PropyleneGlycol40`, `PropyleneGlycol50`, `PropyleneGlycol60`, `Water`
`loop_design_delta_temperature` Loop Design Delta Temperature	number deltaC	`5.6`	The temperature difference used in sizing the loop flow rate.
`load_distribution_scheme` Load Distribution Scheme	choice	`SequentialLoad`	One of `Optimal`, `SequentialLoad`, `SequentialUniformPLR`, `UniformLoad`, `UniformPLR`

HVACTemplate:Plant:Tower¶

from idfpy.models import HVACTemplatePlantTower

This object adds a cooling tower to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop.

Field	Type	Default	Details
`name` Name required	string
`tower_type` Tower Type required	choice		One of `SingleSpeed`, `TwoSpeed`
`high_speed_nominal_capacity` High Speed Nominal Capacity	number or `Autosize` W	`Autosize`	Applicable for tower type SingleSpeed and TwoSpeed Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature, with the tower fan operating at high speed. Design water flow rate assumed to be 5.382E-8 m3/s per watt(3 gpm/ton). Nominal tower capacity times (1.25) gives the actual tower heat rejection at these operating conditions.
`high_speed_fan_power` High Speed Fan Power	number or `Autosize` W	`Autosize`	Applicable for tower type SingleSpeed and TwoSpeed
`low_speed_nominal_capacity` Low Speed Nominal Capacity	number or `Autosize` W	`Autosize`	Applicable only for Tower Type TwoSpeed Nominal tower capacity with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature, with the tower fan operating at low speed. Design water flow rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Nominal tower capacity times (1.25) gives the actual tower heat rejection at these operating conditions.
`low_speed_fan_power` Low Speed Fan Power	number or `Autosize` W	`Autosize`	Applicable only for Tower Type TwoSpeed
`free_convection_capacity` Free Convection Capacity	number or `Autosize` W	`Autosize`	Applicable for Tower Type SingleSpeed and TwoSpeed Tower capacity in free convection regime with entering water at 35C (95F), leaving water at 29.44C (85F), entering air at 25.56C (78F) wet-bulb temperature and 35C (95F) dry-bulb temperature. Design water flow rate assumed to be 5.382E-8 m3/s per watt of tower high-speed nominal capacity (3 gpm/ton). Tower free convection capacity times (1.25) gives the actual tower heat rejection at these operating conditions.
`priority` Priority	string		Applicable for all Tower Types If Condenser Plant Operation Scheme Type=Default in HVACTemplate:Plant:ChilledWaterLoop, then equipment operates in Priority order, 1, 2, 3, etc.
`sizing_factor` Sizing Factor	number	`1.0`	Multiplies the autosized capacity and flow rates Range: > 0
`template_plant_loop_type` Template Plant Loop Type	choice		Specifies if this tower serves a template chilled water loop or mixed water loop If left blank, will serve a chilled water loop if present, or a mixed water loop (if no chilled water loop is present). One of `ChilledWater`, `MixedWater`

HVACTemplate:Plant:Tower:ObjectReference¶

from idfpy.models import HVACTemplatePlantTowerObjectReference

This object references a detailed cooling tower object and adds it to an HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop. The user must create a complete detailed cooling tower object with all required curve or performance objects.

Field	Type	Default	Details
`name` Name required	string		The name of this object.
`cooling_tower_object_type` Cooling Tower Object Type	choice	`CoolingTower:SingleSpeed`	One of `CoolingTower:SingleSpeed`, `CoolingTower:TwoSpeed`, `CoolingTower:VariableSpeed`
`cooling_tower_name` Cooling Tower Name required	reference		The name of the detailed cooling tower object. Names a CoolingTower:SingleSpeed, CoolingTower:TwoSpeed, CoolingTower:VariableSpeed, CoolingTower:VariableSpeed:Merkel
`priority` Priority	number		If Condenser Plant Operation Scheme Type=Default in HVACTemplate:Plant:ChilledWaterLoop or MixedWaterLoop, then equipment operates in Priority order, 1, 2, 3, etc.
`template_plant_loop_type` Template Plant Loop Type	choice		Specifies if this tower serves a template chilled water loop or mixed water loop If left blank, will serve a chilled water loop if present, or a mixed water loop (if no chilled water loop is present). One of `ChilledWater`, `MixedWater`

HVACTemplate:System:ConstantVolume¶

from idfpy.models import HVACTemplateSystemConstantVolume

Constant Air Volume air loop with optional chilled water cooling coil, optional heating coil and optional preheat.

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_maximum_flow_rate` Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`600.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`cooling_coil_type` Cooling Coil Type	choice	`ChilledWater`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`, `HeatExchangerAssistedChilledWater`, `None`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_control_type` Cooling Coil Setpoint Control Type	choice	`FixedSetpoint`	One of `ControlZone`, `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`, `Warmest`
`cooling_coil_control_zone_name` Cooling Coil Control Zone name	reference		name of the HVACTemplate:ZoneConstantVolume object that contains the cooling thermostat when Cooling Coil Setpoint Control Type = ControlZone Names a HVACTemplate:Zone:ConstantVolume
`cooling_coil_design_setpoint_temperature` Cooling Coil Design Setpoint Temperature	number C	`12.8`	Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.
`cooling_coil_setpoint_schedule_name` Cooling Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_at_outdoor_dry_bulb_low` Cooling Coil Setpoint at Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_low` Cooling Coil Reset Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control. Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)
`cooling_coil_setpoint_at_outdoor_dry_bulb_high` Cooling Coil Setpoint at Outdoor Dry-Bulb High	number C	`12.8`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_high` Cooling Coil Reset Outdoor Dry-Bulb High	number C	`23.3`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_type` Heating Coil Type	choice	`HotWater`	One of `Electric`, `Gas`, `HotWater`, `None`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_control_type` Heating Coil Setpoint Control Type	choice	`FixedSetpoint`	One of `ControlZone`, `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`
`heating_coil_control_zone_name` Heating Coil Control Zone name	reference		name of the HVACTemplate:ZoneConstantVolume object that contains the heating thermostat Names a HVACTemplate:Zone:ConstantVolume
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`10.0`	Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.
`heating_coil_setpoint_schedule_name` Heating Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_at_outdoor_dry_bulb_low` Heating Coil Setpoint at Outdoor Dry-Bulb Low	number C	`15.0`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_reset_outdoor_dry_bulb_low` Heating Coil Reset Outdoor Dry-Bulb Low	number C	`7.8`	Applicable only for OutdoorAirTemperatureReset control. Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)
`heating_coil_setpoint_at_outdoor_dry_bulb_high` Heating Coil Setpoint at Outdoor Dry-Bulb High	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_reset_outdoor_dry_bulb_high` Heating Coil Reset Outdoor Dry-Bulb High	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_capacity` Heating Coil Capacity	number or `Autosize` W	`Autosize`
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`preheat_coil_type` Preheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`preheat_coil_availability_schedule_name` Preheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`preheat_coil_design_setpoint` Preheat Coil Design Setpoint	number C	`7.2`	Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.
`preheat_coil_setpoint_schedule_name` Preheat Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`gas_preheat_coil_efficiency` Gas Preheat Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_preheat_coil_parasitic_electric_load` Gas Preheat Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the Minimum Outdoor Air Flow Rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_upper_temperature_limit` Economizer Upper Temperature Limit	number C		Outdoor temperature above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_lower_temperature_limit` Economizer Lower Temperature Limit	number C		Outdoor temperature below which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_upper_enthalpy_limit` Economizer Upper Enthalpy Limit	number J/kg		Outdoor enthalpy above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnAnyZoneFansOnly`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Range: ≥ 0, ≤ 1
`heat_recovery_heat_exchanger_type` Heat Recovery Heat Exchanger Type	choice	`Plate`	One of `Plate`, `Rotary`
`heat_recovery_frost_control_type` Heat Recovery Frost Control Type	choice	`None`	One of `ExhaustAirRecirculation`, `ExhaustOnly`, `MinimumExhaustTemperature`, `None`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint. One of `CoolReheat`, `None`
`dehumidification_control_zone_name` Dehumidification Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`dehumidification_relative_humidity_setpoint` Dehumidification Relative Humidity Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`dehumidification_relative_humidity_setpoint_schedule_name` Dehumidification Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Dehumidification Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_relative_humidity_setpoint` Humidifier Relative Humidity Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100). Ignored if Humidifier Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`humidifier_relative_humidity_setpoint_schedule_name` Humidifier Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Humidifier Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`300.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:ConstantVolume

HVACTemplate:System:DedicatedOutdoorAir¶

from idfpy.models import HVACTemplateSystemDedicatedOutdoorAir

This object creates a dedicated outdoor air system that must be used with HVACTemplate:Zone:* objects for BaseboardHeat FanCoil PTAC PTHP WaterToAirHeatPump and VRF. Does not support HVACTemplate:Zone:VAV or other central multizone systems

Field	Type	Default	Details
`name` Name	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; DOAS System always on. Schedule is used in availability manager and fan scheduling. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_outlet_type` Air Outlet Type	choice	`DirectIntoZone`	One of `DirectIntoZone`
`supply_fan_flow_rate` Supply Fan Flow Rate	number or `Autosize` m3/s	`Autosize`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`cooling_coil_type` Cooling Coil Type	choice	`ChilledWater`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`, `HeatExchangerAssistedChilledWater`, `HeatExchangerAssistedDX`, `None`, `TwoSpeedDX`, `TwoStageDX`, `TwoStageHumidityControlDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_control_type` Cooling Coil Setpoint Control Type	choice	`FixedSetpoint`	One of `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`
`cooling_coil_design_setpoint` Cooling Coil Design Setpoint	number C	`12.8`	Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.
`cooling_coil_setpoint_schedule_name` Cooling Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_at_outdoor_dry_bulb_low` Cooling Coil Setpoint at Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_low` Cooling Coil Reset Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control. Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)
`cooling_coil_setpoint_at_outdoor_dry_bulb_high` Cooling Coil Setpoint at Outdoor Dry-Bulb High	number C	`12.8`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_high` Cooling Coil Reset Outdoor Dry-Bulb High	number C	`23.3`	Applicable only for OutdoorAirTemperatureReset control.
`dx_cooling_coil_gross_rated_total_capacity` DX Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat
`dx_cooling_coil_gross_rated_sensible_heat_ratio` DX Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Gross SHR
`dx_cooling_coil_gross_rated_cop` DX Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electrical energy input Range: > 0
`heating_coil_type` Heating Coil Type	choice	`HotWater`	One of `Electric`, `Gas`, `HotWater`, `None`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_control_type` Heating Coil Setpoint Control Type	choice	`FixedSetpoint`	When selecting OutdoorAirTemperatureReset, the Heating Coil Design Setpoint may need to be changed One of `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`12.2`	Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.
`heating_coil_setpoint_schedule_name` Heating Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_at_outdoor_dry_bulb_low` Heating Coil Setpoint at Outdoor Dry-Bulb Low	number C	`15.0`	Applicable only for OutdoorAirTemperatureReset control. Defaults 15.0C (59F) at 7.8C (46F) to 12.2C (54F) at 12.2C (54F)
`heating_coil_reset_outdoor_dry_bulb_low` Heating Coil Reset Outdoor Dry-Bulb Low	number C	`7.8`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_setpoint_at_outdoor_dry_bulb_high` Heating Coil Setpoint at Outdoor Dry-Bulb High	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_reset_outdoor_dry_bulb_high` Heating Coil Reset Outdoor Dry-Bulb High	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`heat_recovery_sensible_effectiveness` Heat Recovery Sensible Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`heat_recovery_latent_effectiveness` Heat Recovery Latent Effectiveness	number	`0.65`	Range: ≥ 0, ≤ 1
`heat_recovery_heat_exchanger_type` Heat Recovery Heat Exchanger Type	choice	`Plate`	One of `Plate`, `Rotary`
`heat_recovery_frost_control_type` Heat Recovery Frost Control Type	choice	`None`	One of `ExhaustAirRecirculation`, `ExhaustOnly`, `MinimumExhaustTemperature`, `None`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheatHeatingCoil = cool beyond the dry-bulb setpoint, reheat with heating coil Valid for all cooling coil types. If no heating coil specified, cold supply temps may occur. CoolReheatDesuperheater = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint, reheat with desuperheater coil. Valid only for Cooling Coil Type = TwoSpeedDX, TwoStageDX, TwoStageHumidityControlDX, or HeatExchangerAssistedDX. Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only for Cooling Coil Type = TwoStageHumidityControlDX or HeatExchangerAssistedDX One of `CoolReheatDesuperheater`, `CoolReheatHeatingCoil`, `Multimode`, `None`
`dehumidification_setpoint` Dehumidification Setpoint	number kgWater/kgDryAir	`0.00924`	The supply air humidity ratio for dehumidification control. Default of 0.00924 kgWater/kgDryAir is equivalent to 12.8C (55F) dewpoint. Ignored if Dehumidification Setpoint Schedule specified below Range: ≥ 0, ≤ 1
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_constant_setpoint` Humidifier Constant Setpoint	number kgWater/kgDryAir	`0.003`	The supply air humidity ratio for humidification control. Ignored if Humidifier Setpoint Schedule specified below Range: ≥ 0, ≤ 1
`dehumidification_setpoint_schedule_name` Dehumidification Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Dehumidification Setpoint above. Schedule values must be in units of humidity ratio (kgWater/kgDryAir or lbWater/lbDryAir) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_setpoint_schedule_name` Humidifier Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Humidifier Constant Setpoint above. Schedule values must be in units of humidity ratio (kgWater/kgDryAir or lbWater/lbDryAir) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Referenced by 7 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:BaseboardHeat, HVACTemplate:Zone:FanCoil, HVACTemplate:Zone:PTAC, HVACTemplate:Zone:PTHP, HVACTemplate:Zone:VRF, HVACTemplate:Zone:WaterToAirHeatPump

HVACTemplate:System:DualDuct¶

from idfpy.models import HVACTemplateSystemDualDuct

Dual-duct constant volume or variable volume air loop

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`system_configuration_type` System Configuration Type	choice	`SingleFanConstantVolume`	SingleFan - a single supply fan before the split to dual ducts DualFan - two supply fans, one each for the cold and hot ducts ConstantVolume - constant volume VariableVolume - variable volume One of `DualFanConstantVolume`, `DualFanVariableVolume`, `SingleFanConstantVolume`, `SingleFanVariableVolume`
`main_supply_fan_maximum_flow_rate` Main Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`main_supply_fan_minimum_flow_fraction` Main Supply Fan Minimum Flow Fraction	number	`0.2`	Range: ≥ 0, ≤ 1
`main_supply_fan_total_efficiency` Main Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`main_supply_fan_delta_pressure` Main Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`main_supply_fan_motor_efficiency` Main Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`main_supply_fan_motor_in_air_stream_fraction` Main Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`main_supply_fan_part_load_power_coefficients` Main Supply Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`
`cold_duct_supply_fan_maximum_flow_rate` Cold Duct Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`cold_duct_supply_fan_minimum_flow_fraction` Cold Duct Supply Fan Minimum Flow Fraction	number	`0.2`	Range: ≥ 0, ≤ 1
`cold_duct_supply_fan_total_efficiency` Cold Duct Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`cold_duct_supply_fan_delta_pressure` Cold Duct Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`cold_duct_supply_fan_motor_efficiency` Cold Duct Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`cold_duct_supply_fan_motor_in_air_stream_fraction` Cold Duct Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cold_duct_supply_fan_part_load_power_coefficients` Cold Duct Supply Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`
`cold_duct_supply_fan_placement` Cold Duct Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`hot_duct_supply_fan_maximum_flow_rate` Hot Duct Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`hot_duct_supply_fan_minimum_flow_fraction` Hot Duct Supply Fan Minimum Flow Fraction	number	`0.2`	Range: ≥ 0, ≤ 1
`hot_duct_supply_fan_total_efficiency` Hot Duct Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`hot_duct_supply_fan_delta_pressure` Hot Duct Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`hot_duct_supply_fan_motor_efficiency` Hot Duct Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`hot_duct_supply_fan_motor_in_air_stream_fraction` Hot Duct Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`hot_duct_supply_fan_part_load_power_coefficients` Hot Duct Supply Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`
`hot_duct_supply_fan_placement` Hot Duct Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`cooling_coil_type` Cooling Coil Type	choice	`ChilledWater`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`, `None`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_control_type` Cooling Coil Setpoint Control Type	choice	`FixedSetpoint`	One of `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`, `Warmest`
`cooling_coil_design_setpoint_temperature` Cooling Coil Design Setpoint Temperature	number C	`12.8`	Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.
`cooling_coil_setpoint_schedule_name` Cooling Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_at_outdoor_dry_bulb_low` Cooling Coil Setpoint at Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_low` Cooling Coil Reset Outdoor Dry-Bulb Low	number C	`15.6`	Applicable only for OutdoorAirTemperatureReset control. Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)
`cooling_coil_setpoint_at_outdoor_dry_bulb_high` Cooling Coil Setpoint at Outdoor Dry-Bulb High	number C	`12.8`	Applicable only for OutdoorAirTemperatureReset control.
`cooling_coil_reset_outdoor_dry_bulb_high` Cooling Coil Reset Outdoor Dry-Bulb High	number C	`23.3`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_type` Heating Coil Type	choice	`HotWater`	One of `Electric`, `Gas`, `HotWater`, `None`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_control_type` Heating Coil Setpoint Control Type	choice	`FixedSetpoint`	One of `Coldest`, `FixedSetpoint`, `OutdoorAirTemperatureReset`, `Scheduled`
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`50.0`	Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.
`heating_coil_setpoint_schedule_name` Heating Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_at_outdoor_dry_bulb_low` Heating Coil Setpoint at Outdoor Dry-Bulb Low	number C	`50.0`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_reset_outdoor_dry_bulb_low` Heating Coil Reset Outdoor Dry-Bulb Low	number C	`7.8`	Applicable only for OutdoorAirTemperatureReset control. Defaults are 15.6C (60F) at 15.6C (60F) to 12.8C (55F) at 23.3C (74F)
`heating_coil_setpoint_at_outdoor_dry_bulb_high` Heating Coil Setpoint at Outdoor Dry-Bulb High	number C	`20.0`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_reset_outdoor_dry_bulb_high` Heating Coil Reset Outdoor Dry-Bulb High	number C	`12.2`	Applicable only for OutdoorAirTemperatureReset control.
`heating_coil_capacity` Heating Coil Capacity	number or `Autosize` W	`Autosize`
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`preheat_coil_type` Preheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`preheat_coil_availability_schedule_name` Preheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`preheat_coil_design_setpoint` Preheat Coil Design Setpoint	number C	`7.2`	Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.
`preheat_coil_setpoint_schedule_name` Preheat Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`gas_preheat_coil_efficiency` Gas Preheat Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_preheat_coil_parasitic_electric_load` Gas Preheat Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_control_type` Minimum Outdoor Air Control Type	choice	`ProportionalMinimum`	One of `FixedMinimum`, `ProportionalMinimum`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the Minimum Outdoor Air Flow Rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `NoLockout`
`economizer_upper_temperature_limit` Economizer Upper Temperature Limit	number C		Outdoor temperature above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_lower_temperature_limit` Economizer Lower Temperature Limit	number C		Outdoor temperature below which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_upper_enthalpy_limit` Economizer Upper Enthalpy Limit	number J/kg		Outdoor enthalpy above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`cold_supply_plenum_name` Cold Supply Plenum Name	reference		Plenum zone name. Supply plenum serves the cold inlets of all zones on this system. Blank if none. Names a Zone
`hot_supply_plenum_name` Hot Supply Plenum Name	reference		Plenum zone name. Supply plenum serves the hot inlets of all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Range: ≥ 0, ≤ 1
`heat_recovery_heat_exchanger_type` Heat Recovery Heat Exchanger Type	choice	`Plate`	One of `Plate`, `Rotary`
`heat_recovery_frost_control_type` Heat Recovery Frost Control Type	choice	`None`	One of `ExhaustAirRecirculation`, `ExhaustOnly`, `MinimumExhaustTemperature`, `None`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint. One of `CoolReheat`, `None`
`dehumidification_control_zone_name` Dehumidification Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`dehumidification_relative_humidity_setpoint` Dehumidification Relative Humidity Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`dehumidification_relative_humidity_setpoint_schedule_name` Dehumidification Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Dehumidification Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_relative_humidity_setpoint` Humidifier Relative Humidity Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100). Ignored if Humidifier Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`humidifier_relative_humidity_setpoint_schedule_name` Humidifier Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Humidifier Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`sizing_option` Sizing Option	choice	`NonCoincident`	Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident zone air flow rates. One of `Coincident`, `NonCoincident`
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`500.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`return_fan_part_load_power_coefficients` Return Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:DualDuct

HVACTemplate:System:PackagedVAV¶

from idfpy.models import HVACTemplateSystemPackagedVAV

Packaged Variable Air Volume (PVAV) air loop with optional heating coil and optional preheat.

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; PVAV System always on. Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_maximum_flow_rate` Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_minimum_flow_rate` Supply Fan Minimum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field is only used to set a minimum part load on the VAV fan power curve. Autosize or zero is recommended.
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`TwoSpeedDX`	One of `TwoSpeedDX`, `TwoSpeedHumidControlDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_schedule_name` Cooling Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_design_setpoint` Cooling Coil Design Setpoint	number C	`12.8`	Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Gross SHR
`cooling_coil_gross_rated_cop` Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electric power input Range: > 0
`heating_coil_type` Heating Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_schedule_name` Heating Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`10.0`	Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.
`heating_coil_capacity` Heating Coil Capacity	number or `Autosize` W	`Autosize`
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_control_type` Minimum Outdoor Air Control Type	choice	`ProportionalMinimum`	One of `FixedMinimum`, `ProportionalMinimum`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the Minimum Outdoor Air Flow Rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `LockoutWithCompressor`, `LockoutWithHeating`, `NoLockout`
`economizer_maximum_limit_dry_bulb_temperature` Economizer Maximum Limit Dry-Bulb Temperature	number C		Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_maximum_limit_enthalpy` Economizer Maximum Limit Enthalpy	number J/kg		Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_minimum_limit_dry_bulb_temperature` Economizer Minimum Limit Dry-Bulb Temperature	number C		Enter the minimum outdoor dry-bulb temperature limit for economizer control. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`supply_fan_part_load_power_coefficients` Supply Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnAnyZoneFansOnly`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Range: ≥ 0, ≤ 1
`cooling_coil_setpoint_reset_type` Cooling Coil Setpoint Reset Type	choice	`None`	Overrides Cooling Coil Setpoint Schedule Name None = no reset, control to Cooling Coil Design Setpoint Temperature or Schedule Warmest = reset as warm as possible yet meet all zone cooling loads at max supply air flow rate OutdoorAirTemperatureReset = reset based on outdoor air temperature (18.0C at 15.6C ODB, to the Cooling Design Setpoint at 26.7C) WarmestTemperatureFirst = reset as warm as possible yet meet all zone cooling loads at min supply air flow rate One of `None`, `OutdoorAirTemperatureReset`, `Warmest`, `WarmestTemperatureFirst`
`heating_coil_setpoint_reset_type` Heating Coil Setpoint Reset Type	choice	`None`	Overrides Heating Coil Setpoint Schedule Name None = no reset, control to Heating Coil Design Setpoint Temperature or Schedule OutdoorAirTemperatureReset = reset based on outdoor air temperature (Heating Design Setpoint at -6.7C ODB to Heating Design Setpoint minus 5.2C at 10C ODB) min supply air flow rate One of `None`, `OutdoorAirTemperatureReset`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint. One of `CoolReheat`, `None`
`dehumidification_control_zone_name` Dehumidification Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`dehumidification_setpoint` Dehumidification Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_setpoint` Humidifier Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`sizing_option` Sizing Option	choice	`NonCoincident`	Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident zone air flow rates. One of `Coincident`, `NonCoincident`
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`500.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`return_fan_part_load_power_coefficients` Return Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`

Referenced by 4 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:VAV, HVACTemplate:Zone:VAV:FanPowered, HVACTemplate:Zone:VAV:HeatAndCool

HVACTemplate:System:Unitary¶

from idfpy.models import HVACTemplateSystemUnitary

Unitary furnace with air conditioner

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; Unitary System always on. Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`control_zone_or_thermostat_location_name` Control Zone or Thermostat Location Name required	reference		Names a Zone
`supply_fan_maximum_flow_rate` Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`600.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`SingleSpeedDX`	One of `None`, `SingleSpeedDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_design_supply_air_temperature` Cooling Design Supply Air Temperature	number C	`12.8`	Used for sizing.
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Gross SHR
`cooling_coil_gross_rated_cop` Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply air fan heat or supply air fan electric power Range: > 0
`heating_coil_type` Heating Coil Type required	choice		One of `Electric`, `Gas`, `HotWater`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_design_supply_air_temperature` Heating Design Supply Air Temperature	number C	`50.0`	Used for sizing.
`heating_coil_capacity` Heating Coil Capacity	number or `Autosize` W	`Autosize`
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the minimum outdoor air flow rate If blank, always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `LockoutWithCompressor`, `LockoutWithHeating`, `NoLockout`
`economizer_upper_temperature_limit` Economizer Upper Temperature Limit	number C		Outdoor temperature above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_lower_temperature_limit` Economizer Lower Temperature Limit	number C		Outdoor temperature below which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_upper_enthalpy_limit` Economizer Upper Enthalpy Limit	number J/kg		Outdoor enthalpy above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum serves all zones on this system. Blank if none. Names a Zone
`supply_fan_placement` Supply Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Applicable only if Heat Recovery Type is Enthalpy. Range: ≥ 0, ≤ 1
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible cooling load only CoolReheatHeatingCoil = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint, reheat with main heating coil. CoolReheatDesuperheater = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint, reheat with desuperheater coil. One of `CoolReheatDesuperheater`, `CoolReheatHeatingCoil`, `None`
`dehumidification_setpoint` Dehumidification Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_setpoint` Humidifier Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`500.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:Unitary

HVACTemplate:System:UnitaryHeatPump:AirToAir¶

from idfpy.models import HVACTemplateSystemUnitaryHeatPumpAirToAir

Unitary furnace with electric air-to-air heat pump

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; Unitary System always on. Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`control_zone_or_thermostat_location_name` Control Zone or Thermostat Location Name required	reference		Names a Zone
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during cooling operation This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during heating operation This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate when no cooling or heating is needed Only used when heat pump fan operating mode is Continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used. This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_placement` Supply Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`600.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`SingleSpeedDX`	One of `SingleSpeedDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_design_supply_air_temperature` Cooling Design Supply Air Temperature	number C	`12.8`	Used for sizing.
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`cooling_coil_gross_rated_cop` Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electric power input Range: > 0
`heat_pump_heating_coil_type` Heat Pump Heating Coil Type	choice	`SingleSpeedDXHeatPump`	One of `SingleSpeedDXHeatPump`
`heat_pump_heating_coil_availability_schedule_name` Heat Pump Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_design_supply_air_temperature` Heating Design Supply Air Temperature	number C	`50.0`	Used for sizing.
`heat_pump_heating_coil_gross_rated_capacity` Heat Pump Heating Coil Gross Rated Capacity	number or `Autosize` W	`Autosize`	Rated heating capacity excluding the effect of supply air fan heat Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C
`heat_pump_heating_coil_rated_cop` Heat Pump Heating Coil Rated COP	number W/W	`2.75`	Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan, does not include supply air fan heat or supply air fan electrical energy. Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C Range: > 0
`heat_pump_heating_minimum_outdoor_dry_bulb_temperature` Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature	number C	`-8.0`	Range: ≥ -20
`heat_pump_defrost_maximum_outdoor_dry_bulb_temperature` Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature	number C	`5.0`	Range: ≥ 0, ≤ 7.22
`heat_pump_defrost_strategy` Heat Pump Defrost Strategy	choice	`ReverseCycle`	One of `Resistive`, `ReverseCycle`
`heat_pump_defrost_control` Heat Pump Defrost Control	choice	`Timed`	One of `OnDemand`, `Timed`
`heat_pump_defrost_time_period_fraction` Heat Pump Defrost Time Period Fraction	number	`0.058333`	Fraction of time in defrost mode only applicable if Timed defrost control is specified Range: ≥ 0
`supplemental_heating_coil_type` Supplemental Heating Coil Type	choice	`Electric`	One of `Electric`, `Gas`, `HotWater`
`supplemental_heating_coil_availability_schedule_name` Supplemental Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supplemental_heating_coil_capacity` Supplemental Heating Coil Capacity	number or `Autosize` W	`Autosize`
`supplemental_heating_coil_maximum_outdoor_dry_bulb_temperature` Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature	number C	`21.0`	Supplemental heater will not operate when outdoor temperature exceeds this value. Range: ≤ 21
`supplemental_gas_heating_coil_efficiency` Supplemental Gas Heating Coil Efficiency	number	`0.8`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0, ≤ 1
`supplemental_gas_heating_coil_parasitic_electric_load` Supplemental Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the minimum outdoor air flow rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `LockoutWithCompressor`, `LockoutWithHeating`, `NoLockout`
`economizer_maximum_limit_dry_bulb_temperature` Economizer Maximum Limit Dry-Bulb Temperature	number C		Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_maximum_limit_enthalpy` Economizer Maximum Limit Enthalpy	number J/kg		Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_minimum_limit_dry_bulb_temperature` Economizer Minimum Limit Dry-Bulb Temperature	number C		Enter the minimum outdoor dry-bulb temperature limit for economizer control. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum serves all zones on this system. Blank if none. Names a Zone
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Applicable only if Heat Recovery Type is Enthalpy. Range: ≥ 0, ≤ 1
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_setpoint` Humidifier Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`500.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:Unitary

HVACTemplate:System:UnitarySystem¶

from idfpy.models import HVACTemplateSystemUnitarySystem

Unitary HVAC system with optional cooling and heating. Supports DX and chilled water, cooling, gas, electric, and hot water heating, air-to-air and water-to-air heat pumps.

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always available. Also see Supply Fan Operating Mode Schedule Name field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`control_type` Control Type	choice	`Load`	Load control requires a Controlling Zone name. SetPoint control requires set points at coil outlet nodes. The user must add appropriate SetpointManager objects to the idf file. One of `Load`, `SetPoint`
`control_zone_or_thermostat_location_name` Control Zone or Thermostat Location Name	reference		This field is required if Control Type is Load. Names a Zone
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during cooling operation This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during heating operation This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate when no cooling or heating is needed Only used when heat pump fan operating mode is Continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used. This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_placement` Supply Fan Placement	choice	`BlowThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`600.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`SingleSpeedDX`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`, `HeatExchangerAssistedChilledWater`, `HeatExchangerAssistedDX`, `MultiSpeedDX`, `None`, `SingleSpeedDX`, `SingleSpeedDXWaterCooled`, `TwoSpeedDX`, `TwoStageDX`, `TwoStageHumidityControlDX`
`number_of_speeds_for_cooling` Number of Speeds for Cooling	integer	`1`	Used only for Cooling Coil Type = MultiSpeedDX. Range: ≥ 0, ≤ 4
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_design_supply_air_temperature` Cooling Design Supply Air Temperature	number C	`12.8`	Used for sizing.
`dx_cooling_coil_gross_rated_total_capacity` DX Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb
`dx_cooling_coil_gross_rated_sensible_heat_ratio` DX Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`dx_cooling_coil_gross_rated_cop` DX Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electric power input Range: > 0
`heating_coil_type` Heating Coil Type	choice	`Gas`	One of `Electric`, `Gas`, `HotWater`, `MultiSpeedDXHeatPumpAirSource`, `MultiStageElectric`, `MultiStageGas`, `None`, `SingleSpeedDXHeatPumpAirSource`, `SingleSpeedDXHeatPumpWaterSource`
`number_of_speeds_or_stages_for_heating` Number of Speeds or Stages for Heating	integer	`1`	Used only for Heating Coil Type = MultiSpeedDXHeatPumpAirSource), MultiStageElectric, or MultiStageGas. Range: ≥ 0, ≤ 4
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_design_supply_air_temperature` Heating Design Supply Air Temperature	number C	`50.0`	Used for sizing.
`heating_coil_gross_rated_capacity` Heating Coil Gross Rated Capacity	number or `Autosize` W	`Autosize`	Rated heating capacity excluding the effect of supply air fan heat Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`heat_pump_heating_coil_gross_rated_cop` Heat Pump Heating Coil Gross Rated COP	number W/W	`2.75`	Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan, does not include supply air fan heat or supply air fan electrical energy. Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C Applies only to DX coils Range: > 0
`heat_pump_heating_minimum_outdoor_dry_bulb_temperature` Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature	number C	`-8.0`	Range: ≥ -20
`heat_pump_defrost_maximum_outdoor_dry_bulb_temperature` Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature	number C	`5.0`	Range: ≥ 0, ≤ 7.22
`heat_pump_defrost_strategy` Heat Pump Defrost Strategy	choice	`ReverseCycle`	One of `Resistive`, `ReverseCycle`
`heat_pump_defrost_control` Heat Pump Defrost Control	choice	`Timed`	One of `OnDemand`, `Timed`
`heat_pump_defrost_time_period_fraction` Heat Pump Defrost Time Period Fraction	number	`0.058333`	Fraction of time in defrost mode only applicable if Timed defrost control is specified Range: ≥ 0
`supplemental_heating_or_reheat_coil_type` Supplemental Heating or Reheat Coil Type	choice	`None`	One of `DesuperHeater`, `Electric`, `Gas`, `HotWater`, `None`
`supplemental_heating_or_reheat_coil_availability_schedule_name` Supplemental Heating or Reheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supplemental_heating_or_reheat_coil_capacity` Supplemental Heating or Reheat Coil Capacity	number or `Autosize` W	`Autosize`
`supplemental_heating_or_reheat_coil_maximum_outdoor_dry_bulb_temperature` Supplemental Heating or Reheat Coil Maximum Outdoor Dry-Bulb Temperature	number C	`21.0`	Supplemental heater will not operate when outdoor temperature exceeds this value. Range: ≤ 21
`supplemental_gas_heating_or_reheat_coil_efficiency` Supplemental Gas Heating or Reheat Coil Efficiency	number	`0.8`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0, ≤ 1
`supplemental_gas_heating_or_reheat_coil_parasitic_electric_load` Supplemental Gas Heating or Reheat Coil Parasitic Electric Load	number W	`0.0`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the minimum outdoor air flow rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `LockoutWithCompressor`, `LockoutWithHeating`, `NoLockout`
`economizer_maximum_limit_dry_bulb_temperature` Economizer Maximum Limit Dry-Bulb Temperature	number C		Enter the maximum outdoor dry-bulb temperature limit for FixedDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_maximum_limit_enthalpy` Economizer Maximum Limit Enthalpy	number J/kg		Enter the maximum outdoor enthalpy limit for FixedEnthalpy economizer control type. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`economizer_minimum_limit_dry_bulb_temperature` Economizer Minimum Limit Dry-Bulb Temperature	number C		Enter the minimum outdoor dry-bulb temperature limit for economizer control. No input or blank input means this limit is not operative Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum serves all zones on this system. Blank if none. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Applicable only if Heat Recovery Type is Enthalpy. Range: ≥ 0, ≤ 1
`heat_recovery_heat_exchanger_type` Heat Recovery Heat Exchanger Type	choice	`Plate`	One of `Plate`, `Rotary`
`heat_recovery_frost_control_type` Heat Recovery Frost Control Type	choice	`None`	One of `ExhaustAirRecirculation`, `ExhaustOnly`, `MinimumExhaustTemperature`, `None`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint, reheat with reheat coil If no reheat coil specified, cold supply temps may occur. Multimode = activate enhanced dehumidification mode as needed and meet sensible load. Valid only for Cooling Coil Type = TwoStageHumidityControlDX or HeatExchangerAssistedDX One of `CoolReheat`, `Multimode`, `None`
`dehumidification_relative_humidity_setpoint` Dehumidification Relative Humidity Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Ignored if Dehumidification Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`dehumidification_relative_humidity_setpoint_schedule_name` Dehumidification Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Dehumidification Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_relative_humidity_setpoint` Humidifier Relative Humidity Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100). Ignored if Humidifier Relative Humidity Setpoint Schedule specified below Range: ≥ 0, ≤ 100
`humidifier_relative_humidity_setpoint_schedule_name` Humidifier Relative Humidity Setpoint Schedule Name	reference		Leave blank to use constant setpoint specified in Humidifier Relative Humidity Setpoint above. Schedule values must be in percent relative humidity (0 to 100). Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`sizing_option` Sizing Option	choice	`NonCoincident`	Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident zone air flow rates. One of `Coincident`, `NonCoincident`
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`300.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:Unitary

HVACTemplate:System:VAV¶

from idfpy.models import HVACTemplateSystemVAV

Variable Air Volume (VAV) air loop with optional heating coil and optional preheat.

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on; VAV System always on. Schedule is used in availability manager and fan scheduling. Also see "Night Cycle Control" field. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_maximum_flow_rate` Supply Fan Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will not be multiplied by any sizing factor or by zone multipliers. If using zone multipliers a value entered here must be large enough to serve the multiplied zones.
`supply_fan_minimum_flow_rate` Supply Fan Minimum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field is only used to set a minimum part load on the VAV fan power curve. Autosize or zero is recommended.
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`ChilledWater`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_setpoint_schedule_name` Cooling Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_design_setpoint` Cooling Coil Design Setpoint	number C	`12.8`	Used for sizing and as constant setpoint if no Cooling Coil Setpoint Schedule Name is specified.
`heating_coil_type` Heating Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_setpoint_schedule_name` Heating Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`10.0`	Used for sizing and as constant setpoint if no Heating Coil Setpoint Schedule Name is specified.
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`preheat_coil_type` Preheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`preheat_coil_availability_schedule_name` Preheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`preheat_coil_setpoint_schedule_name` Preheat Coil Setpoint Schedule Name	reference		Leave blank if constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`preheat_coil_design_setpoint` Preheat Coil Design Setpoint	number C	`7.2`	Used for sizing and as constant setpoint if no Preheat Coil Setpoint Schedule Name specified.
`gas_preheat_coil_efficiency` Gas Preheat Coil Efficiency	number	`0.8`	Range: ≥ 0, ≤ 1
`gas_preheat_coil_parasitic_electric_load` Gas Preheat Coil Parasitic Electric Load	number W	`0.0`	Range: ≥ 0
`maximum_outdoor_air_flow_rate` Maximum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_flow_rate` Minimum Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`
`minimum_outdoor_air_control_type` Minimum Outdoor Air Control Type	choice	`ProportionalMinimum`	One of `FixedMinimum`, `ProportionalMinimum`
`minimum_outdoor_air_schedule_name` Minimum Outdoor Air Schedule Name	reference		Schedule values multiply the Minimum Outdoor Air Flow Rate If blank, multiplier is always one Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`economizer_type` Economizer Type	choice	`NoEconomizer`	One of `DifferentialDryBulb`, `DifferentialDryBulbAndEnthalpy`, `DifferentialEnthalpy`, `ElectronicEnthalpy`, `FixedDewPointAndDryBulb`, `FixedDryBulb`, `FixedEnthalpy`, `NoEconomizer`
`economizer_lockout` Economizer Lockout	choice	`NoLockout`	One of `NoLockout`
`economizer_upper_temperature_limit` Economizer Upper Temperature Limit	number C		Outdoor temperature above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_lower_temperature_limit` Economizer Lower Temperature Limit	number C		Outdoor temperature below which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_upper_enthalpy_limit` Economizer Upper Enthalpy Limit	number J/kg		Outdoor enthalpy above which economizer is disabled and heat recovery is enabled (if available). Blank means no limit.
`economizer_maximum_limit_dewpoint_temperature` Economizer Maximum Limit Dewpoint Temperature	number C		Enter the maximum outdoor dewpoint temperature limit for FixedDewPointAndDryBulb economizer control type. No input or blank input means this limit is not operative. Limit is applied regardless of economizer control type.
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Supply plenum serves all zones on this system. Blank if none. Names a Zone
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_part_load_power_coefficients` Supply Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`
`night_cycle_control` Night Cycle Control	choice	`StayOff`	One of `CycleOnAny`, `CycleOnAnyZoneFansOnly`, `CycleOnControlZone`, `StayOff`
`night_cycle_control_zone_name` Night Cycle Control Zone Name	reference		Applicable only if Night Cycle Control is Cycle On Control Zone. Names a Zone
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number	`0.65`	Range: ≥ 0, ≤ 1
`cooling_coil_setpoint_reset_type` Cooling Coil Setpoint Reset Type	choice	`None`	Overrides Cooling Coil Setpoint Schedule Name None = no reset, control to Cooling Coil Design Setpoint Temperature or Schedule Warmest = reset as warm as possible yet meet all zone cooling loads at max supply air flow rate OutdoorAirTemperatureReset = reset based on outdoor air temperature (18.0C at 15.6C ODB, to the Cooling Design Setpoint at 26.7C) WarmestTemperatureFirst = reset as warm as possible yet meet all zone cooling loads at min supply air flow rate One of `None`, `OutdoorAirTemperatureReset`, `Warmest`, `WarmestTemperatureFirst`
`heating_coil_setpoint_reset_type` Heating Coil Setpoint Reset Type	choice	`None`	Overrides Heating Coil Setpoint Schedule Name None = no reset, control to Heating Coil Design Setpoint Temperature or Schedule OutdoorAirTemperatureReset = reset based on outdoor air temperature (Heating Design Setpoint at -6.7C ODB to Heating Design Setpoint minus 5.2C at 10C ODB) min supply air flow rate One of `None`, `OutdoorAirTemperatureReset`
`dehumidification_control_type` Dehumidification Control Type	choice	`None`	None = meet sensible load only CoolReheat = cool beyond the dry-bulb setpoint as required to meet the humidity setpoint. One of `CoolReheat`, `None`
`dehumidification_control_zone_name` Dehumidification Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`dehumidification_setpoint` Dehumidification Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`humidifier_type` Humidifier Type	choice	`None`	One of `ElectricSteam`, `None`
`humidifier_availability_schedule_name` Humidifier Availability Schedule Name	reference		If blank, always available Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`humidifier_rated_capacity` Humidifier Rated Capacity	number m3/s	`1e-06`	Moisture output rate at full rated power input. The humidifier does not currently autosize, so the default is very large to allow for adequate capacity. Range: ≥ 0
`humidifier_rated_electric_power` Humidifier Rated Electric Power	number or `Autosize` W	`Autosize`	Electric power input at rated capacity moisture output. Power consumption is proportional to moisture output with no part-load penalty.
`humidifier_control_zone_name` Humidifier Control Zone Name	reference		Zone name where humidistat is located Names a Zone
`humidifier_setpoint` Humidifier Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`sizing_option` Sizing Option	choice	`NonCoincident`	Select whether autosized system supply flow rate is the sum of Coincident or NonCoincident zone air flow rates. One of `Coincident`, `NonCoincident`
`return_fan` Return Fan	choice	`No`	Specifies if the system has a return fan. One of `No`, `Yes`
`return_fan_total_efficiency` Return Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`return_fan_delta_pressure` Return Fan Delta Pressure	number Pa	`500.0`	Range: ≥ 0
`return_fan_motor_efficiency` Return Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`return_fan_motor_in_air_stream_fraction` Return Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`return_fan_part_load_power_coefficients` Return Fan Part-Load Power Coefficients	choice	`InletVaneDampers`	This field selects a predefined set of fan power coefficients. The ASHRAE 90.1-2004 Appendix G coefficients are from TABLE G3.1.3.15, Method 2. The other sets of coefficients are from the EnergyPlus Input Output Reference, Fan Coefficient Values table. One of `ASHRAE90.1-2004AppendixG`, `InletVaneDampers`, `OutletDampers`, `VariableSpeedMotor`, `VariableSpeedMotorPressureReset`

Referenced by 4 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:VAV, HVACTemplate:Zone:VAV:FanPowered, HVACTemplate:Zone:VAV:HeatAndCool

HVACTemplate:System:VRF¶

from idfpy.models import HVACTemplateSystemVRF

Variable refrigerant flow (VRF) heat pump condensing unit. Serves one or more VRF zone terminal units (HVACTemplate:Zone:VRF).

Field	Type	Default	Details
`name` Name required	string
`system_availability_schedule_name` System Availability Schedule Name	reference		Availability schedule name for this system. Schedule value > 0 means the system is available. If this field is blank, the system is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`gross_rated_total_cooling_capacity` Gross Rated Total Cooling Capacity	number or `Autosize` W	`Autosize`	Enter the total cooling capacity in watts at rated conditions or set to autosize. Total cooling capacity not accounting for the effect of supply air fan heat
`gross_rated_cooling_cop` Gross Rated Cooling COP	number W/W	`3.3`	Enter the coefficient of performance at rated conditions or leave blank to use default. COP includes compressor and condenser fan electrical energy input COP does not include supply fan heat or supply fan electric power input Range: > 0
`minimum_outdoor_temperature_in_cooling_mode` Minimum Outdoor Temperature in Cooling Mode	number C	`-6.0`	Enter the minimum outdoor temperature allowed for cooling operation. Cooling is disabled below this temperature.
`maximum_outdoor_temperature_in_cooling_mode` Maximum Outdoor Temperature in Cooling Mode	number C	`43.0`	Enter the maximum outdoor temperature allowed for cooling operation. Cooling is disabled above this temperature.
`gross_rated_heating_capacity` Gross Rated Heating Capacity	number or `Autosize` W	`Autosize`	Enter the heating capacity in watts at rated conditions or set to autosize. Heating capacity not accounting for the effect of supply air fan heat
`rated_heating_capacity_sizing_ratio` Rated Heating Capacity Sizing Ratio	number W/W	`1.0`	If the Gross Rated Heating Capacity is autosized, the heating capacity is sized to be equal to the cooling capacity multiplied by this sizing ratio. The zone terminal unit heating coils are also sized using this ratio unless the sizing ratio input in the ZoneHVAC:TerminalUnit:VariableRefrigerantFlow object is entered. Range: ≥ 1
`gross_rated_heating_cop` Gross Rated Heating COP	number W/W	`3.4`	COP includes compressor and condenser fan electrical energy input COP does not include supply fan heat or supply fan electrical energy input Range: > 0
`minimum_outdoor_temperature_in_heating_mode` Minimum Outdoor Temperature in Heating Mode	number C	`-20.0`	Enter the minimum outdoor temperature allowed for heating operation.
`maximum_outdoor_temperature_in_heating_mode` Maximum Outdoor Temperature in Heating Mode	number C	`16.0`	Enter the maximum outdoor temperature allowed for heating operation.
`minimum_heat_pump_part_load_ratio` Minimum Heat Pump Part-Load Ratio	number dimensionless	`0.15`	Enter the minimum heat pump part-load ratio (PLR). When the cooling or heating PLR is below this value, the heat pump compressor will cycle to meet the cooling or heating demand.
`zone_name_for_master_thermostat_location` Zone Name for Master Thermostat Location	reference		Enter the name of the zone where the master thermostat is located. Names a Zone
`master_thermostat_priority_control_type` Master Thermostat Priority Control Type	choice	`MasterThermostatPriority`	Choose a thermostat control logic scheme. If these control types fail to control zone temperature within a reasonable limit, consider using multiple VRF systems One of `LoadPriority`, `MasterThermostatPriority`, `Scheduled`, `ThermostatOffsetPriority`, `ZonePriority`
`thermostat_priority_schedule_name` Thermostat Priority Schedule Name	reference		this field is required if Master Thermostat Priority Control Type is Scheduled. Schedule values of 0 denote cooling, 1 for heating, and all other values disable the system. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_pump_waste_heat_recovery` Heat Pump Waste Heat Recovery	choice	`No`	This field is reserved for future use. The only valid choice is No. One of `No`, `Yes`
`equivalent_piping_length_used_for_piping_correction_factor_in_cooling_mode` Equivalent Piping Length used for Piping Correction Factor in Cooling Mode	number m	`30.0`	Enter the equivalent length of the farthest terminal unit from the condenser
`vertical_height_used_for_piping_correction_factor` Vertical Height used for Piping Correction Factor	number m	`10.0`	Enter the height difference between the highest and lowest terminal unit
`equivalent_piping_length_used_for_piping_correction_factor_in_heating_mode` Equivalent Piping Length used for Piping Correction Factor in Heating Mode	number m	`30.0`	Enter the equivalent length of the farthest terminal unit from the condenser
`crankcase_heater_power_per_compressor` Crankcase Heater Power per Compressor	number W	`33.0`	Enter the value of the resistive heater located in the compressor(s). This heater is used to warm the refrigerant and oil when the compressor is off.
`number_of_compressors` Number of Compressors	integer dimensionless	`2`	Enter the total number of compressor. This input is used only for crankcase heater calculations.
`ratio_of_compressor_size_to_total_compressor_capacity` Ratio of Compressor Size to Total Compressor Capacity	number W/W	`0.5`	Enter the ratio of the first stage compressor to total compressor capacity. All other compressors are assumed to be equally sized. This inputs is used only for crankcase heater calculations.
`maximum_outdoor_dry_bulb_temperature_for_crankcase_heater` Maximum Outdoor Dry-bulb Temperature for Crankcase Heater	number C	`5.0`	Enter the maximum outdoor temperature above which the crankcase heaters are disabled.
`defrost_strategy` Defrost Strategy	choice	`Resistive`	Select a defrost strategy. Reverse cycle reverses the operating mode from heating to cooling to melt frost formation on the condenser coil. The resistive strategy uses a resistive heater to melt the frost. One of `Resistive`, `ReverseCycle`
`defrost_control` Defrost Control	choice	`Timed`	Choose a defrost control type. Either use a fixed Timed defrost period or select OnDemand to defrost only when necessary. One of `OnDemand`, `Timed`
`defrost_time_period_fraction` Defrost Time Period Fraction	number dimensionless	`0.058333`	Fraction of time in defrost mode. Only applicable if timed defrost control is specified. Range: ≥ 0
`resistive_defrost_heater_capacity` Resistive Defrost Heater Capacity	number or `Autosize` W	`Autosize`	Enter the size of the resistive defrost heating element. Only applicable if resistive defrost strategy is specified
`maximum_outdoor_dry_bulb_temperature_for_defrost_operation` Maximum Outdoor Dry-bulb Temperature for Defrost Operation	number C	`5.0`	Enter the maximum outdoor temperature above which defrost operation is disabled.
`condenser_type` Condenser Type	choice	`AirCooled`	Select either an air cooled or evaporatively cooled condenser. One of `AirCooled`, `EvaporativelyCooled`, `WaterCooled`
`water_condenser_volume_flow_rate` Water Condenser Volume Flow Rate	number or `Autosize` m3/s	`Autosize`	Only used when Condenser Type = WaterCooled.
`evaporative_condenser_effectiveness` Evaporative Condenser Effectiveness	number dimensionless	`0.9`	Enter the effectiveness of the evaporatively cooled condenser. This field is only used when the Condenser Type = EvaporativelyCooled. Range: ≥ 0, ≤ 1
`evaporative_condenser_air_flow_rate` Evaporative Condenser Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Used to calculate evaporative condenser water use. This field is only used when the Condenser Type = EvaporativelyCooled.
`evaporative_condenser_pump_rated_power_consumption` Evaporative Condenser Pump Rated Power Consumption	number or `Autosize` W	`0.0`	Rated power consumed by the evaporative condenser's water pump. This field is only used when the Condenser Type = EvaporativelyCooled.
`basin_heater_capacity` Basin Heater Capacity	number W/K	`0.0`	This field is only used for Condenser Type = EvaporativelyCooled and for periods when the basin heater is available (field Basin Heater Operating Schedule Name). For this situation, the heater maintains the basin water temperature at the basin heater setpoint temperature when the outdoor air temperature falls below the setpoint temperature. The basin heater only operates when the DX coil is off. Range: ≥ 0
`basin_heater_setpoint_temperature` Basin Heater Setpoint Temperature	number C	`2.0`	This field is only used for Condenser Type = EvaporativelyCooled. Enter the outdoor dry-bulb temperature when the basin heater turns on. Range: ≥ 2
`basin_heater_operating_schedule_name` Basin Heater Operating Schedule Name	reference		This field is only used for Condenser Type = EvaporativelyCooled. Schedule values greater than 0 allow the basin heater to operate whenever the outdoor air dry-bulb temperature is below the basin heater setpoint temperature. If a schedule name is not entered, the basin heater is allowed to operate throughout the entire simulation. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fuel_type` Fuel Type	choice	`Electricity`	One of `Diesel`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `OtherFuel1`, `OtherFuel2`, `Propane`
`minimum_outdoor_temperature_in_heat_recovery_mode` Minimum Outdoor Temperature in Heat Recovery Mode	number C	`-15.0`	The minimum outdoor temperature below which heat recovery mode will not operate.
`maximum_outdoor_temperature_in_heat_recovery_mode` Maximum Outdoor Temperature in Heat Recovery Mode	number C	`45.0`	The maximum outdoor temperature above which heat recovery mode will not operate.

Referenced by 2 object types

AvailabilityManager:HybridVentilation, HVACTemplate:Zone:VRF

HVACTemplate:Thermostat¶

from idfpy.models import HVACTemplateThermostat

Zone thermostat control. Referenced schedules must be defined elsewhere in the idf. Thermostat control type is dual setpoint with deadband. It is not necessary to create a thermostat object for every zone, only for each unique set of setpoint schedules. For example, an office building may have two thermostat objects, one for "Office" and one for "Storage".

Field	Type	Details
`name` Name required	string	This name is referenced by HVACTemplate:Zone:* objects
`heating_setpoint_schedule_name` Heating Setpoint Schedule Name	reference	Leave blank if constant setpoint specified below, must enter schedule or constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`constant_heating_setpoint` Constant Heating Setpoint	number C	Ignored if schedule specified above, must enter schedule or constant setpoint
`cooling_setpoint_schedule_name` Cooling Setpoint Schedule Name	reference	Leave blank if constant setpoint specified below, must enter schedule or constant setpoint Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`constant_cooling_setpoint` Constant Cooling Setpoint	number C	Ignored if schedule specified above, must enter schedule or constant setpoint

Referenced by 13 object types

HVACTemplate:Zone:BaseboardHeat, HVACTemplate:Zone:ConstantVolume, HVACTemplate:Zone:DualDuct, HVACTemplate:Zone:FanCoil, HVACTemplate:Zone:IdealLoadsAirSystem, HVACTemplate:Zone:PTAC, HVACTemplate:Zone:PTHP, HVACTemplate:Zone:Unitary, HVACTemplate:Zone:VAV, HVACTemplate:Zone:VAV:FanPowered, HVACTemplate:Zone:VAV:HeatAndCool, HVACTemplate:Zone:VRF, HVACTemplate:Zone:WaterToAirHeatPump

HVACTemplate:Zone:BaseboardHeat¶

from idfpy.models import HVACTemplateZoneBaseboardHeat

Zone baseboard heating system.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`baseboard_heating_type` Baseboard Heating Type	choice	`HotWater`	One of `Electric`, `HotWater`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution

HVACTemplate:Zone:ConstantVolume¶

from idfpy.models import HVACTemplateZoneConstantVolume

Zone terminal unit, constant volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_constant_volume_system_name` Template Constant Volume System Name required	reference		Name of a HVACTemplate:System:ConstantVolume object serving this zone Names a HVACTemplate:System:ConstantVolume
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`reheat_coil_type` Reheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`reheat_coil_availability_schedule_name` Reheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum runs through only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum runs through only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature

Referenced by 1 object types

HVACTemplate:System:ConstantVolume

HVACTemplate:Zone:DualDuct¶

from idfpy.models import HVACTemplateZoneDualDuct

Zone terminal unit, dual-duct, constant or variable volume.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_dual_duct_system_name` Template Dual Duct System Name required	reference		Name of a HVACTemplate:System:DualDuct object serving this zone Names a HVACTemplate:System:DualDuct
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_minimum_air_flow_fraction` Zone Minimum Air Flow Fraction	number	`0.2`	This field is the Zone Minimum Air Flow Fraction specified as a fraction of the maximum air flow rate. This field is ignored if the system serving this zone is constant volume. Range: ≥ 0, ≤ 1
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name_for_sizing` Design Specification Outdoor Air Object Name for Sizing	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Note that this field is used only for specifying the design outdoor air flow rate used for sizing. The field Design Specification Outdoor Air Object Name for Control (see above) is used to actively control the VAV terminal air flow rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`design_specification_outdoor_air_object_name_for_control` Design Specification Outdoor Air Object Name for Control	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. Note that this field is used only for specifying the design outdoor air flow rate used for control. The field Design Specification Outdoor Air Object Name for Sizing (see below) is used to specify the design outdoor air flow rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`cold_supply_plenum_name` Cold Supply Plenum Name	reference		Plenum zone name. Cold supply plenum that serves only this zone. Blank if none. Names a Zone
`hot_supply_plenum_name` Hot Supply Plenum Name	reference		Plenum zone name. Hot supply plenum that serves only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum that serves only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:DualDuct Cooling Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:DualDuct Heating Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.

HVACTemplate:Zone:FanCoil¶

from idfpy.models import HVACTemplateZoneFanCoil

4 pipe fan coil unit with optional outdoor air.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`75.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_fan_motor_in_air_stream_fraction` Supply Fan Motor in Air Stream Fraction	number	`1.0`	Range: ≥ 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`ChilledWater`	One of `ChilledWater`, `ChilledWaterDetailedFlatModel`, `HeatExchangerAssistedChilledWater`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_design_setpoint` Cooling Coil Design Setpoint	number C	`14.0`	Used for sizing when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`heating_coil_type` Heating Coil Type	choice	`HotWater`	One of `Electric`, `HotWater`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_design_setpoint` Heating Coil Design Setpoint	number C	`50.0`	Used for sizing when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Cooling Coil Design Setpoint (above) TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Heating Coil Design Setpoint (above) TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`capacity_control_method` Capacity Control Method	choice		If this field is left blank, it will default to CyclingFan if a Dedicated Outdoor Air System is specified (see above), otherwise it will default to ConstantFanVariableFlow. One of `ASHRAE90VariableFan`, `ConstantFanVariableFlow`, `CyclingFan`, `MultiSpeedFan`, `VariableFanConstantFlow`, `VariableFanVariableFlow`
`low_speed_supply_air_flow_ratio` Low Speed Supply Air Flow Ratio	number	`0.33`	Range: > 0
`medium_speed_supply_air_flow_ratio` Medium Speed Supply Air Flow Ratio	number	`0.66`	Medium Speed Supply Air Flow Ratio should be greater than Low Speed Supply Air Flow Ratio Range: > 0
`outdoor_air_schedule_name` Outdoor Air Schedule Name	reference		Value of schedule multiplies maximum outdoor air flow rate This schedule is ignored if this zone is served by an HVACTemplate dedicated outdoor air system. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`

HVACTemplate:Zone:IdealLoadsAirSystem¶

from idfpy.models import HVACTemplateZoneIdealLoadsAirSystem

Zone with ideal air system that meets heating or cooling loads

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_heating_supply_air_temperature` Maximum Heating Supply Air Temperature	number C	`50.0`	Range: > 0, < 100
`minimum_cooling_supply_air_temperature` Minimum Cooling Supply Air Temperature	number C	`13.0`	Range: > -100, < 50
`maximum_heating_supply_air_humidity_ratio` Maximum Heating Supply Air Humidity Ratio	number kgWater/kgDryAir	`0.0156`	Range: > 0
`minimum_cooling_supply_air_humidity_ratio` Minimum Cooling Supply Air Humidity Ratio	number kgWater/kgDryAir	`0.0077`	Range: > 0
`heating_limit` Heating Limit	choice	`NoLimit`	One of `LimitCapacity`, `LimitFlowRate`, `LimitFlowRateAndCapacity`, `NoLimit`
`maximum_heating_air_flow_rate` Maximum Heating Air Flow Rate	number or `Autosize` m3/s		This field is ignored if Heating Limit = NoLimit If this field is blank, there is no limit.
`maximum_sensible_heating_capacity` Maximum Sensible Heating Capacity	number or `Autosize` W		This field is ignored if Heating Limit = NoLimit If this field is blank, there is no limit.
`cooling_limit` Cooling Limit	choice	`NoLimit`	One of `LimitCapacity`, `LimitFlowRate`, `LimitFlowRateAndCapacity`, `NoLimit`
`maximum_cooling_air_flow_rate` Maximum Cooling Air Flow Rate	number or `Autosize` m3/s		This field is ignored if Cooling Limit = NoLimit This field is required if Outdoor Air Economizer Type is anything other than NoEconomizer.
`maximum_total_cooling_capacity` Maximum Total Cooling Capacity	number or `Autosize` W		This field is ignored if Cooling Limit = NoLimit
`heating_availability_schedule_name` Heating Availability Schedule Name	reference		If blank, heating is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_availability_schedule_name` Cooling Availability Schedule Name	reference		If blank, cooling is always available. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`dehumidification_control_type` Dehumidification Control Type	choice	`ConstantSensibleHeatRatio`	ConstantSensibleHeatRatio means that the ideal loads system will be controlled to meet the sensible cooling load, and the latent cooling rate will be computed using a constant sensible heat ratio (SHR) Humidistat means that there is a ZoneControl:Humidistat for this zone and the ideal loads system will attempt to satisfy the humidistat. None means that there is no dehumidification. ConstantSupplyHumidityRatio means that during cooling the supply air will always be at the Minimum Cooling Supply Humidity Ratio. One of `ConstantSensibleHeatRatio`, `ConstantSupplyHumidityRatio`, `Humidistat`, `None`
`cooling_sensible_heat_ratio` Cooling Sensible Heat Ratio	number dimensionless	`0.7`	This field is applicable only when Dehumidification Control Type is ConstantSensibleHeatRatio Range: > 0, ≤ 1
`dehumidification_setpoint` Dehumidification Setpoint	number percent	`60.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`humidification_control_type` Humidification Control Type	choice	`None`	None means that there is no humidification. Humidistat means that there is a ZoneControl:Humidistat for this zone and the ideal loads system will attempt to satisfy the humidistat. ConstantSupplyHumidityRatio means that during heating the supply air will always be at the Maximum Heating Supply Humidity Ratio. One of `ConstantSupplyHumidityRatio`, `Humidistat`, `None`
`humidification_setpoint` Humidification Setpoint	number percent	`30.0`	Zone relative humidity setpoint in percent (0 to 100) Range: ≥ 0, ≤ 100
`outdoor_air_method` Outdoor Air Method	choice	`None`	None means there is no outdoor air and all related fields will be ignored Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `None`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the minimum outdoor air flow rate will be computed using these specifications. The outdoor air flow rate will also be affected by the next two fields. If this field is blank, there will be no outdoor air and the remaining fields will be ignored. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`demand_controlled_ventilation_type` Demand Controlled Ventilation Type	choice	`None`	This field controls how the minimum outdoor air flow rate is calculated. None means that design occupancy will be used to compute the minimum outdoor air flow rate OccupancySchedule means that current occupancy level will be used. CO2Setpoint means that the design occupancy will be used to compute the minimum outdoor air flow rate and the outdoor air flow rate may be increased if necessary to maintain the indoor air carbon dioxide setpoint defined in a ZoneControl:ContaminantController object. One of `CO2Setpoint`, `None`, `OccupancySchedule`
`outdoor_air_economizer_type` Outdoor Air Economizer Type	choice	`NoEconomizer`	DifferentialDryBulb and DifferentialEnthalpy will increase the outdoor air flow rate when there is a cooling load and the outdoor air temperature or enthalpy is below the zone exhaust air temperature or enthalpy. One of `DifferentialDryBulb`, `DifferentialEnthalpy`, `NoEconomizer`
`heat_recovery_type` Heat Recovery Type	choice	`None`	One of `Enthalpy`, `None`, `Sensible`
`sensible_heat_recovery_effectiveness` Sensible Heat Recovery Effectiveness	number dimensionless	`0.7`	Range: ≥ 0, ≤ 1
`latent_heat_recovery_effectiveness` Latent Heat Recovery Effectiveness	number dimensionless	`0.65`	Applicable only if Heat Recovery Type is Enthalpy. Range: ≥ 0, ≤ 1

HVACTemplate:Zone:PTAC¶

from idfpy.models import HVACTemplateZonePTAC

Packaged Terminal Air Conditioner

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during cooling operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during heating operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Supply air flow rate when no cooling or heating is needed Only used when heat pump fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used. A value entered in this field will not be multiplied by the sizing factor or by zone multipliers. It is best to autosize or leave blank when using zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule Name values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`75.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`SingleSpeedDX`	One of `SingleSpeedDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`cooling_coil_gross_rated_cooling_cop` Cooling Coil Gross Rated Cooling COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electrical energy input Range: > 0
`heating_coil_type` Heating Coil Type	choice	`Electric`	One of `Electric`, `Gas`, `HotWater`
`heating_coil_availability_schedule_name` Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heating_coil_capacity` Heating Coil Capacity	number or `Autosize` W	`Autosize`
`gas_heating_coil_efficiency` Gas Heating Coil Efficiency	number	`0.8`	Applies only if Heating Coil Type is Gas Range: ≥ 0, ≤ 1
`gas_heating_coil_parasitic_electric_load` Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Applies only if Heating Coil Type is Gas Range: ≥ 0
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`14.0`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`capacity_control_method` Capacity Control Method	choice	`None`	One of `None`, `SingleZoneVAV`

HVACTemplate:Zone:PTHP¶

from idfpy.models import HVACTemplateZonePTHP

Packaged Terminal Heat Pump

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during cooling operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during heating operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Supply air flow rate when no cooling or heating is needed Only used when heat pump fan operating mode is continuous. This air flow rate is used when no heating or cooling is required and the DX coil compressor is off. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used. A value entered in this field will not be multiplied by the sizing factor or by zone multipliers. It is best to autosize or leave blank when using zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`75.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`SingleSpeedDX`	One of `SingleSpeedDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`cooling_coil_gross_rated_cop` Cooling Coil Gross Rated COP	number W/W	`3.0`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electrical energy input Range: > 0
`heat_pump_heating_coil_type` Heat Pump Heating Coil Type	choice	`SingleSpeedDXHeatPump`	One of `SingleSpeedDXHeatPump`
`heat_pump_heating_coil_availability_schedule_name` Heat Pump Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_pump_heating_coil_gross_rated_capacity` Heat Pump Heating Coil Gross Rated Capacity	number or `Autosize` W	`Autosize`	Capacity excluding supply air fan heat Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C
`heat_pump_heating_coil_gross_rated_cop` Heat Pump Heating Coil Gross Rated COP	number W/W	`2.75`	Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan, Does not include supply air fan heat or supply air fan electrical energy Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C Range: > 0
`heat_pump_heating_minimum_outdoor_dry_bulb_temperature` Heat Pump Heating Minimum Outdoor Dry-Bulb Temperature	number C	`-8.0`	Range: ≥ -20
`heat_pump_defrost_maximum_outdoor_dry_bulb_temperature` Heat Pump Defrost Maximum Outdoor Dry-Bulb Temperature	number C	`5.0`	Range: ≥ 0, ≤ 7.22
`heat_pump_defrost_strategy` Heat Pump Defrost Strategy	choice	`ReverseCycle`	One of `Resistive`, `ReverseCycle`
`heat_pump_defrost_control` Heat Pump Defrost Control	choice	`Timed`	One of `OnDemand`, `Timed`
`heat_pump_defrost_time_period_fraction` Heat Pump Defrost Time Period Fraction	number	`0.058333`	Fraction of time in defrost mode only applicable if Timed defrost control is specified Range: ≥ 0
`supplemental_heating_coil_type` Supplemental Heating Coil Type	choice	`Electric`	One of `Electric`, `Gas`, `HotWater`
`supplemental_heating_coil_availability_schedule_name` Supplemental Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supplemental_heating_coil_capacity` Supplemental Heating Coil Capacity	number or `Autosize` W	`Autosize`
`supplemental_heating_coil_maximum_outdoor_dry_bulb_temperature` Supplemental Heating Coil Maximum Outdoor Dry-Bulb Temperature	number C	`21.0`	Supplemental heater will not operate when outdoor temperature exceeds this value. Range: ≤ 21
`supplemental_gas_heating_coil_efficiency` Supplemental Gas Heating Coil Efficiency	number	`0.8`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0, ≤ 1
`supplemental_gas_heating_coil_parasitic_electric_load` Supplemental Gas Heating Coil Parasitic Electric Load	number W	`0.0`	Applies only if Supplemental Heating Coil Type is Gas Range: ≥ 0
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`14.0`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`capacity_control_method` Capacity Control Method	choice	`None`	One of `None`, `SingleZoneVAV`

HVACTemplate:Zone:Unitary¶

from idfpy.models import HVACTemplateZoneUnitary

Zone terminal unit, constant volume, no controls.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_unitary_system_name` Template Unitary System Name required	reference		Enter the name of an HVACTemplate:System:Unitary, HVACTemplate:System:UnitaryHeatPump:AirToAir, or HVACTemplate:System:UnitarySystem object serving this zone. Names a HVACTemplate:System:Unitary, HVACTemplate:System:UnitaryHeatPump:AirToAir, HVACTemplate:System:UnitarySystem
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum runs through only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum runs through only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:Unitary or HVACTemplate:System:UnitaryHeatPump:AirToAir Cooling Design Supply Air Temperature One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:Unitary or HVACTemplate:System:UnitaryHeatPump:AirToAir Heating Design Supply Air Temperature One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution

HVACTemplate:Zone:VAV¶

from idfpy.models import HVACTemplateZoneVAV

Zone terminal unit, variable volume, reheat optional. For heating, this unit activates reheat coil first, then increases airflow (if reverse action specified).

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_vav_system_name` Template VAV System Name required	reference		Name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV object serving this zone Names a HVACTemplate:System:PackagedVAV, HVACTemplate:System:VAV
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_minimum_air_flow_input_method` Zone Minimum Air Flow Input Method	choice	`Constant`	Constant = Constant Minimum Air Flow Fraction (a fraction of Maximum Air Flow Rate) FixedFlowRate = Fixed Minimum Air Flow Rate (a fixed minimum air volume flow rate) Scheduled = Scheduled Minimum Air Flow Fraction (a fraction of Maximum Air Flow One of `Constant`, `FixedFlowRate`, `Scheduled`
`constant_minimum_air_flow_fraction` Constant Minimum Air Flow Fraction	number	`0.2`	This field is used if the field Zone Minimum Air Flow Input Method is Constant If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional. If a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the following field are entered, the larger result is used. Range: ≥ 0, ≤ 1
`fixed_minimum_air_flow_rate` Fixed Minimum Air Flow Rate	number m3/s		This field is used if the field Zone Minimum Air Flow Input Method is FixedFlowRate. If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional. If a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the previous field are entered, the larger result is used.
`minimum_air_flow_fraction_schedule_name` Minimum Air Flow Fraction Schedule Name	reference		This field is used if the field Zone Minimum Air Flow Input Method is Scheduled Schedule values are fractions, 0.0 to 1.0. If the field Constant Minimum Air Flow Fraction is blank, then the average of the minimum and maximum schedule values is used for sizing normal-action reheat coils. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`reheat_coil_type` Reheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`reheat_coil_availability_schedule_name` Reheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`damper_heating_action` Damper Heating Action	choice	`Reverse`	One of `Normal`, `Reverse`
`maximum_flow_per_zone_floor_area_during_reheat` Maximum Flow per Zone Floor Area During Reheat	number or `Autocalculate` m3/s-m2		Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse When autocalculating, the maximum flow per zone is set to 0.002032 m3/s-m2 (0.4 cfm/sqft) This optional field limits the maximum flow allowed in reheat mode. If this field and the following field are left blank, the maximum flow will not be limited. At no time will the maximum flow rate calculated here exceed the value of Maximum Air Flow Rate.
`maximum_flow_fraction_during_reheat` Maximum Flow Fraction During Reheat	number or `Autocalculate`		Used only when Reheat Coil Object Type = Coil:Heating:Water and Damper Heating Action = Reverse When autocalculating, the maximum flow fraction is set to the ratio of 0.002032 m3/s-m2 (0.4 cfm/sqft) multiplied by the zone floor area and the Maximum Air Flow Rate. This optional field limits the maximum flow allowed in reheat mode. If this field and the previous field are left blank, the maximum flow will not be limited. At no time will the maximum flow rate calculated here exceed the value of Maximum Air Flow Rate.
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0
`design_specification_outdoor_air_object_name_for_control` Design Specification Outdoor Air Object Name for Control	reference		When the name of a DesignSpecification:OutdoorAir object is entered, the terminal unit will increase flow as needed to meet this outdoor air requirement. If Outdoor Air Flow per Person is non-zero, then the outdoor air requirement will be computed based on the current number of occupants in the zone. At no time will the supply air flow rate exceed the value for Maximum Air Flow Rate. If this field is blank, then the terminal unit will not be controlled for outdoor air flow. Note that this field is used only for specifying the design outdoor air flow rate used for control. The field Design Specification Outdoor Air Object Name for Sizing (see below) is used to specify the design outdoor air flow rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum runs through only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum runs through only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`design_specification_outdoor_air_object_name_for_sizing` Design Specification Outdoor Air Object Name for Sizing	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Note that this field is used only for specifying the design outdoor air flow rate used for sizing. The field Design Specification Outdoor Air Object Name for Control (see above) is used to actively control the VAV terminal air flow rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution

HVACTemplate:Zone:VAV:FanPowered¶

from idfpy.models import HVACTemplateZoneVAVFanPowered

Zone terminal unit, fan powered variable volume, reheat optional. Referenced schedules must be defined elsewhere in the idf.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone Name must match a building zone name Names a Zone
`template_vav_system_name` Template VAV System Name required	reference		Enter the name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV object serving this zone. Names a HVACTemplate:System:PackagedVAV, HVACTemplate:System:VAV
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`primary_supply_air_maximum_flow_rate` Primary Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`primary_supply_air_minimum_flow_fraction` Primary Supply Air Minimum Flow Fraction	number or `Autosize`	`Autosize`
`secondary_supply_air_maximum_flow_rate` Secondary Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`flow_type` Flow Type	choice	`Parallel`	One of `Parallel`, `ParallelFromPlenum`, `Series`, `SeriesFromPlenum`
`parallel_fan_on_flow_fraction` Parallel Fan On Flow Fraction	number or `Autosize`	`Autosize`	The fraction of the primary air flow at which fan turns on Applicable only to Parallel Flow Type
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`reheat_coil_type` Reheat Coil Type	choice	`Electric`	One of `Electric`, `Gas`, `HotWater`
`reheat_coil_availability_schedule_name` Reheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fan_total_efficiency` Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`fan_delta_pressure` Fan Delta Pressure	number Pa	`1000.0`	Range: ≥ 0
`fan_motor_efficiency` Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum runs through only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum runs through only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`zone_piu_fan_schedule_name` Zone PIU Fan Schedule Name	reference		This is the operating schedule for the zone PIU fan. For a parallel PIU, the fan operates only when the primary air flow is below the Parallel Fan On Flow Fraction and the Zone PIU Fan Schedule is on, or it is activated by an availability manager. For a series PIU, the zone fan operates whenever the Zone PIU Fan Schedule is on, or it is activated by an availability manager. If this field is left blank, the System Availability Schedule for the HVACTemplate:System serving this zone will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		Names a DesignSpecification:ZoneAirDistribution

HVACTemplate:Zone:VAV:HeatAndCool¶

from idfpy.models import HVACTemplateZoneVAVHeatAndCool

VAV system with VAV for both heating and cooling and optional reheat coil. For heating, this unit increases airflow first, then activates reheat coil.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_vav_system_name` Template VAV System Name required	reference		Name of a HVACTemplate:System:VAV or HVACTemplate:System:PackagedVAV object serving this zone Names a HVACTemplate:System:PackagedVAV, HVACTemplate:System:VAV
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`supply_air_maximum_flow_rate` Supply Air Maximum Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`constant_minimum_air_flow_fraction` Constant Minimum Air Flow Fraction	number	`0.2`	This field is used if the field Zone Minimum Air Flow Input Method is Constant If the field Zone Minimum Air Flow Input Method is Scheduled, then this field is optional. If a value is entered, then it is used for sizing normal-action reheat coils. If both this field and the following field are entered, the larger result is used. Range: ≥ 0, ≤ 1
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name_for_sizing` Design Specification Outdoor Air Object Name for Sizing	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Note that this field is used only for specifying the design outdoor air flow rate used for sizing. The field Design Specification Outdoor Air Object Name for Control (see above) is used to actively control the VAV terminal air flow rate. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`reheat_coil_type` Reheat Coil Type	choice	`None`	One of `Electric`, `Gas`, `HotWater`, `None`
`reheat_coil_availability_schedule_name` Reheat Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_reheat_air_temperature` Maximum Reheat Air Temperature	number C		Specifies the maximum allowable supply air temperature leaving the reheat coil. If left blank, there is no limit and no default. If unknown, 35C (95F) is recommended. Range: > 0
`supply_plenum_name` Supply Plenum Name	reference		Plenum zone name. Supply plenum runs through only this zone. Blank if none. Names a Zone
`return_plenum_name` Return Plenum Name	reference		Plenum zone name. Return plenum runs through only this zone. Blank if none. Names a Zone
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SystemSupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Cooling Coil Design Setpoint One of `SupplyAirTemperature`, `SystemSupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`12.8`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature SystemSupplyAirTemperature = use the value from HVACTemplate:System:VAV Heating Coil Design Setpoint TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.

HVACTemplate:Zone:VRF¶

from idfpy.models import HVACTemplateZoneVRF

Zone terminal unit with variable refrigerant flow (VRF) DX cooling and heating coils (air-to-air or water-to-air heat pump). The VRF terminal units are served by an HVACTemplate:System:VRF system.

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_vrf_system_name` Template VRF System Name required	reference		Name of a HVACTemplate:System:VRF object serving this zone Names a HVACTemplate:System:VRF
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`rated_total_heating_capacity_sizing_ratio` Rated Total Heating Capacity Sizing Ratio	number W/W	`1.0`	If this terminal unit's heating coil is autosized, the heating capacity is sized to be equal to the cooling capacity multiplied by this sizing ratio. This input applies to the terminal unit heating coil and overrides the sizing ratio entered in the HVACTemplate:System:VRF object. Range: ≥ 1
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`no_cooling_supply_air_flow_rate` No Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This flow rate is used when the terminal is not cooling and the previous mode was cooling. This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`no_heating_supply_air_flow_rate` No Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	This flow rate is used when the terminal is not heating and the previous mode was heating. This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`cooling_outdoor_air_flow_rate` Cooling Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`	If this field is set to autosize it will be sized based on the outdoor air inputs below, unless a dedicated outdoor air system is specified for this zone and then it will be set to zero.
`heating_outdoor_air_flow_rate` Heating Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`	If this field is set to autosize it will be sized based on the outdoor air inputs below, unless a dedicated outdoor air system is specified for this zone and then it will be set to zero.
`no_load_outdoor_air_flow_rate` No Load Outdoor Air Flow Rate	number or `Autosize` m3/s	`Autosize`	If this field is set to autosize it will be sized based on the outdoor air inputs below, unless a dedicated outdoor air system is specified for this zone and then it will be set to zero.
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_air_fan_placement` Supply Air Fan placement	choice	`BlowThrough`	Select fan placement as either blow through or draw through. One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`75.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`VariableRefrigerantFlowDX`	One of `None`, `VariableRefrigerantFlowDX`
`cooling_coil_availability_schedule_name` Cooling Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat Rating point: air entering the cooling coil at 26.7 C dry-bulb/19.4 C wet-bulb, and air entering the outdoor condenser coil at 35 C dry-bulb/23.9 C wet-bulb
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`heat_pump_heating_coil_type` Heat Pump Heating Coil Type	choice	`VariableRefrigerantFlowDX`	One of `None`, `VariableRefrigerantFlowDX`
`heat_pump_heating_coil_availability_schedule_name` Heat Pump Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`heat_pump_heating_coil_gross_rated_capacity` Heat Pump Heating Coil Gross Rated Capacity	number or `Autosize` W	`Autosize`	Capacity excluding supply air fan heat Rating point outdoor dry-bulb temp 8.33 C, outdoor wet-bulb temp 6.11 C Rating point heating coil entering air dry-bulb 21.11 C, coil entering wet-bulb 15.55 C
`zone_terminal_unit_on_parasitic_electric_energy_use` Zone Terminal Unit On Parasitic Electric Energy Use	number W	`0.0`	Range: ≥ 0
`zone_terminal_unit_off_parasitic_electric_energy_use` Zone Terminal Unit Off Parasitic Electric Energy Use	number W	`0.0`	Range: ≥ 0
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`14.0`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`

HVACTemplate:Zone:WaterToAirHeatPump¶

from idfpy.models import HVACTemplateZoneWaterToAirHeatPump

Water to Air Heat Pump to be used with HVACTemplate:Plant:MixedWaterLoop

Field	Type	Default	Details
`zone_name` Zone Name required	reference		Zone name must match a building zone name Names a Zone
`template_thermostat_name` Template Thermostat Name	reference		Enter the name of a HVACTemplate:Thermostat object. If blank, then it is assumed that standard thermostat objects have been defined for this zone. Names a HVACTemplate:Thermostat
`cooling_supply_air_flow_rate` Cooling Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during cooling operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`heating_supply_air_flow_rate` Heating Supply Air Flow Rate	number or `Autosize` m3/s	`Autosize`	Supply air flow rate during heating operation This field may be set to "autosize". If a value is entered, it will be multiplied by the Supply Air Sizing Factor and by zone multipliers.
`no_load_supply_air_flow_rate` No Load Supply Air Flow Rate	number or `Autosize` m3/s		Supply air flow rate when no cooling or heating is needed Only used when heat pump fan operating mode is continuous. This air flow rate is used when no heating or cooling is required. If this field is left blank or zero, the supply air flow rate from the previous on cycle (either cooling or heating) is used. A value entered in this field will not be multiplied by the sizing factor or by zone multipliers. It is best to autosize or leave blank when using zone multipliers.
`zone_heating_sizing_factor` Zone Heating Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`zone_cooling_sizing_factor` Zone Cooling Sizing Factor	number		If blank, value from Sizing:Parameters will be used. Range: ≥ 0
`outdoor_air_method` Outdoor Air Method	choice	`Flow/Person`	Flow/Person, Flow/Zone, Flow/Area, Sum, and Maximum use the values in the next three fields: Outdoor Air Flow Rate per Person, Outdoor Air Flow Rate per Zone Floor Area, and Outdoor Air Flow Rate per Zone. DetailedSpecification ignores these three Outdoor Air Flow Rate fields and instead references design specification objects named in the fields Design Specification Outdoor Air Object Name and Design Specification Zone Air Distribution Object Name. One of `DetailedSpecification`, `Flow/Area`, `Flow/Person`, `Flow/Zone`, `Maximum`, `Sum`
`outdoor_air_flow_rate_per_person` Outdoor Air Flow Rate per Person	number m3/s	`0.00944`	Default 0.00944 is 20 cfm per person This input is used if the field Outdoor Air Method is Flow/Person, Sum, or Maximum
`outdoor_air_flow_rate_per_zone_floor_area` Outdoor Air Flow Rate per Zone Floor Area	number m3/s-m2	`0.0`	This input is used if the field Outdoor Air Method is Flow/Area, Sum, or Maximum
`outdoor_air_flow_rate_per_zone` Outdoor Air Flow Rate per Zone	number m3/s	`0.0`	This input is used if the field Outdoor Air Method is Flow/Zone, Sum, or Maximum
`system_availability_schedule_name` System Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_operating_mode_schedule_name` Supply Fan Operating Mode Schedule Name	reference		Refers to a schedule to specify unitary supply fan operating mode. Schedule values of 0 indicate cycling fan (auto) Schedule values of 1 indicate continuous fan (on) If this field is left blank, a schedule of always zero (cycling fan) will be used. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supply_fan_placement` Supply Fan Placement	choice	`DrawThrough`	One of `BlowThrough`, `DrawThrough`
`supply_fan_total_efficiency` Supply Fan Total Efficiency	number	`0.7`	Range: > 0, ≤ 1
`supply_fan_delta_pressure` Supply Fan Delta Pressure	number Pa	`75.0`	Range: ≥ 0
`supply_fan_motor_efficiency` Supply Fan Motor Efficiency	number	`0.9`	Range: > 0, ≤ 1
`cooling_coil_type` Cooling Coil Type	choice	`Coil:Cooling:WaterToAirHeatPump:EquationFit`	One of `Coil:Cooling:WaterToAirHeatPump:EquationFit`
`cooling_coil_gross_rated_total_capacity` Cooling Coil Gross Rated Total Capacity	number or `Autosize` W	`Autosize`	Total cooling capacity not accounting for the effect of supply air fan heat
`cooling_coil_gross_rated_sensible_heat_ratio` Cooling Coil Gross Rated Sensible Heat Ratio	number or `Autosize`	`Autosize`	Rated sensible heat ratio (gross sensible capacity/gross total capacity) Sensible and total capacities do not include effect of supply fan heat
`cooling_coil_gross_rated_cop` Cooling Coil Gross Rated COP	number W/W	`3.5`	Gross cooling capacity divided by power input to the compressor and outdoor fan, does not include supply fan heat or supply fan electric power input Range: > 0
`heat_pump_heating_coil_type` Heat Pump Heating Coil Type	choice	`Coil:Heating:WaterToAirHeatPump:EquationFit`	One of `Coil:Heating:WaterToAirHeatPump:EquationFit`
`heat_pump_heating_coil_gross_rated_capacity` Heat Pump Heating Coil Gross Rated Capacity	number or `Autosize` W	`Autosize`	Capacity excluding supply air fan heat
`heat_pump_heating_coil_gross_rated_cop` Heat Pump Heating Coil Gross Rated COP	number W/W	`4.2`	Heat Pump Heating Coil Rated Capacity divided by power input to the compressor and outdoor fan, does not include supply air fan heat or supply air fan electric power input Range: > 0
`supplemental_heating_coil_availability_schedule_name` Supplemental Heating Coil Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`supplemental_heating_coil_capacity` Supplemental Heating Coil Capacity	number or `Autosize` W	`Autosize`
`maximum_cycling_rate` Maximum Cycling Rate	number cycles/hr	`2.5`	The maximum on-off cycling rate for the compressor Suggested value is 2.5 for a typical heat pump Range: ≥ 0, ≤ 5
`latent_capacity_time_constant` Latent Capacity Time Constant	number s	`60.0`	Time constant for the cooling coil's capacity to reach steady state after startup Suggested value is 60 for a typical heat pump Range: ≥ 0, ≤ 500
`heat_pump_fan_delay_time` Heat Pump Fan Delay Time	number s	`60.0`	Programmed time delay for heat pump fan to shut off after compressor cycle off. Only required when fan operating mode is cycling Enter 0 when fan operating mode is continuous Range: ≥ 0
`dedicated_outdoor_air_system_name` Dedicated Outdoor Air System Name	reference		Enter the name of an HVACTemplate:System:DedicatedOutdoorAir object if this zone is served by a separate dedicated outdoor air system (DOAS). Leave field blank if no DOAS serves this zone. Names a HVACTemplate:System:DedicatedOutdoorAir
`supplemental_heating_coil_type` Supplemental Heating Coil Type	choice	`Electric`	One of `Electric`, `HotWater`
`zone_cooling_design_supply_air_temperature_input_method` Zone Cooling Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Cooling Design Supply Air Temperature TemperatureDifference = use the value from Zone Cooling Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_cooling_design_supply_air_temperature` Zone Cooling Design Supply Air Temperature	number C	`14.0`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_cooling_design_supply_air_temperature_difference` Zone Cooling Design Supply Air Temperature Difference	number deltaC	`11.11`	Zone Cooling Design Supply Air Temperature is only used when Zone Cooling Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be subtracted from the zone temperature at peak load to calculate the Zone Cooling Design Supply Air Temperature.
`zone_heating_design_supply_air_temperature_input_method` Zone Heating Design Supply Air Temperature Input Method	choice	`SupplyAirTemperature`	SupplyAirTemperature = use the value from Zone Heating Design Supply Air Temperature TemperatureDifference = use the value from Zone Heating Design Supply Air Temperature Difference One of `SupplyAirTemperature`, `TemperatureDifference`
`zone_heating_design_supply_air_temperature` Zone Heating Design Supply Air Temperature	number C	`50.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = SupplyAirTemperature
`zone_heating_design_supply_air_temperature_difference` Zone Heating Design Supply Air Temperature Difference	number deltaC	`30.0`	Zone Heating Design Supply Air Temperature is only used when Zone Heating Design Supply Air Temperature Input Method = TemperatureDifference The absolute value of this field will be added to the zone temperature at peak load to calculate the Zone Heating Design Supply Air Temperature.
`heat_pump_coil_water_flow_mode` Heat Pump Coil Water Flow Mode	choice	`Cycling`	used only when the heat pump coils are of the type WaterToAirHeatPump:EquationFit Constant results in 100% water flow regardless of compressor PLR Cycling results in water flow that matches compressor PLR ConstantOnDemand results in 100% water flow whenever the coil is on, but is 0% whenever the coil has no load One of `Constant`, `ConstantOnDemand`, `Cycling`
`design_specification_outdoor_air_object_name` Design Specification Outdoor Air Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:OutdoorAir, DesignSpecification:OutdoorAir:SpaceList
`design_specification_zone_air_distribution_object_name` Design Specification Zone Air Distribution Object Name	reference		This field is used only when Outdoor Air Method=DetailedSpecification. Names a DesignSpecification:ZoneAirDistribution
`baseboard_heating_type` Baseboard Heating Type	choice	`None`	One of `Electric`, `HotWater`, `None`
`baseboard_heating_availability_schedule_name` Baseboard Heating Availability Schedule Name	reference		If blank, always on Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`baseboard_heating_capacity` Baseboard Heating Capacity	number or `Autosize` W	`Autosize`