Internal Gains¶

36 object types from idfpy.models.internal_gains · EnergyPlus 26.2

Object	Summary
ComfortViewFactorAngles	Used to specify radiant view factors for thermal comfort calculations.
ElectricEquipment	Sets internal gains for electric equipment in the zone.
ElectricEquipment:Definition	Defines the physical characteristics (design level and heat gain fractions) for electric equipment.
ElectricEquipment:ITE:AirCooled	This object describes air-cooled electric information technology equipment (ITE) which has variable power …
ElectricEquipment:ITE:AirCooled:Definition	Performance characteristics for ElectricEquipment:ITE:AirCooled:Instance.
ElectricEquipment:ITE:AirCooled:Instance	This object describes air-cooled electric information technology equipment (ITE) which has variable power …
ElectricEquipment:Instance	Sets internal gains for electric equipment in the zone.
GasEquipment	Sets internal gains and contaminant rates for gas equipment in the zone.
GasEquipment:Definition	Defines the physical characteristics (design level and heat gain fractions) for gas equipment.
GasEquipment:Instance	Sets internal gains and contaminant rates for gas equipment in the zone.
HotWaterEquipment	Sets internal gains for hot water equipment in the zone.
HotWaterEquipment:Definition	Defines the physical characteristics (design level and heat gain fractions) for hot water equipment.
HotWaterEquipment:Instance	Sets internal gains for hot water equipment in the zone.
IndoorLivingWall	Indoor greenery systems such as indoor living walls are panels of plants, which grow hydroponically or from …
Lights	Sets internal gains for lights in the zone.
Lights:Definition	Defines the physical characteristics (design level and heat gain fractions) for lights.
Lights:Instance	Sets internal gains for lights in the zone.
OtherEquipment	Sets internal gains or losses for "other" equipment in the zone.
OtherEquipment:Definition	Defines the physical characteristics (design level and heat gain fractions) for "other" equipment.
OtherEquipment:Instance	Sets internal gains or losses for "other" equipment in the zone.
People	Sets internal gains and contaminant rates for occupants in the zone.
People:Definition	Defines the physical characteristics (number of people, heat gain fractions, CO2 generation rate and thermal …
People:Instance	Sets internal gains and contaminant rates for occupants in the zone.
SteamEquipment	Sets internal gains for steam equipment in the zone.
SteamEquipment:Definition	Defines the physical characteristics (design level and heat gain fractions) for steam equipment.
SteamEquipment:Instance	Sets internal gains for steam equipment in the zone.
SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion	Simulate generic contaminant source driven by the boundary layer diffusion controlled model.
SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink	Simulate generic contaminant source driven by the boundary layer diffusion controlled model.
SurfaceContaminantSourceAndSink:Generic:PressureDriven	Simulate generic contaminant source driven by the pressure difference across a surface.
SwimmingPool:Indoor	Specifies an indoor swimming pools linked to a floor surface.
ZoneBaseboard:OutdoorTemperatureControlled	Specifies outside temperature-controlled electric baseboard heating.
ZoneContaminantSourceAndSink:CarbonDioxide	Represents internal CO2 gains and sinks in the zone.
ZoneContaminantSourceAndSink:Generic:Constant	Sets internal generic contaminant gains and sinks in a zone with constant values.
ZoneContaminantSourceAndSink:Generic:CutoffModel	Simulate generic contaminant source driven by the cutoff concentration model.
ZoneContaminantSourceAndSink:Generic:DecaySource	Simulate generic contaminant source driven by the cutoff concentration model.
ZoneContaminantSourceAndSink:Generic:DepositionRateSink	Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

ComfortViewFactorAngles¶

from idfpy.models import ComfortViewFactorAngles extensible

Used to specify radiant view factors for thermal comfort calculations. Note that the following angle factor fractions must sum up to 1.0 All surfaces must be in the same enclosure.

Field	Type	Default	Details
`name` Name	string
`angles`	list		Each item: `surface_name`, `angle_factor`

Referenced by 2 object types

People, People:Instance

ElectricEquipment¶

from idfpy.models import ElectricEquipment

Sets internal gains for electric equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in schedule should be fraction applied to design level of electric equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of electric equipment for this set of attributes Choices: EquipmentLevel => Equipment Level -- simply enter watts of equipment Watts/Area => Watts per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`watts_per_person` Watts per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 1 object types

DemandManager:ElectricEquipment

ElectricEquipment:Definition¶

from idfpy.models import ElectricEquipmentDefinition

Defines the physical characteristics (design level and heat gain fractions) for electric equipment. Referenced by one or more ElectricEquipment:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of electric equipment for this set of attributes Choices: EquipmentLevel => Equipment Level -- simply enter watts of equipment Watts/Area => Watts per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`watts_per_person` Watts per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1

Referenced by 1 object types

ElectricEquipment:Instance

ElectricEquipment:ITE:AirCooled¶

from idfpy.models import ElectricEquipmentITEAirCooled

This object describes air-cooled electric information technology equipment (ITE) which has variable power consumption as a function of loading and temperature. If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_space_name` Zone or Space Name required	reference		ZoneList and SpaceList names are not allowed. Names a Space, Zone
`air_flow_calculation_method` Air Flow Calculation Method	choice	`FlowFromSystem`	The specified method is used to calculate the IT inlet temperature and zone return air temperature. If FlowFromSystem is chosen, the zone is assumed to be well-mixed. If FlowControlWithApproachTemperatures is chosen, Supply and Return approach temperature should be defined to indicate the temperature difference due to the air distribution. When FlowControlWithApproachTemperatures is chosen, the inputs of Air Inlet Connection Type, Design Recirculation Fraction and Recirculation Function of Loading and Supply Temperature Curve Name are ignored. For multiple ITE objects defined for one zone, the same calculation method should apply. The FlowControlWithApproachTemperatures only applies to ITE zones with single duct VAV terminal unit. Other return air heat gains from window or lights are not allowed when FlowControlWithApproachTemperatures is chosen. When FlowControlWithApproachTemperatures is chosen, the controlled variable is the supply air temperature, not the well-mixed zone air temperature. The zone cooling setpoint from ZoneControl:Thermostat is ignored for this zone and cooling unmet hours do not apply. One of `FlowControlWithApproachTemperatures`, `FlowFromSystem`
`design_power_input_calculation_method` Design Power Input Calculation Method	choice	`Watts/Unit`	The entered calculation method is used to specify the design power input Watts/Unit => Watts per Unit -- Design Power = Watts per Unit * Number of Units Watts/Area => Watts per Floor Area -- Design Power = Watts per Floor Area * Floor Area One of `Watts/Area`, `Watts/Unit`
`watts_per_unit` Watts per Unit	number W		Range: ≥ 0
`number_of_units` Number of Units	number	`1.0`	Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`design_power_input_schedule_name` Design Power Input Schedule Name	reference		Operating schedule for this equipment, fraction applied to the design power input, generally (0.0 - 1.0) If this field is blank, the schedule is assumed to always be 1.0. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cpu_loading_schedule_name` CPU Loading Schedule Name	reference		CPU loading schedule for this equipment as a fraction from 0.0 (idle) to 1.0 (full load). If this field is blank, the schedule is assumed to always be 1.0. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cpu_power_input_function_of_loading_and_air_temperature_curve_name` CPU Power Input Function of Loading and Air Temperature Curve Name required	reference		The name of a two-variable curve or table lookup object which modifies the CPU power input as a function of CPU loading (x) and air inlet node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature). Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`design_fan_power_input_fraction` Design Fan Power Input Fraction	number	`0.0`	The fraction of the total power input at design conditions which is for the cooling fan(s) Range: ≥ 0, ≤ 1
`design_fan_air_flow_rate_per_power_input` Design Fan Air Flow Rate per Power Input required	number m3/s-W		The cooling fan air flow rate per total electric power input at design conditions Range: ≥ 0
`air_flow_function_of_loading_and_air_temperature_curve_name` Air Flow Function of Loading and Air Temperature Curve Name required	reference		The name of a two-variable curve or table lookup object which modifies the cooling air flow rate as a function of CPU loading (x) and air inlet node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature). Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fan_power_input_function_of_flow_curve_name` Fan Power Input Function of Flow Curve Name required	reference		The name of a single-variable curve or table lookup object which modifies the cooling fan power as a function of flow fraction (x). This curve (table) should equal 1.0 at a flow fraction of 1.0. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`design_entering_air_temperature` Design Entering Air Temperature	number C	`15.0`	The entering air temperature at design conditions.
`environmental_class` Environmental Class	choice	`None`	Specifies the allowable operating conditions for the air inlet conditions. Used for reporting time outside allowable conditions. One of `A1`, `A2`, `A3`, `A4`, `B`, `C`, `H1`, `None`
`air_inlet_connection_type` Air Inlet Connection Type	choice	`AdjustedSupply`	Specifies the type of connection between the zone and the ITE air inlet node. AdjustedSupply = ITE inlet temperature will be the current Supply Air Node temperature adjusted by the current recirculation fraction. All heat output is added to the zone air heat balance as a convective gain. ZoneAirNode = ITE air inlet condition is the average zone condition. All heat output is added to the zone air heat balance as a convective gain. RoomAirModel = ITE air inlet and outlet are connected to room air model nodes. This field is only used when Air Flow Calculation Method is FlowFromSystem. One of `AdjustedSupply`, `RoomAirModel`, `ZoneAirNode`
`air_inlet_room_air_model_node_name` Air Inlet Room Air Model Node Name	reference		Name of a RoomAir:Node object which is connected to the ITE air inlet. Names a RoomAir:Node
`air_outlet_room_air_model_node_name` Air Outlet Room Air Model Node Name	reference		Name of a RoomAir:Node object which is connected to the ITE air outlet. Names a RoomAir:Node
`supply_air_node_name` Supply Air Node Name	string		Name of the supply air inlet node serving this ITE. Required if the Air Node Connection Type = AdjustedSupply. Also required if Calculation Method = FlowControlWithApproachTemperatures. Also required if reporting of Supply Heat Index is desired.
`design_recirculation_fraction` Design Recirculation Fraction	number	`0.0`	The recirculation fraction for this equipment at design conditions. This field is used only if the Air Node Connection Type = AdjustedSupply. The default is 0.0 (no recirculation). This field is only used when Air Flow Calculation Method is FlowFromSystem. Range: ≥ 0, ≤ 0.5
`recirculation_function_of_loading_and_supply_temperature_curve_name` Recirculation Function of Loading and Supply Temperature Curve Name	reference		The name of a two-variable curve or table lookup object which modifies the recirculation fraction as a function of CPU loading (x) and supply air node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature).This field is used only if the Air Node Connection Type = AdjustedSupply. If this curve is left blank, then the curve is assumed to always equal 1.0. This field is only used when Air Flow Calculation Method is FlowFromSystem. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`design_electric_power_supply_efficiency` Design Electric Power Supply Efficiency	number	`1.0`	The efficiency of the power supply system serving this ITE Range: > 0, ≤ 1
`electric_power_supply_efficiency_function_of_part_load_ratio_curve_name` Electric Power Supply Efficiency Function of Part Load Ratio Curve Name	reference		The name of a single-variable curve or table lookup object which modifies the electric power supply efficiency as a function of part-load ratio (x). This curve (table) should equal 1.0 at full load (PLR = 1.0). If this curve is left blank, then the curve is assumed to always equal 1.0. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`fraction_of_electric_power_supply_losses_to_zone` Fraction of Electric Power Supply Losses to Zone	number	`1.0`	Fraction of the electric power supply losses which are a heat gain to the zone If this field is <1.0, the remainder of the losses are assumed to be lost to the outdoors. Range: ≥ 0, ≤ 1
`cpu_end_use_subcategory` CPU End-Use Subcategory	string	`ITE-CPU`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`fan_end_use_subcategory` Fan End-Use Subcategory	string	`ITE-Fans`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`electric_power_supply_end_use_subcategory` Electric Power Supply End-Use Subcategory	string	`ITE-UPS`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`supply_temperature_difference` Supply Temperature Difference	number deltaC		The difference of the IT inlet temperature from the AHU supply air temperature. Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem.
`supply_temperature_difference_schedule` Supply Temperature Difference Schedule	reference		The difference schedule of the IT inlet temperature from the AHU supply air temperature. Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`return_temperature_difference` Return Temperature Difference	number deltaC		The difference of the the actual AHU return air temperature to the IT equipment outlet temperature. Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem.
`return_temperature_difference_schedule` Return Temperature Difference Schedule	reference		The difference schedule of the actual AHU return air temperature to the IT equipment outlet temperature. Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

ElectricEquipment:ITE:AirCooled:Definition¶

from idfpy.models import ElectricEquipmentITEAirCooledDefinition

Performance characteristics for ElectricEquipment:ITE:AirCooled:Instance. Defines power, airflow, and efficiency as functions of loading and temperature.

Field	Type	Default	Details
`name` Name required	string
`air_flow_calculation_method` Air Flow Calculation Method	choice	`FlowFromSystem`	The specified method is used to calculate the IT inlet temperature and zone return air temperature. If FlowFromSystem is chosen, the zone is assumed to be well-mixed. If FlowControlWithApproachTemperatures is chosen, Supply and Return approach temperature should be defined to indicate the temperature difference due to the air distribution. When FlowControlWithApproachTemperatures is chosen, the inputs of Air Inlet Connection Type, Design Recirculation Fraction and Recirculation Function of Loading and Supply Temperature Curve Name are ignored. For multiple ITE objects defined for one zone, the same calculation method should apply. The FlowControlWithApproachTemperatures only applies to ITE zones with single duct VAV terminal unit. Other return air heat gains from window or lights are not allowed when FlowControlWithApproachTemperatures is chosen. One of `FlowControlWithApproachTemperatures`, `FlowFromSystem`
`design_power_input_calculation_method` Design Power Input Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to specify the design power input Choices: EquipmentLevel => Equipment Level -- simply enter watts of equipment Watts/Area => Watts per Floor Area -- Design Power = Watts per Floor Area * Floor Area One of `EquipmentLevel`, `Watts/Area`
`watts_per_unit` Watts per Unit	number W		Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`cpu_power_input_function_of_loading_and_air_temperature_curve_name` CPU Power Input Function of Loading and Air Temperature Curve Name required	reference		The name of a two-variable curve or table lookup object which modifies the CPU power input as a function of CPU loading (x) and air inlet node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature). Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`design_fan_power_input_fraction` Design Fan Power Input Fraction	number	`0.0`	The fraction of the total power input at design conditions which is for the cooling fan(s) Range: ≥ 0, ≤ 1
`design_fan_air_flow_rate_per_power_input` Design Fan Air Flow Rate per Power Input required	number m3/s-W		The cooling fan air flow rate per total electric power input at design conditions Range: ≥ 0
`air_flow_function_of_loading_and_air_temperature_curve_name` Air Flow Function of Loading and Air Temperature Curve Name required	reference		The name of a two-variable curve or table lookup object which modifies the cooling air flow rate as a function of CPU loading (x) and air inlet node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature). Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`fan_power_input_function_of_flow_curve_name` Fan Power Input Function of Flow Curve Name required	reference		The name of a single-variable curve or table lookup object which modifies the cooling fan power as a function of flow fraction (x). This curve (table) should equal 1.0 at a flow fraction of 1.0. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`design_entering_air_temperature` Design Entering Air Temperature	number C	`15.0`	The entering air temperature at design conditions.
`environmental_class` Environmental Class	choice	`None`	Specifies the allowable operating conditions for the air inlet conditions. Used for reporting time outside allowable conditions. One of `A1`, `A2`, `A3`, `A4`, `B`, `C`, `H1`, `None`
`air_inlet_connection_type` Air Inlet Connection Type	choice	`AdjustedSupply`	Specifies the type of connection between the zone and the ITE air inlet node. AdjustedSupply = ITE inlet temperature will be the current Supply Air Node temperature adjusted by the current recirculation fraction. All heat output is added to the zone air heat balance as a convective gain. ZoneAirNode = ITE air inlet condition is the average zone condition. All heat output is added to the zone air heat balance as a convective gain. RoomAirModel = ITE air inlet and outlet are connected to room air model nodes. This field is only used when Air Flow Calculation Method is FlowFromSystem. One of `AdjustedSupply`, `RoomAirModel`, `ZoneAirNode`
`design_recirculation_fraction` Design Recirculation Fraction	number	`0.0`	The recirculation fraction for this equipment at design conditions. This field is used only if the Air Node Connection Type = AdjustedSupply. The default is 0.0 (no recirculation). This field is only used when Air Flow Calculation Method is FlowFromSystem. Range: ≥ 0, ≤ 0.5
`recirculation_function_of_loading_and_supply_temperature_curve_name` Recirculation Function of Loading and Supply Temperature Curve Name	reference		The name of a two-variable curve or table lookup object which modifies the recirculation fraction as a function of CPU loading (x) and supply air node temperature (y). This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and Design Entering Air Temperature). This field is used only if the Air Node Connection Type = AdjustedSupply. If this curve is left blank, then the curve is assumed to always equal 1.0. This field is only used when Air Flow Calculation Method is FlowFromSystem. Names a Curve:Bicubic, Curve:Biquadratic, Curve:CubicLinear, Curve:FanPressureRise, Curve:QuadraticLinear, Table:Lookup
`design_electric_power_supply_efficiency` Design Electric Power Supply Efficiency	number	`1.0`	The efficiency of the power supply system serving this ITE Range: > 0, ≤ 1
`electric_power_supply_efficiency_function_of_part_load_ratio_curve_name` Electric Power Supply Efficiency Function of Part Load Ratio Curve Name	reference		The name of a single-variable curve or table lookup object which modifies the electric power supply efficiency as a function of part-load ratio (x). This curve (table) should equal 1.0 at full load (PLR = 1.0). If this curve is left blank, then the curve is assumed to always equal 1.0. Names a Curve:Cubic, Curve:DoubleExponentialDecay, Curve:Exponent, Curve:ExponentialDecay, Curve:ExponentialSkewNormal, Curve:Functional:PressureDrop, Curve:Linear, Curve:Quadratic, Curve:Quartic, Curve:RectangularHyperbola1, Curve:RectangularHyperbola2, Curve:Sigmoid and 1 more
`fraction_of_electric_power_supply_losses_to_zone` Fraction of Electric Power Supply Losses to Zone	number	`1.0`	Fraction of the electric power supply losses which are a heat gain to the zone If this field is <1.0, the remainder of the losses are assumed to be lost to the outdoors. Range: ≥ 0, ≤ 1
`supply_temperature_difference` Supply Temperature Difference	number deltaC		The difference of the IT inlet temperature from the AHU supply air temperature. Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem.
`supply_temperature_difference_schedule` Supply Temperature Difference Schedule	reference		The difference schedule of the IT inlet temperature from the AHU supply air temperature. Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`return_temperature_difference` Return Temperature Difference	number deltaC		The difference of the actual AHU return air temperature to the IT equipment outlet temperature. Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem.
`return_temperature_difference_schedule` Return Temperature Difference Schedule	reference		The difference schedule of the actual AHU return air temperature to the IT equipment outlet temperature. Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. This field is ignored when Air Flow Calculation Method is FlowFromSystem. 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 1 object types

ElectricEquipment:ITE:AirCooled:Instance

ElectricEquipment:ITE:AirCooled:Instance¶

from idfpy.models import ElectricEquipmentITEAirCooledInstance

This object describes air-cooled electric information technology equipment (ITE) which has variable power consumption as a function of loading and temperature. The performance characteristics are given by the referenced ElectricEquipment:ITE:AirCooled:Definition object. If a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`electricequipment_ite_aircooled_definition_name` ElectricEquipment ITE AirCooled Definition Name required	reference		Names a ElectricEquipment:ITE:AirCooled:Definition
`zone_or_space_name` Zone or Space Name required	reference		ZoneList and SpaceList names are not allowed. Names a Space, Zone
`multiplier` Multiplier	number	`1.0`	Multiplies the design power input from the referenced definition. Range: ≥ 0
`design_power_input_schedule_name` Design Power Input Schedule Name	reference		Operating schedule for this equipment, fraction applied to the design power input, generally (0.0 - 1.0) If this field is blank, the schedule is assumed to always be 1.0. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cpu_loading_schedule_name` CPU Loading Schedule Name	reference		CPU loading schedule for this equipment as a fraction from 0.0 (idle) to 1.0 (full load). If this field is blank, the schedule is assumed to always be 1.0. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_inlet_room_air_model_node_name` Air Inlet Room Air Model Node Name	reference		Name of a RoomAir:Node object which is connected to the ITE air inlet. Names a RoomAir:Node
`air_outlet_room_air_model_node_name` Air Outlet Room Air Model Node Name	reference		Name of a RoomAir:Node object which is connected to the ITE air outlet. Names a RoomAir:Node
`supply_air_node_name` Supply Air Node Name	string		Name of the supply air inlet node serving this ITE. Required if the Air Node Connection Type = AdjustedSupply (set in the Definition). Also required if Air Flow Calculation Method = FlowControlWithApproachTemperatures (set in the Definition). Also required if reporting of Supply Heat Index is desired.
`cpu_end_use_subcategory` CPU End-Use Subcategory	string	`ITE-CPU`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`fan_end_use_subcategory` Fan End-Use Subcategory	string	`ITE-Fans`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`electric_power_supply_end_use_subcategory` Electric Power Supply End-Use Subcategory	string	`ITE-UPS`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

ElectricEquipment:Instance¶

from idfpy.models import ElectricEquipmentInstance

Sets internal gains for electric equipment in the zone. The physical characteristics are given by the referenced ElectricEquipment:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`electric_equipment_definition_name` Electric Equipment Definition Name required	reference		Names a ElectricEquipment:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in schedule should be fraction applied to design level of electric equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

Referenced by 1 object types

DemandManager:ElectricEquipment

GasEquipment¶

from idfpy.models import GasEquipment

Sets internal gains and contaminant rates for gas equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of gas equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of gas equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`0.0`	CO2 generation rate per unit of power input The default value assumes the equipment is fully vented. For unvented equipment, a suggested value is 3.45E-8 m3/s-W. This value is converted from a natural gas CO2 emission rate of 117 lbs CO2 per million Btu. The maximum value assumes to be 10 times of the recommended value. Range: ≥ 0, ≤ 4e-07
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

GasEquipment:Definition¶

from idfpy.models import GasEquipmentDefinition

Defines the physical characteristics (design level and heat gain fractions) for gas equipment. Referenced by one or more GasEquipment:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of gas equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`0.0`	CO2 generation rate per unit of power input The default value assumes the equipment is fully vented. For unvented equipment, a suggested value is 3.45E-8 m3/s-W. This value is converted from a natural gas CO2 emission rate of 117 lbs CO2 per million Btu. The maximum value assumes to be 10 times of the recommended value. Range: ≥ 0, ≤ 4e-07

Referenced by 1 object types

GasEquipment:Instance

GasEquipment:Instance¶

from idfpy.models import GasEquipmentInstance

Sets internal gains and contaminant rates for gas equipment in the zone. The physical characteristics are given by the referenced GasEquipment:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`gas_equipment_definition_name` Gas Equipment Definition Name required	reference		Names a GasEquipment:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of gas equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

HotWaterEquipment¶

from idfpy.models import HotWaterEquipment

Sets internal gains for hot water equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of hot water equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of hot water equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

HotWaterEquipment:Definition¶

from idfpy.models import HotWaterEquipmentDefinition

Defines the physical characteristics (design level and heat gain fractions) for hot water equipment. Referenced by one or more HotWaterEquipment:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of hot water equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1

Referenced by 1 object types

HotWaterEquipment:Instance

HotWaterEquipment:Instance¶

from idfpy.models import HotWaterEquipmentInstance

Sets internal gains for hot water equipment in the zone. The physical characteristics are given by the referenced HotWaterEquipment:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`hot_water_equipment_definition_name` Hot Water Equipment Definition Name required	reference		Names a HotWaterEquipment:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of hot water equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

IndoorLivingWall¶

from idfpy.models import IndoorLivingWall

Indoor greenery systems such as indoor living walls are panels of plants, which grow hydroponically or from substrates. The living wall structures can be either free-standing or attached to walls. The IndoorLivingWall module directly connects with inside surface heat balance, zone air heat balance, and zone air moisture balance.

Field	Type	Default	Details
`name` Name required	string
`surface_name` Surface Name required	reference		Name of the wall partition where indoor green is located. Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of other equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`evapotranspiration_calculation_method` Evapotranspiration Calculation Method	choice	`Penman-Monteith`	Model selection for calculating evapotranspiration of indoor greenery system. This rate can also be actuated with user-defined calculations, see EMS application guide for actuator details. One of `Penman-Monteith`, `Stanghellini`
`lighting_method` Lighting Method	choice		Three different methods are provided here (LED; Daylight; LED-Daylight) One of `Daylight`, `LED`, `LED-Daylight`
`led_intensity_schedule_name` LED Intensity Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`daylighting_control_name` Daylighting Control Name	string		If daylighting is used in the selected lighting methods (Daylight or LED-Daylight), users should define an object of Daylighting:Control to obtain the daylighting illuminance level and an object for Daylighting:ReferencePoint for the daylighting sensor location in the thermal zone. The name of the object of Daylighting:Controls should be specified in this field.
`led_daylight_targeted_lighting_intensity_schedule_name` LED-Daylight Targeted Lighting Intensity Schedule Name	reference		This field defines targeted LED intensity level for indoor living wall systems. The schedule values can be any positive number representing targeted photosynthetic photon flux density (PPFD). Based on the available daylighting, the required LED lighting level and power will be automatically adjusted to meet the targeted LED intensity level. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`total_leaf_area` Total Leaf Area	number m2		The value is the one-sided leaf area of an indoor living wall. Based on the users’ input, LAI is calculated as the ratio of the total leaf area and the partition wall area. Typical LAIs are 1.0 for grass and 3.0 for bushes and shrubs. The maximum LAI is 2.0 for the IndoorLivingWall module in EnergyPlus. If the calculated LAI is greater than 2.0, the maximum value of 2.0 is used for LAI in the simulation.
`led_nominal_intensity` LED Nominal Intensity	number umol/m2-s		The value represents photosynthetic photon flux density (PPFD) of LED grow light. PPFD is measured in micro-mole per m2 per second (umol/m2-s) which establishes exactly how many photosynthetically active radiation (PAR) photons are landing on a specific area.
`led_nominal_power` LED Nominal Power	number W		This field defines nominal total LED power for an indoor living wall system.
`radiant_fraction_of_led_lights` Radiant Fraction of LED Lights	number	`0.6`	This field defines the fraction of radiation from LED lights Range: ≥ 0, ≤ 1

Lights¶

from idfpy.models import Lights

Sets internal gains for lights in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in schedule should be fraction applied to design level of lights, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`LightingLevel`	The entered calculation method is used to create the maximum amount of lights for this set of attributes Choices: LightingLevel => Lighting Level -- simply enter watts of lights Watts/Area => Watts per Floor Area -- enter the number to apply. Value * Floor Area = Lights Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Lights One of `LightingLevel`, `Watts/Area`, `Watts/Person`
`lighting_level` Lighting Level	number W		Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`watts_per_person` Watts per Person	number W/person		Range: ≥ 0
`return_air_fraction` Return Air Fraction	number	`0.0`	Used only for sizing calculation if return-air-fraction coefficients are specified. Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_visible` Fraction Visible	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_replaceable` Fraction Replaceable	number	`1.0`	For Daylighting:Controls must be 0 or 1: 0 = no dimming control, 1 = full dimming control Range: ≥ 0, ≤ 1
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`return_air_fraction_calculated_from_plenum_temperature` Return Air Fraction Calculated from Plenum Temperature	choice	`No`	One of `No`, `Yes`
`return_air_fraction_function_of_plenum_temperature_coefficient_1` Return Air Fraction Function of Plenum Temperature Coefficient 1	number	`0.0`	Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) Range: ≥ 0
`return_air_fraction_function_of_plenum_temperature_coefficient_2` Return Air Fraction Function of Plenum Temperature Coefficient 2	number 1/K	`0.0`	Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) Range: ≥ 0
`return_air_heat_gain_node_name` Return Air Heat Gain Node Name	string		Name of the return air node for this heat gain. If left blank, defaults to the first return air node for the zone. Leave this field blank when using a ZoneList name.
`exhaust_air_heat_gain_node_name` Exhaust Air Heat Gain Node Name	string		Name of the exhaust air node for this heat gain. If the node name is entered, return heat gain will be shared by both return and exhaust air nodes. The air properties of both nodes are weighted by both node mass flow rates.

Referenced by 1 object types

DemandManager:Lights

Lights:Definition¶

from idfpy.models import LightsDefinition

Defines the physical characteristics (design level and heat gain fractions) for lights. Referenced by one or more Lights:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`LightingLevel`	The entered calculation method is used to create the maximum amount of lights for this set of attributes Choices: LightingLevel => Lighting Level -- simply enter watts of lights Watts/Area => Watts per Floor Area -- enter the number to apply. Value * Floor Area = Lights Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Lights One of `LightingLevel`, `Watts/Area`, `Watts/Person`
`lighting_level` Lighting Level	number W		Range: ≥ 0
`watts_per_floor_area` Watts per Floor Area	number W/m2		Range: ≥ 0
`watts_per_person` Watts per Person	number W/person		Range: ≥ 0
`return_air_fraction` Return Air Fraction	number	`0.0`	Used only for sizing calculation if return-air-fraction coefficients are specified. Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_visible` Fraction Visible	number	`0.0`	Range: ≥ 0, ≤ 1
`return_air_fraction_calculated_from_plenum_temperature` Return Air Fraction Calculated from Plenum Temperature	choice	`No`	One of `No`, `Yes`
`return_air_fraction_function_of_plenum_temperature_coefficient_1` Return Air Fraction Function of Plenum Temperature Coefficient 1	number	`0.0`	Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) Range: ≥ 0
`return_air_fraction_function_of_plenum_temperature_coefficient_2` Return Air Fraction Function of Plenum Temperature Coefficient 2	number 1/K	`0.0`	Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) Range: ≥ 0

Referenced by 1 object types

Lights:Instance

Lights:Instance¶

from idfpy.models import LightsInstance

Sets internal gains for lights in the zone. The physical characteristics are given by the referenced Lights:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`lights_definition_name` Lights Definition Name required	reference		Names a Lights:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in schedule should be fraction applied to design level of lights, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`fraction_replaceable` Fraction Replaceable	number	`1.0`	For Daylighting:Controls must be 0 or 1: 0 = no dimming control, 1 = full dimming control Range: ≥ 0, ≤ 1
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`return_air_heat_gain_node_name` Return Air Heat Gain Node Name	string		Name of the return air node for this heat gain. If left blank, defaults to the first return air node for the zone. Leave this field blank when using a ZoneList name.
`exhaust_air_heat_gain_node_name` Exhaust Air Heat Gain Node Name	string		Name of the exhaust air node for this heat gain. If the node name is entered, return heat gain will be shared by both return and exhaust air nodes. The air properties of both nodes are weighted by both node mass flow rates.

Referenced by 1 object types

DemandManager:Lights

OtherEquipment¶

from idfpy.models import OtherEquipment

Sets internal gains or losses for "other" equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`fuel_type` Fuel Type	choice	`None`	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `None`, `OtherFuel1`, `OtherFuel2`, `Propane`
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of other equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of other equipment. to set a loss, use a negative value in the following fields. for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W
`power_per_floor_area` Power per Floor Area	number W/m2
`power_per_person` Power per Person	number W/person
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`0.0`	CO2 generation rate per unit of power input The default value assumes the equipment is fully vented. Range: ≥ 0, ≤ 4e-07
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

OtherEquipment:Definition¶

from idfpy.models import OtherEquipmentDefinition

Defines the physical characteristics (design level and heat gain fractions) for "other" equipment. Referenced by one or more OtherEquipment:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of other equipment. to set a loss, use a negative value in the following fields. for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W
`power_per_floor_area` Power per Floor Area	number W/m2
`power_per_person` Power per Person	number W/person
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`0.0`	CO2 generation rate per unit of power input The default value assumes the equipment is fully vented. Range: ≥ 0, ≤ 4e-07

Referenced by 1 object types

OtherEquipment:Instance

OtherEquipment:Instance¶

from idfpy.models import OtherEquipmentInstance

Sets internal gains or losses for "other" equipment in the zone. The physical characteristics are given by the referenced OtherEquipment:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`other_equipment_definition_name` Other Equipment Definition Name required	reference		Names a OtherEquipment:Definition
`fuel_type` Fuel Type	choice	`None`	One of `Coal`, `Diesel`, `DistrictCooling`, `DistrictHeatingSteam`, `DistrictHeatingWater`, `Electricity`, `FuelOilNo1`, `FuelOilNo2`, `Gasoline`, `NaturalGas`, `None`, `OtherFuel1`, `OtherFuel2`, `Propane`
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of other equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

People¶

from idfpy.models import People

Sets internal gains and contaminant rates for occupants in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`number_of_people_schedule_name` Number of People Schedule Name required	reference		units in schedule should be fraction applied to number of people (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`number_of_people_calculation_method` Number of People Calculation Method	choice	`People`	The entered calculation method is used to create the maximum number of people for this set of attributes (i.e. sensible fraction, schedule, etc) Choices: People -- simply enter number of occupants. People per Floor Area -- enter the number to apply. Value * Floor Area = Number of people Floor Area per Person -- enter the number to apply. Floor Area / Value = Number of people One of `Area/Person`, `People`, `People/Area`
`number_of_people` Number of People	number		Range: ≥ 0
`people_per_floor_area` People per Floor Area	number person/m2		Range: ≥ 0
`floor_area_per_person` Floor Area per Person	number m2/person		Range: ≥ 0
`fraction_radiant` Fraction Radiant	number	`0.3`	This is radiant fraction of the sensible heat released by people in a zone. This value will be multiplied by the total sensible heat released by people yields the amount of long wavelength radiation gain from people in a zone. Default value is 0.30. Range: ≥ 0, ≤ 1
`sensible_heat_fraction` Sensible Heat Fraction	number or `Autocalculate`	`Autocalculate`	if input, overrides program calculated sensible/latent split
`activity_level_schedule_name` Activity Level Schedule Name required	reference		Note that W has to be converted to mets in TC routine units in schedule are W/person Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`3.82e-08`	CO2 generation rate per unit of activity level. The default value is obtained from ASHRAE Std 62.1 at 0.0084 cfm/met/person over the general adult population. Range: ≥ 0, ≤ 3.82e-07
`enable_ashrae_55_comfort_warnings` Enable ASHRAE 55 Comfort Warnings	choice	`No`	One of `No`, `Yes`
`mean_radiant_temperature_calculation_type` Mean Radiant Temperature Calculation Type	choice	`EnclosureAveraged`	optional (only required for thermal comfort runs) One of `AngleFactor`, `EnclosureAveraged`, `SurfaceWeighted`
`surface_name_angle_factor_list_name` Surface Name/Angle Factor List Name	reference		optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, ComfortViewFactorAngles, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor and 11 more
`work_efficiency_schedule_name` Work Efficiency Schedule Name	reference		units in schedule are 0.0 to 1.0 optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`clothing_insulation_calculation_method` Clothing Insulation Calculation Method	choice	`ClothingInsulationSchedule`	One of `CalculationMethodSchedule`, `ClothingInsulationSchedule`, `DynamicClothingModelASHRAE55`
`clothing_insulation_calculation_method_schedule_name` Clothing Insulation Calculation Method Schedule Name	reference		a schedule value of 1 for the Scheduled method, and 2 for the DynamicClothingModelASHRAE55 method Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`clothing_insulation_schedule_name` Clothing Insulation Schedule Name	reference		use "Clo" from ASHRAE or Thermal Comfort guides optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_velocity_schedule_name` Air Velocity Schedule Name	reference		units in the schedule are m/s optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`thermal_comfort_model_1_type` Thermal Comfort Model 1 Type	choice		optional (only needed for people thermal comfort results reporting) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_2_type` Thermal Comfort Model 2 Type	choice		optional (second type of thermal comfort model and results reporting) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_3_type` Thermal Comfort Model 3 Type	choice		optional (third thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_4_type` Thermal Comfort Model 4 Type	choice		optional (fourth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_5_type` Thermal Comfort Model 5 Type	choice		optional (fifth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_6_type` Thermal Comfort Model 6 Type	choice		optional (sixth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_7_type` Thermal Comfort Model 7 Type	choice		optional (seventh thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`ankle_level_air_velocity_schedule_name` Ankle Level Air Velocity Schedule Name	reference		units in the schedule are m/s this is the schedule of the air speed at the 0.1 m above the floor optional (only required for runs of thermal comfort models AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_stress_temperature_threshold` Cold Stress Temperature Threshold	number C	`15.56`	this is the indoor safe temperature threshold for cold stress
`heat_stress_temperature_threshold` Heat Stress Temperature Threshold	number C	`30.0`	this is the indoor safe temperature threshold for heat stress

Referenced by 2 object types

ZoneControl:Thermostat:ThermalComfort, ZoneMRTCalculation

People:Definition¶

from idfpy.models import PeopleDefinition

Defines the physical characteristics (number of people, heat gain fractions, CO2 generation rate and thermal comfort model selections) for occupants. Referenced by one or more People:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`number_of_people_calculation_method` Number of People Calculation Method	choice	`People`	The entered calculation method is used to create the maximum number of people for this set of attributes (i.e. sensible fraction, schedule, etc) Choices: People -- simply enter number of occupants. People per Floor Area -- enter the number to apply. Value * Floor Area = Number of people Floor Area per Person -- enter the number to apply. Floor Area / Value = Number of people One of `Area/Person`, `People`, `People/Area`
`number_of_people` Number of People	number		Range: ≥ 0
`people_per_floor_area` People per Floor Area	number person/m2		Range: ≥ 0
`floor_area_per_person` Floor Area per Person	number m2/person		Range: ≥ 0
`fraction_radiant` Fraction Radiant	number	`0.3`	This is radiant fraction of the sensible heat released by people in a zone. This value will be multiplied by the total sensible heat released by people yields the amount of long wavelength radiation gain from people in a zone. Default value is 0.30. Range: ≥ 0, ≤ 1
`sensible_heat_fraction` Sensible Heat Fraction	number or `Autocalculate`	`Autocalculate`	if input, overrides program calculated sensible/latent split
`carbon_dioxide_generation_rate` Carbon Dioxide Generation Rate	number m3/s-W	`3.82e-08`	CO2 generation rate per unit of activity level. The default value is obtained from ASHRAE Std 62.1 at 0.0084 cfm/met/person over the general adult population. Range: ≥ 0, ≤ 3.82e-07
`enable_ashrae_55_comfort_warnings` Enable ASHRAE 55 Comfort Warnings	choice	`No`	One of `No`, `Yes`
`mean_radiant_temperature_calculation_type` Mean Radiant Temperature Calculation Type	choice	`EnclosureAveraged`	optional (only required for thermal comfort runs) One of `AngleFactor`, `EnclosureAveraged`, `SurfaceWeighted`
`thermal_comfort_model_1_type` Thermal Comfort Model 1 Type	choice		optional (only needed for people thermal comfort results reporting) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_2_type` Thermal Comfort Model 2 Type	choice		optional (second type of thermal comfort model and results reporting) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_3_type` Thermal Comfort Model 3 Type	choice		optional (third thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_4_type` Thermal Comfort Model 4 Type	choice		optional (fourth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_5_type` Thermal Comfort Model 5 Type	choice		optional (fifth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_6_type` Thermal Comfort Model 6 Type	choice		optional (sixth thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`
`thermal_comfort_model_7_type` Thermal Comfort Model 7 Type	choice		optional (seventh thermal comfort model and report type) One of `AdaptiveASH55`, `AdaptiveCEN15251`, `AnkleDraftASH55`, `CoolingEffectASH55`, `Fanger`, `KSU`, `Pierce`

Referenced by 1 object types

People:Instance

People:Instance¶

from idfpy.models import PeopleInstance

Sets internal gains and contaminant rates for occupants in the zone. The physical characteristics are given by the referenced People:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`people_definition_name` People Definition Name required	reference		Names a People:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`number_of_people_schedule_name` Number of People Schedule Name required	reference		units in schedule should be fraction applied to number of people (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`activity_level_schedule_name` Activity Level Schedule Name required	reference		Note that W has to be converted to mets in TC routine units in schedule are W/person Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`surface_name_angle_factor_list_name` Surface Name/Angle Factor List Name	reference		optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, ComfortViewFactorAngles, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor and 11 more
`work_efficiency_schedule_name` Work Efficiency Schedule Name	reference		units in schedule are 0.0 to 1.0 optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`clothing_insulation_calculation_method` Clothing Insulation Calculation Method	choice	`ClothingInsulationSchedule`	One of `CalculationMethodSchedule`, `ClothingInsulationSchedule`, `DynamicClothingModelASHRAE55`
`clothing_insulation_calculation_method_schedule_name` Clothing Insulation Calculation Method Schedule Name	reference		a schedule value of 1 for the Scheduled method, and 2 for the DynamicClothingModelASHRAE55 method Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`clothing_insulation_schedule_name` Clothing Insulation Schedule Name	reference		use "Clo" from ASHRAE or Thermal Comfort guides optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`air_velocity_schedule_name` Air Velocity Schedule Name	reference		units in the schedule are m/s optional (only required for runs of thermal comfort models: Fanger, Pierce, KSU, CoolingEffectASH55 and AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the number of people from the referenced definition. Range: ≥ 0
`ankle_level_air_velocity_schedule_name` Ankle Level Air Velocity Schedule Name	reference		units in the schedule are m/s this is the schedule of the air speed at the 0.1 m above the floor optional (only required for runs of thermal comfort models AnkleDraftASH55) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cold_stress_temperature_threshold` Cold Stress Temperature Threshold	number C	`15.56`	this is the indoor safe temperature threshold for cold stress
`heat_stress_temperature_threshold` Heat Stress Temperature Threshold	number C	`30.0`	this is the indoor safe temperature threshold for heat stress

Referenced by 2 object types

ZoneControl:Thermostat:ThermalComfort, ZoneMRTCalculation

SteamEquipment¶

from idfpy.models import SteamEquipment

Sets internal gains for steam equipment in the zone. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of steam equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of steam equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

SteamEquipment:Definition¶

from idfpy.models import SteamEquipmentDefinition

Defines the physical characteristics (design level and heat gain fractions) for steam equipment. Referenced by one or more SteamEquipment:Instance objects.

Field	Type	Default	Details
`name` Name required	string
`design_level_calculation_method` Design Level Calculation Method	choice	`EquipmentLevel`	The entered calculation method is used to create the maximum amount of steam equipment for this set of attributes Choices: EquipmentLevel => Design Level -- simply enter power input of equipment Watts/Area or Power/Area => Power per Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level Watts/Person or Power/Person => Power per Person -- enter the number to apply. Value * Occupants = Equipment Level One of `EquipmentLevel`, `Power/Area`, `Power/Person`, `Watts/Area`, `Watts/Person`
`design_level` Design Level	number W		Range: ≥ 0
`power_per_floor_area` Power per Floor Area	number W/m2		Range: ≥ 0
`power_per_person` Power per Person	number W/person		Range: ≥ 0
`fraction_latent` Fraction Latent	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`fraction_lost` Fraction Lost	number	`0.0`	Range: ≥ 0, ≤ 1

Referenced by 1 object types

SteamEquipment:Instance

SteamEquipment:Instance¶

from idfpy.models import SteamEquipmentInstance

Sets internal gains for steam equipment in the zone. The physical characteristics are given by the referenced SteamEquipment:Definition object. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`steam_equipment_definition_name` Steam Equipment Definition Name required	reference		Names a SteamEquipment:Definition
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to design level of steam equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`multiplier` Multiplier	number	`1.0`	Multiplies the design level from the referenced definition. Range: ≥ 0
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.

SurfaceContaminantSourceAndSink:Generic:BoundaryLayerDiffusion¶

from idfpy.models import SurfaceContaminantSourceAndSinkGenericBoundaryLayerDiffusion

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Field	Type	Details
`name` Name required	string
`surface_name` Surface Name required	reference	Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`mass_transfer_coefficient` Mass Transfer Coefficient	number m/s	Range: ≥ 0
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Initial Emission Rate. When the value is equal to 1.0, the time will be reset to zero. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`henry_adsorption_constant_or_partition_coefficient` Henry Adsorption Constant or Partition Coefficient	number dimensionless	Range: > 0

SurfaceContaminantSourceAndSink:Generic:DepositionVelocitySink¶

from idfpy.models import SurfaceContaminantSourceAndSinkGenericDepositionVelocitySink

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Field	Type	Details
`name` Name required	string
`surface_name` Surface Name required	reference	Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, Roof, RoofCeiling:Detailed, Wall:Adiabatic, Wall:Detailed, Wall:Exterior and 2 more
`deposition_velocity` Deposition Velocity	number m/s	Range: ≥ 0
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Initial Emission Rate. When the value is equal to 1.0, the time will be reset to zero. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

SurfaceContaminantSourceAndSink:Generic:PressureDriven¶

from idfpy.models import SurfaceContaminantSourceAndSinkGenericPressureDriven

Simulate generic contaminant source driven by the pressure difference across a surface.

Field	Type	Details
`name` Name required	string
`surface_name` Surface Name required	reference	Names a BuildingSurface:Detailed, Ceiling:Adiabatic, Ceiling:Interzone, Door, Door:Interzone, FenestrationSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone, GlazedDoor, GlazedDoor:Interzone and 9 more
`design_generation_rate_coefficient` Design Generation Rate Coefficient	number m3/s	Range: ≥ 0
`generation_schedule_name` Generation Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate Coefficient Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`generation_exponent` Generation Exponent	number dimensionless	Range: > 0, ≤ 1

SwimmingPool:Indoor¶

from idfpy.models import SwimmingPoolIndoor

Specifies an indoor swimming pools linked to a floor surface. The pool is assumed to cover the entire floor to which it is linked.

Field	Type	Default	Details
`name` Name required	string
`surface_name` Surface Name required	reference		Name of the floor surface where the pool is located. Names a BuildingSurface:Detailed, Floor:Adiabatic, Floor:Detailed, Floor:GroundContact, Floor:Interzone
`average_depth` Average Depth required	number m
`activity_factor_schedule_name` Activity Factor Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`make_up_water_supply_schedule_name` Make-up Water Supply Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cover_schedule_name` Cover Schedule Name required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cover_evaporation_factor` Cover Evaporation Factor	number	`0.0`	Range: ≥ 0, ≤ 1
`cover_convection_factor` Cover Convection Factor	number	`0.0`	Range: ≥ 0, ≤ 1
`cover_short_wavelength_radiation_factor` Cover Short-Wavelength Radiation Factor	number	`0.0`	Range: ≥ 0, ≤ 1
`cover_long_wavelength_radiation_factor` Cover Long-Wavelength Radiation Factor	number	`0.0`	Range: ≥ 0, ≤ 1
`pool_water_inlet_node` Pool Water Inlet Node required	string
`pool_water_outlet_node` Pool Water Outlet Node required	string
`pool_heating_system_maximum_water_flow_rate` Pool Heating System Maximum Water Flow Rate	number m3/s		Range: ≥ 0
`pool_miscellaneous_equipment_power` Pool Miscellaneous Equipment Power	number W/(m3/s)		Power input per pool water flow rate Range: ≥ 0
`setpoint_temperature_schedule` Setpoint Temperature Schedule required	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`maximum_number_of_people` Maximum Number of People required	number		Range: ≥ 0
`people_schedule` People Schedule	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`people_heat_gain_schedule` People Heat Gain Schedule	reference		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 2 object types

AirLoopHVAC:DedicatedOutdoorAirSystem, Branch

ZoneBaseboard:OutdoorTemperatureControlled¶

from idfpy.models import ZoneBaseboardOutdoorTemperatureControlled

Specifies outside temperature-controlled electric baseboard heating. If a ZoneList, SpaceList, or a Zone comprised of more than one Space is specified then this definition applies to all applicable spaces, and each instance will be named with the Space Name plus this Object Name.

Field	Type	Default	Details
`name` Name required	string
`zone_or_zonelist_or_space_or_spacelist_name` Zone or ZoneList or Space or SpaceList Name required	reference		Names a Space, SpaceList, Zone, ZoneList
`schedule_name` Schedule Name required	reference		units in Schedule should be fraction applied to capacity of the baseboard heat equipment, generally (0.0 - 1.0) Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`capacity_at_low_temperature` Capacity at Low Temperature	number or `Autosize` W	`Autosize`
`low_temperature` Low Temperature	number or `Autosize` C	`Autosize`
`capacity_at_high_temperature` Capacity at High Temperature	number or `Autosize` W	`Autosize`
`high_temperature` High Temperature	number or `Autosize` C	`Autosize`
`fraction_radiant` Fraction Radiant	number	`0.0`	Range: ≥ 0, ≤ 1
`end_use_subcategory` End-Use Subcategory	string	`General`	Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table.
`design_zone_heating_setpoint` Design Zone Heating Setpoint	number C	`20.0`

ZoneContaminantSourceAndSink:CarbonDioxide¶

from idfpy.models import ZoneContaminantSourceAndSinkCarbonDioxide

Represents internal CO2 gains and sinks in the zone.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`design_generation_rate` Design Generation Rate	number m3/s	Positive values represent sources and negative values represent sinks.
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

ZoneContaminantSourceAndSink:Generic:Constant¶

from idfpy.models import ZoneContaminantSourceAndSinkGenericConstant

Sets internal generic contaminant gains and sinks in a zone with constant values.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`design_generation_rate` Design Generation Rate	number m3/s	The values represent source. Range: ≥ 0
`generation_schedule_name` Generation Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`design_removal_coefficient` Design Removal Coefficient	number m3/s	The value represent sink. Range: ≥ 0
`removal_schedule_name` Removal Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design removal Coefficient Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

ZoneContaminantSourceAndSink:Generic:CutoffModel¶

from idfpy.models import ZoneContaminantSourceAndSinkGenericCutoffModel

Simulate generic contaminant source driven by the cutoff concentration model.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`design_generation_rate_coefficient` Design Generation Rate Coefficient	number m3/s	Range: ≥ 0
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Design Generation Rate Coefficient Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`cutoff_generic_contaminant_at_which_emission_ceases` Cutoff Generic Contaminant at which Emission Ceases	number ppm	When the zone concentration level is greater than the cutoff level, emission stops, and the source level is zero. Range: > 0

ZoneContaminantSourceAndSink:Generic:DecaySource¶

from idfpy.models import ZoneContaminantSourceAndSinkGenericDecaySource

Simulate generic contaminant source driven by the cutoff concentration model.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`initial_emission_rate` Initial Emission Rate	number m3/s	Range: ≥ 0
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Initial Emission Rate. When the value is equal to 1.0, the time will be reset to zero. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`delay_time_constant` Delay Time Constant	number s	Range: > 0

ZoneContaminantSourceAndSink:Generic:DepositionRateSink¶

from idfpy.models import ZoneContaminantSourceAndSinkGenericDepositionRateSink

Simulate generic contaminant source driven by the boundary layer diffusion controlled model.

Field	Type	Details
`name` Name required	string
`zone_name` Zone Name required	reference	Names a Zone
`deposition_rate` Deposition Rate	number m/s	Range: ≥ 0
`schedule_name` Schedule Name required	reference	Value in this schedule should be a fraction (generally 0.0 - 1.0) applied to the Initial Emission Rate. When the value is equal to 1.0, the time will be reset to zero. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules