pyidf.location_and_climate module

Data objects in group “Location and Climate”

class pyidf.location_and_climate.RoofIrrigation

Bases: pyidf.helper.DataObject

Corresponds to IDD object RoofIrrigation Used to describe the amount of irrigation on the ecoroof surface over the course of the simulation runperiod.

irrigation_maximum_saturation_threshold

field Irrigation Maximum Saturation Threshold

Used with SmartSchedule to set the saturation level at which no
irrigation is allowed.
Units: percent
Default value: 40.0
value <= 100.0
Parameters:value (float) – value for IDD Field Irrigation Maximum Saturation Threshold
Raises:ValueError – if value is not a valid value
Returns:the value of irrigation_maximum_saturation_threshold or None if not set
Return type:float
irrigation_model_type

field Irrigation Model Type

SmartSchedule will not allow irrigation when soil is already moist.
Current threshold set at 30% of saturation.
Parameters:value (str) – value for IDD Field Irrigation Model Type
Raises:ValueError – if value is not a valid value
Returns:the value of irrigation_model_type or None if not set
Return type:str
irrigation_rate_schedule_name

field Irrigation Rate Schedule Name

Schedule values in meters of water per hour
values should be non-negative
Parameters:value (str) – value for IDD Field Irrigation Rate Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of irrigation_rate_schedule_name or None if not set
Return type:str
class pyidf.location_and_climate.RunPeriod

Bases: pyidf.helper.DataObject

Corresponds to IDD object RunPeriod Specified a range of dates and other parameters for a weather file simulation. Multiple run periods may be input, but they may not overlap.

apply_weekend_holiday_rule

field Apply Weekend Holiday Rule

if yes and single day holiday falls on weekend, “holiday” occurs on following Monday
Default value: No
Parameters:value (str) – value for IDD Field Apply Weekend Holiday Rule
Raises:ValueError – if value is not a valid value
Returns:the value of apply_weekend_holiday_rule or None if not set
Return type:str
begin_day_of_month

field Begin Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field Begin Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_day_of_month or None if not set
Return type:int
begin_month

field Begin Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field Begin Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_month or None if not set
Return type:int
day_of_week_for_start_day

field Day of Week for Start Day

=<blank - use WeatherFile>|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday];
Default value: UseWeatherFile
Parameters:value (str) – value for IDD Field Day of Week for Start Day
Raises:ValueError – if value is not a valid value
Returns:the value of day_of_week_for_start_day or None if not set
Return type:str
end_day_of_month

field End Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field End Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_day_of_month or None if not set
Return type:int
end_month

field End Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field End Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_month or None if not set
Return type:int
increment_day_of_week_on_repeat

field Increment Day of Week on repeat

Default value: Yes
Parameters:value (str) – value for IDD Field Increment Day of Week on repeat
Raises:ValueError – if value is not a valid value
Returns:the value of increment_day_of_week_on_repeat or None if not set
Return type:str
name

field Name

descriptive name (used in reporting mainly)
if blank, weather file title is used. if not blank, must be unique
Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
number_of_times_runperiod_to_be_repeated

field Number of Times Runperiod to be Repeated

Default value: 1
value >= 1
Parameters:value (int) – value for IDD Field Number of Times Runperiod to be Repeated
Raises:ValueError – if value is not a valid value
Returns:the value of number_of_times_runperiod_to_be_repeated or None if not set
Return type:int
start_year

field Start Year

this is the start year for the start date. If the leap year is “Yes” in the weather file header
(that is HOLIDAYS/SPECIAL DAYS header first field), then any year which is a leap year will assume
there will be a Feb 29. A repeat of this runperiod will automatically increment the year.
Parameters:value (float) – value for IDD Field Start Year
Raises:ValueError – if value is not a valid value
Returns:the value of start_year or None if not set
Return type:float
use_weather_file_daylight_saving_period

field Use Weather File Daylight Saving Period

If yes or blank, use daylight saving period as specified on Weatherfile.
If no, do not use the daylight saving period as specified on the Weatherfile.
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Daylight Saving Period
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_daylight_saving_period or None if not set
Return type:str
use_weather_file_holidays_and_special_days

field Use Weather File Holidays and Special Days

If yes or blank, use holidays as specified on Weatherfile.
If no, do not use the holidays specified on the Weatherfile.
Note: You can still specify holidays/special days using the RunPeriodControl:SpecialDays object(s).
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Holidays and Special Days
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_holidays_and_special_days or None if not set
Return type:str
use_weather_file_rain_indicators

field Use Weather File Rain Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Rain Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_rain_indicators or None if not set
Return type:str
use_weather_file_snow_indicators

field Use Weather File Snow Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Snow Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_snow_indicators or None if not set
Return type:str
class pyidf.location_and_climate.RunPeriodControlDaylightSavingTime

Bases: pyidf.helper.DataObject

Corresponds to IDD object RunPeriodControl:DaylightSavingTime This object sets up the daylight saving time period for any RunPeriod. Ignores any daylight saving time period on the weather file and uses this definition. These are not used with SizingPeriod:DesignDay objects. Use with SizingPeriod:WeatherFileDays object can be controlled in that object.

end_date

field End Date

Dates can be several formats:
<number>/<number> (month/day)
<number> <Month>
<Month> <number>
<Nth> <Weekday> in <Month)
Last <WeekDay> in <Month>
<Month> can be January, February, March, April, May, June, July, August, September, October, November, December
Months can be the first 3 letters of the month
<Weekday> can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
<Nth> can be 1 or 1st, 2 or 2nd, etc. up to 5(?)
Parameters:value (str) – value for IDD Field End Date
Raises:ValueError – if value is not a valid value
Returns:the value of end_date or None if not set
Return type:str
start_date

field Start Date

Parameters:value (str) – value for IDD Field Start Date
Raises:ValueError – if value is not a valid value
Returns:the value of start_date or None if not set
Return type:str
class pyidf.location_and_climate.RunPeriodControlSpecialDays

Bases: pyidf.helper.DataObject

Corresponds to IDD object RunPeriodControl:SpecialDays This object sets up holidays/special days to be used during weather file run periods. (These are not used with SizingPeriod:* objects.) Depending on the value in the run period, days on the weather file may also be used. However, the weather file specification will take precedence over any specification shown here. (No error message on duplicate days or overlapping days).

duration

field Duration

Units: days
Default value: 1.0
value >= 1.0
value <= 366.0
Parameters:value (float) – value for IDD Field Duration
Raises:ValueError – if value is not a valid value
Returns:the value of duration or None if not set
Return type:float
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
special_day_type

field Special Day Type

Special Day Type selects the schedules appropriate for each day so labeled
Default value: Holiday
Parameters:value (str) – value for IDD Field Special Day Type
Raises:ValueError – if value is not a valid value
Returns:the value of special_day_type or None if not set
Return type:str
start_date

field Start Date

Dates can be several formats:
<number>/<number> (month/day)
<number> <Month>
<Month> <number>
<Nth> <Weekday> in <Month)
Last <WeekDay> in <Month>
<Month> can be January, February, March, April, May, June, July, August, September, October, November, December
Months can be the first 3 letters of the month
<Weekday> can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
<Nth> can be 1 or 1st, 2 or 2nd, etc. up to 5(?)
Parameters:value (str) – value for IDD Field Start Date
Raises:ValueError – if value is not a valid value
Returns:the value of start_date or None if not set
Return type:str
class pyidf.location_and_climate.RunPeriodCustomRange

Bases: pyidf.helper.DataObject

Corresponds to IDD object RunPeriod:CustomRange run simulation for a custom created weather file

apply_weekend_holiday_rule

field Apply Weekend Holiday Rule

if yes and single day holiday falls on weekend, “holiday” occurs on following Monday
Default value: No
Parameters:value (str) – value for IDD Field Apply Weekend Holiday Rule
Raises:ValueError – if value is not a valid value
Returns:the value of apply_weekend_holiday_rule or None if not set
Return type:str
begin_day_of_month

field Begin Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field Begin Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_day_of_month or None if not set
Return type:int
begin_month

field Begin Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field Begin Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_month or None if not set
Return type:int
begin_year

field Begin Year

must be start year of this date on weather file
Parameters:value (float) – value for IDD Field Begin Year
Raises:ValueError – if value is not a valid value
Returns:the value of begin_year or None if not set
Return type:float
day_of_week_for_start_day

field Day of Week for Start Day

=<blank - use WeatherFile>|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday];
Default value: UseWeatherFile
Parameters:value (str) – value for IDD Field Day of Week for Start Day
Raises:ValueError – if value is not a valid value
Returns:the value of day_of_week_for_start_day or None if not set
Return type:str
end_day_of_month

field End Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field End Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_day_of_month or None if not set
Return type:int
end_month

field End Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field End Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_month or None if not set
Return type:int
end_year

field End Year

must be end year of this date on weather file
Parameters:value (float) – value for IDD Field End Year
Raises:ValueError – if value is not a valid value
Returns:the value of end_year or None if not set
Return type:float
name

field Name

descriptive name (used in reporting mainly)
if blank, weather file title is used. if not blank, must be unique
Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
use_weather_file_daylight_saving_period

field Use Weather File Daylight Saving Period

If yes or blank, use daylight saving period as specified on Weatherfile.
If no, do not use the daylight saving period as specified on the Weatherfile.
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Daylight Saving Period
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_daylight_saving_period or None if not set
Return type:str
use_weather_file_holidays_and_special_days

field Use Weather File Holidays and Special Days

If yes or blank, use holidays as specified on Weatherfile.
If no, do not use the holidays specified on the Weatherfile.
Note: You can still specify holidays/special days using the RunPeriodControl:SpecialDays object(s).
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Holidays and Special Days
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_holidays_and_special_days or None if not set
Return type:str
use_weather_file_rain_indicators

field Use Weather File Rain Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Rain Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_rain_indicators or None if not set
Return type:str
use_weather_file_snow_indicators

field Use Weather File Snow Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Snow Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_snow_indicators or None if not set
Return type:str
class pyidf.location_and_climate.SiteGroundDomainBasement

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundDomain:Basement Ground-coupled basement model for simulating basements or other underground zones.

aspect_ratio

field Aspect Ratio

This defines the height to width ratio of the basement zone.
Default value: 1.0
Parameters:value (float) – value for IDD Field Aspect Ratio
Raises:ValueError – if value is not a valid value
Returns:the value of aspect_ratio or None if not set
Return type:float
basement_floor_boundary_condition_model_name

field Basement Floor Boundary Condition Model Name

Parameters:value (str) – value for IDD Field Basement Floor Boundary Condition Model Name
Raises:ValueError – if value is not a valid value
Returns:the value of basement_floor_boundary_condition_model_name or None if not set
Return type:str
basement_wall_boundary_condition_model_name

field Basement Wall Boundary Condition Model Name

Parameters:value (str) – value for IDD Field Basement Wall Boundary Condition Model Name
Raises:ValueError – if value is not a valid value
Returns:the value of basement_wall_boundary_condition_model_name or None if not set
Return type:str
basement_wall_depth

field Basement Wall Depth

Depth measured from ground surface.
Units: m
Parameters:value (float) – value for IDD Field Basement Wall Depth
Raises:ValueError – if value is not a valid value
Returns:the value of basement_wall_depth or None if not set
Return type:float
basement_wall_vertical_insulation_material_name

field Basement Wall Vertical Insulation Material Name

Parameters:value (str) – value for IDD Field Basement Wall Vertical Insulation Material Name
Raises:ValueError – if value is not a valid value
Returns:the value of basement_wall_vertical_insulation_material_name or None if not set
Return type:str
evapotranspiration_ground_cover_parameter

field Evapotranspiration Ground Cover Parameter

This specifies the ground cover effects during evapotranspiration
calculations. The value roughly represents the following cases:
= 0 : concrete or other solid, non-permeable ground surface material
= 0.5 : short grass, much like a manicured lawn
= 1 : standard reference state (12 cm grass)
= 1.5 : wild growth
Default value: 0.4
value <= 1.5
Parameters:value (float) – value for IDD Field Evapotranspiration Ground Cover Parameter
Raises:ValueError – if value is not a valid value
Returns:the value of evapotranspiration_ground_cover_parameter or None if not set
Return type:float
ground_domain_depth

field Ground Domain Depth

The depth from ground surface to the deep ground boundary of the domain.
Units: m
Default value: 10.0
Parameters:value (float) – value for IDD Field Ground Domain Depth
Raises:ValueError – if value is not a valid value
Returns:the value of ground_domain_depth or None if not set
Return type:float
horizontal_insulation

field Horizontal Insulation

This field specifies the presence of insulation beneath the basement floor.
Default value: No
Parameters:value (str) – value for IDD Field Horizontal Insulation
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation or None if not set
Return type:str
horizontal_insulation_extents

field Horizontal Insulation Extents

This field specifies whether the horizontal insulation fully insulates
the surface or is perimeter only insulation
Default value: Full
Parameters:value (str) – value for IDD Field Horizontal Insulation Extents
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation_extents or None if not set
Return type:str
horizontal_insulation_material_name

field Horizontal Insulation Material Name

Parameters:value (str) – value for IDD Field Horizontal Insulation Material Name
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation_material_name or None if not set
Return type:str
mesh_density_parameter

field Mesh Density Parameter

Default value: 4
value >= 2
Parameters:value (int) – value for IDD Field Mesh Density Parameter
Raises:ValueError – if value is not a valid value
Returns:the value of mesh_density_parameter or None if not set
Return type:int
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
perimeter_horizontal_insulation_width

field Perimeter Horizontal Insulation Width

Width of horizontal perimeter insulation measured from
foundation wall inside surface.
Units: m
Parameters:value (float) – value for IDD Field Perimeter Horizontal Insulation Width
Raises:ValueError – if value is not a valid value
Returns:the value of perimeter_horizontal_insulation_width or None if not set
Return type:float
perimeter_offset

field Perimeter Offset

The distance from the basement wall edge to the edge of the ground domain
Units: m
Default value: 5.0
Parameters:value (float) – value for IDD Field Perimeter Offset
Raises:ValueError – if value is not a valid value
Returns:the value of perimeter_offset or None if not set
Return type:float
simulation_timestep

field Simulation Timestep

This field specifies the basement domain simulation interval.
Default value: Hourly
Parameters:value (str) – value for IDD Field Simulation Timestep
Raises:ValueError – if value is not a valid value
Returns:the value of simulation_timestep or None if not set
Return type:str
soil_density

field Soil Density

Units: kg/m3
Default value: 2800.0
Parameters:value (float) – value for IDD Field Soil Density
Raises:ValueError – if value is not a valid value
Returns:the value of soil_density or None if not set
Return type:float
soil_moisture_content_volume_fraction

field Soil Moisture Content Volume Fraction

Units: percent
Default value: 30.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction or None if not set
Return type:float
soil_moisture_content_volume_fraction_at_saturation

field Soil Moisture Content Volume Fraction at Saturation

Units: percent
Default value: 50.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction at Saturation
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction_at_saturation or None if not set
Return type:float
soil_specific_heat

field Soil Specific Heat

Units: J/kg-K
Default value: 850.0
Parameters:value (float) – value for IDD Field Soil Specific Heat
Raises:ValueError – if value is not a valid value
Returns:the value of soil_specific_heat or None if not set
Return type:float
soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K
Default value: 1.5
Parameters:value (float) – value for IDD Field Soil Thermal Conductivity
Raises:ValueError – if value is not a valid value
Returns:the value of soil_thermal_conductivity or None if not set
Return type:float
undisturbed_ground_temperature_model_name

field Undisturbed Ground Temperature Model Name

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Name
Raises:ValueError – if value is not a valid value
Returns:the value of undisturbed_ground_temperature_model_name or None if not set
Return type:str
undisturbed_ground_temperature_model_type

field Undisturbed Ground Temperature Model Type

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Type
Raises:ValueError – if value is not a valid value
Returns:the value of undisturbed_ground_temperature_model_type or None if not set
Return type:str
vertical_insulation

field Vertical Insulation

Default value: No
Parameters:value (str) – value for IDD Field Vertical Insulation
Raises:ValueError – if value is not a valid value
Returns:the value of vertical_insulation or None if not set
Return type:str
vertical_insulation_depth

field Vertical Insulation Depth

Depth measured from the ground surface.
Units: m
Parameters:value (float) – value for IDD Field Vertical Insulation Depth
Raises:ValueError – if value is not a valid value
Returns:the value of vertical_insulation_depth or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundDomainSlab

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundDomain:Slab Ground-coupled slab model for on-grade and in-grade cases with or without insulation.

aspect_ratio

field Aspect Ratio

Default value: 1.0
Parameters:value (float) – value for IDD Field Aspect Ratio
Raises:ValueError – if value is not a valid value
Returns:the value of aspect_ratio or None if not set
Return type:float
evapotranspiration_ground_cover_parameter

field Evapotranspiration Ground Cover Parameter

This specifies the ground cover effects during evapotranspiration
calculations. The value roughly represents the following cases:
= 0 : concrete or other solid, non-permeable ground surface material
= 0.5 : short grass, much like a manicured lawn
= 1 : standard reference state (12 cm grass)
= 1.5 : wild growth
Default value: 0.4
value <= 1.5
Parameters:value (float) – value for IDD Field Evapotranspiration Ground Cover Parameter
Raises:ValueError – if value is not a valid value
Returns:the value of evapotranspiration_ground_cover_parameter or None if not set
Return type:float
ground_domain_depth

field Ground Domain Depth

Units: m
Default value: 10.0
Parameters:value (float) – value for IDD Field Ground Domain Depth
Raises:ValueError – if value is not a valid value
Returns:the value of ground_domain_depth or None if not set
Return type:float
horizontal_insulation

field Horizontal Insulation

This field specifies the presence of insulation beneath the slab.
Only required for in-grade case.
Default value: No
Parameters:value (str) – value for IDD Field Horizontal Insulation
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation or None if not set
Return type:str
horizontal_insulation_extents

field Horizontal Insulation Extents

This field specifies whether the horizontal insulation fully insulates
the surface or is perimeter only insulation
Default value: Full
Parameters:value (str) – value for IDD Field Horizontal Insulation Extents
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation_extents or None if not set
Return type:str
horizontal_insulation_material_name

field Horizontal Insulation Material Name

This field specifies the horizontal insulation material.
Parameters:value (str) – value for IDD Field Horizontal Insulation Material Name
Raises:ValueError – if value is not a valid value
Returns:the value of horizontal_insulation_material_name or None if not set
Return type:str
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
perimeter_insulation_width

field Perimeter Insulation Width

This field specifies the width of the underfloor perimeter insulation
Units: m
Parameters:value (float) – value for IDD Field Perimeter Insulation Width
Raises:ValueError – if value is not a valid value
Returns:the value of perimeter_insulation_width or None if not set
Return type:float
perimeter_offset

field Perimeter Offset

Units: m
Default value: 5.0
Parameters:value (float) – value for IDD Field Perimeter Offset
Raises:ValueError – if value is not a valid value
Returns:the value of perimeter_offset or None if not set
Return type:float
simulation_timestep

field Simulation Timestep

This field specifies the ground domain simulation timestep.
Default value: Hourly
Parameters:value (str) – value for IDD Field Simulation Timestep
Raises:ValueError – if value is not a valid value
Returns:the value of simulation_timestep or None if not set
Return type:str
slab_boundary_condition_model_name

field Slab Boundary Condition Model Name

Parameters:value (str) – value for IDD Field Slab Boundary Condition Model Name
Raises:ValueError – if value is not a valid value
Returns:the value of slab_boundary_condition_model_name or None if not set
Return type:str
slab_location

field Slab Location

This field specifies whether the slab is located “in-grade” or “on-grade”
Parameters:value (str) – value for IDD Field Slab Location
Raises:ValueError – if value is not a valid value
Returns:the value of slab_location or None if not set
Return type:str
slab_material_name

field Slab Material Name

Only applicable for the in-grade case
Parameters:value (str) – value for IDD Field Slab Material Name
Raises:ValueError – if value is not a valid value
Returns:the value of slab_material_name or None if not set
Return type:str
soil_density

field Soil Density

Units: kg/m3
Default value: 2800.0
Parameters:value (float) – value for IDD Field Soil Density
Raises:ValueError – if value is not a valid value
Returns:the value of soil_density or None if not set
Return type:float
soil_moisture_content_volume_fraction

field Soil Moisture Content Volume Fraction

Units: percent
Default value: 30.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction or None if not set
Return type:float
soil_moisture_content_volume_fraction_at_saturation

field Soil Moisture Content Volume Fraction at Saturation

Units: percent
Default value: 50.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction at Saturation
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction_at_saturation or None if not set
Return type:float
soil_specific_heat

field Soil Specific Heat

Units: J/kg-K
Default value: 850.0
Parameters:value (float) – value for IDD Field Soil Specific Heat
Raises:ValueError – if value is not a valid value
Returns:the value of soil_specific_heat or None if not set
Return type:float
soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K
Default value: 1.5
Parameters:value (float) – value for IDD Field Soil Thermal Conductivity
Raises:ValueError – if value is not a valid value
Returns:the value of soil_thermal_conductivity or None if not set
Return type:float
undisturbed_ground_temperature_model_name

field Undisturbed Ground Temperature Model Name

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Name
Raises:ValueError – if value is not a valid value
Returns:the value of undisturbed_ground_temperature_model_name or None if not set
Return type:str
undisturbed_ground_temperature_model_type

field Undisturbed Ground Temperature Model Type

Parameters:value (str) – value for IDD Field Undisturbed Ground Temperature Model Type
Raises:ValueError – if value is not a valid value
Returns:the value of undisturbed_ground_temperature_model_type or None if not set
Return type:str
vertical_insulation

field Vertical Insulation

This field specifies the presence of vertical insulation at the slab edge.
Default value: No
Parameters:value (str) – value for IDD Field Vertical Insulation
Raises:ValueError – if value is not a valid value
Returns:the value of vertical_insulation or None if not set
Return type:str
vertical_insulation_depth

field Vertical Insulation Depth

Only used when including vertical insulation
This field specifies the depth of the vertical insulation
Units: m
Parameters:value (float) – value for IDD Field Vertical Insulation Depth
Raises:ValueError – if value is not a valid value
Returns:the value of vertical_insulation_depth or None if not set
Return type:float
vertical_insulation_material_name

field Vertical Insulation Material Name

This field specifies the vertical insulation material.
Parameters:value (str) – value for IDD Field Vertical Insulation Material Name
Raises:ValueError – if value is not a valid value
Returns:the value of vertical_insulation_material_name or None if not set
Return type:str
class pyidf.location_and_climate.SiteGroundReflectance

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundReflectance Specifies the ground reflectance values used to calculate ground reflected solar. The ground reflectance can be further modified when snow is on the ground by Site:GroundReflectance:SnowModifier.

april_ground_reflectance

field April Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field April Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of april_ground_reflectance or None if not set
Return type:float
august_ground_reflectance

field August Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field August Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of august_ground_reflectance or None if not set
Return type:float
december_ground_reflectance

field December Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field December Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of december_ground_reflectance or None if not set
Return type:float
february_ground_reflectance

field February Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field February Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of february_ground_reflectance or None if not set
Return type:float
january_ground_reflectance

field January Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field January Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of january_ground_reflectance or None if not set
Return type:float
july_ground_reflectance

field July Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field July Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of july_ground_reflectance or None if not set
Return type:float
june_ground_reflectance

field June Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field June Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of june_ground_reflectance or None if not set
Return type:float
march_ground_reflectance

field March Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field March Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of march_ground_reflectance or None if not set
Return type:float
may_ground_reflectance

field May Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field May Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of may_ground_reflectance or None if not set
Return type:float
november_ground_reflectance

field November Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field November Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of november_ground_reflectance or None if not set
Return type:float
october_ground_reflectance

field October Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field October Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of october_ground_reflectance or None if not set
Return type:float
september_ground_reflectance

field September Ground Reflectance

Units: dimensionless
Default value: 0.2
value <= 1.0
Parameters:value (float) – value for IDD Field September Ground Reflectance
Raises:ValueError – if value is not a valid value
Returns:the value of september_ground_reflectance or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundReflectanceSnowModifier

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundReflectance:SnowModifier Specifies ground reflectance multipliers when snow resident on the ground. These multipliers are applied to the “normal” ground reflectances specified in Site:GroundReflectance.

daylighting_ground_reflected_solar_modifier

field Daylighting Ground Reflected Solar Modifier

Value for modifying the “normal” daylighting ground reflectance when Snow is on ground
when calculating the “Ground Reflected Solar Radiation Value”
a value of 1.0 here uses the “normal” ground reflectance
Ground Reflected Solar = (BeamSolar*CosSunZenith + DiffuseSolar)*GroundReflectance
This would be further modified by the Snow Ground Reflectance Modifier when Snow was on the ground
When Snow on ground, effective GroundReflectance is normal GroundReflectance*”Daylighting Ground Reflectance Snow Modifier”
Ground Reflectance achieved in this manner will be restricted to [0.0,1.0]
Default value: 1.0
Parameters:value (float) – value for IDD Field Daylighting Ground Reflected Solar Modifier
Raises:ValueError – if value is not a valid value
Returns:the value of daylighting_ground_reflected_solar_modifier or None if not set
Return type:float
ground_reflected_solar_modifier

field Ground Reflected Solar Modifier

Value for modifying the “normal” ground reflectance when Snow is on ground
when calculating the “Ground Reflected Solar Radiation Value”
a value of 1.0 here uses the “normal” ground reflectance
Ground Reflected Solar = (BeamSolar*CosSunZenith + DiffuseSolar)*GroundReflectance
This would be further modified by the Snow Ground Reflectance Modifier when Snow was on the ground
When Snow on ground, effective GroundReflectance is normal GroundReflectance*”Ground Reflectance Snow Modifier”
Ground Reflectance achieved in this manner will be restricted to [0.0,1.0]
Default value: 1.0
Parameters:value (float) – value for IDD Field Ground Reflected Solar Modifier
Raises:ValueError – if value is not a valid value
Returns:the value of ground_reflected_solar_modifier or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureBuildingSurface

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:BuildingSurface These temperatures are specifically for those surfaces that have the outside environment of “Ground”. Documentation about what values these should be is located in the Auxiliary programs document (Ground Heat Transfer) as well as the InputOutput Reference. CAUTION - Do not use the “undisturbed” ground temperatures from the weather data. These values are too extreme for the soil under a conditioned building. For best results, use the Slab or Basement program to calculate custom monthly average ground temperatures (see Auxiliary Programs). For typical commercial buildings in the USA, a reasonable default value is 2C less than the average indoor space temperature.

april_ground_temperature

field April Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field April Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of april_ground_temperature or None if not set
Return type:float
august_ground_temperature

field August Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field August Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of august_ground_temperature or None if not set
Return type:float
december_ground_temperature

field December Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field December Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of december_ground_temperature or None if not set
Return type:float
february_ground_temperature

field February Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field February Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of february_ground_temperature or None if not set
Return type:float
january_ground_temperature

field January Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field January Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of january_ground_temperature or None if not set
Return type:float
july_ground_temperature

field July Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field July Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of july_ground_temperature or None if not set
Return type:float
june_ground_temperature

field June Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field June Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of june_ground_temperature or None if not set
Return type:float
march_ground_temperature

field March Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field March Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of march_ground_temperature or None if not set
Return type:float
may_ground_temperature

field May Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field May Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of may_ground_temperature or None if not set
Return type:float
november_ground_temperature

field November Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field November Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of november_ground_temperature or None if not set
Return type:float
october_ground_temperature

field October Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field October Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of october_ground_temperature or None if not set
Return type:float
september_ground_temperature

field September Ground Temperature

Units: C
Default value: 18.0
Parameters:value (float) – value for IDD Field September Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of september_ground_temperature or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureDeep

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:Deep These temperatures are specifically for the ground heat exchangers that would use “deep” (3-4 m depth) ground temperatures for their heat source. They are not used in other models.

april_deep_ground_temperature

field April Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field April Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of april_deep_ground_temperature or None if not set
Return type:float
august_deep_ground_temperature

field August Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field August Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of august_deep_ground_temperature or None if not set
Return type:float
december_deep_ground_temperature

field December Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field December Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of december_deep_ground_temperature or None if not set
Return type:float
february_deep_ground_temperature

field February Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field February Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of february_deep_ground_temperature or None if not set
Return type:float
january_deep_ground_temperature

field January Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field January Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of january_deep_ground_temperature or None if not set
Return type:float
july_deep_ground_temperature

field July Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field July Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of july_deep_ground_temperature or None if not set
Return type:float
june_deep_ground_temperature

field June Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field June Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of june_deep_ground_temperature or None if not set
Return type:float
march_deep_ground_temperature

field March Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field March Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of march_deep_ground_temperature or None if not set
Return type:float
may_deep_ground_temperature

field May Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field May Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of may_deep_ground_temperature or None if not set
Return type:float
november_deep_ground_temperature

field November Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field November Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of november_deep_ground_temperature or None if not set
Return type:float
october_deep_ground_temperature

field October Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field October Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of october_deep_ground_temperature or None if not set
Return type:float
september_deep_ground_temperature

field September Deep Ground Temperature

Units: C
Default value: 16.0
Parameters:value (float) – value for IDD Field September Deep Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of september_deep_ground_temperature or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureFcfactorMethod

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:FCfactorMethod These temperatures are specifically for underground walls and ground floors defined with the C-factor and F-factor methods, and should be close to the monthly average outdoor air temperature delayed by 3 months for the location.

april_ground_temperature

field April Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field April Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of april_ground_temperature or None if not set
Return type:float
august_ground_temperature

field August Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field August Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of august_ground_temperature or None if not set
Return type:float
december_ground_temperature

field December Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field December Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of december_ground_temperature or None if not set
Return type:float
february_ground_temperature

field February Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field February Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of february_ground_temperature or None if not set
Return type:float
january_ground_temperature

field January Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field January Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of january_ground_temperature or None if not set
Return type:float
july_ground_temperature

field July Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field July Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of july_ground_temperature or None if not set
Return type:float
june_ground_temperature

field June Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field June Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of june_ground_temperature or None if not set
Return type:float
march_ground_temperature

field March Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field March Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of march_ground_temperature or None if not set
Return type:float
may_ground_temperature

field May Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field May Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of may_ground_temperature or None if not set
Return type:float
november_ground_temperature

field November Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field November Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of november_ground_temperature or None if not set
Return type:float
october_ground_temperature

field October Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field October Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of october_ground_temperature or None if not set
Return type:float
september_ground_temperature

field September Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field September Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of september_ground_temperature or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureShallow

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:Shallow These temperatures are specifically for the Surface Ground Heat Exchanger and should probably be close to the average outdoor air temperature for the location. They are not used in other models.

april_surface_ground_temperature

field April Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field April Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of april_surface_ground_temperature or None if not set
Return type:float
august_surface_ground_temperature

field August Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field August Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of august_surface_ground_temperature or None if not set
Return type:float
december_surface_ground_temperature

field December Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field December Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of december_surface_ground_temperature or None if not set
Return type:float
february_surface_ground_temperature

field February Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field February Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of february_surface_ground_temperature or None if not set
Return type:float
january_surface_ground_temperature

field January Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field January Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of january_surface_ground_temperature or None if not set
Return type:float
july_surface_ground_temperature

field July Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field July Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of july_surface_ground_temperature or None if not set
Return type:float
june_surface_ground_temperature

field June Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field June Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of june_surface_ground_temperature or None if not set
Return type:float
march_surface_ground_temperature

field March Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field March Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of march_surface_ground_temperature or None if not set
Return type:float
may_surface_ground_temperature

field May Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field May Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of may_surface_ground_temperature or None if not set
Return type:float
november_surface_ground_temperature

field November Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field November Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of november_surface_ground_temperature or None if not set
Return type:float
october_surface_ground_temperature

field October Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field October Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of october_surface_ground_temperature or None if not set
Return type:float
september_surface_ground_temperature

field September Surface Ground Temperature

Units: C
Default value: 13.0
Parameters:value (float) – value for IDD Field September Surface Ground Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of september_surface_ground_temperature or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureUndisturbedFiniteDifference

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:Undisturbed:FiniteDifference Undisturbed ground temperature object using a detailed finite difference 1-D model

evapotranspiration_ground_cover_parameter

field Evapotranspiration Ground Cover Parameter

This specifies the ground cover effects during evapotranspiration
calculations. The value roughly represents the following cases:
= 0 : concrete or other solid, non-permeable ground surface material
= 0.5 : short grass, much like a manicured lawn
= 1 : standard reference state (12 cm grass)
= 1.5 : wild growth
Units: dimensionless
Default value: 0.4
value <= 1.5
Parameters:value (float) – value for IDD Field Evapotranspiration Ground Cover Parameter
Raises:ValueError – if value is not a valid value
Returns:the value of evapotranspiration_ground_cover_parameter or None if not set
Return type:float
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
soil_density

field Soil Density

Units: kg/m3
Parameters:value (float) – value for IDD Field Soil Density
Raises:ValueError – if value is not a valid value
Returns:the value of soil_density or None if not set
Return type:float
soil_moisture_content_volume_fraction

field Soil Moisture Content Volume Fraction

Units: percent
Default value: 30.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction or None if not set
Return type:float
soil_moisture_content_volume_fraction_at_saturation

field Soil Moisture Content Volume Fraction at Saturation

Units: percent
Default value: 50.0
value <= 100.0
Parameters:value (float) – value for IDD Field Soil Moisture Content Volume Fraction at Saturation
Raises:ValueError – if value is not a valid value
Returns:the value of soil_moisture_content_volume_fraction_at_saturation or None if not set
Return type:float
soil_specific_heat

field Soil Specific Heat

Units: J/kg-K
Parameters:value (float) – value for IDD Field Soil Specific Heat
Raises:ValueError – if value is not a valid value
Returns:the value of soil_specific_heat or None if not set
Return type:float
soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K
Parameters:value (float) – value for IDD Field Soil Thermal Conductivity
Raises:ValueError – if value is not a valid value
Returns:the value of soil_thermal_conductivity or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureUndisturbedKusudaAchenbach

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:Undisturbed:KusudaAchenbach Undisturbed ground temperature object using the Kusuda-Achenbach 1965 correlation.

average_amplitude_of_surface_temperature

field Average Amplitude of Surface Temperature

Annual average surface temperature variation from average.
If left blank the Site:GroundTemperature:Shallow object must be included in the input
The soil temperature, amplitude, and phase shift must all be included or omitted together
Units: deltaC
Parameters:value (float) – value for IDD Field Average Amplitude of Surface Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of average_amplitude_of_surface_temperature or None if not set
Return type:float
average_soil_surface_temperature

field Average Soil Surface Temperature

Annual average surface temperature
If left blank the Site:GroundTemperature:Shallow object must be included in the input
The soil temperature, amplitude, and phase shift must all be included or omitted together
Units: C
Parameters:value (float) – value for IDD Field Average Soil Surface Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of average_soil_surface_temperature or None if not set
Return type:float
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
phase_shift_of_minimum_surface_temperature

field Phase Shift of Minimum Surface Temperature

The phase shift of minimum surface temperature, or the day
of the year when the minimum surface temperature occurs.
If left blank the Site:GroundTemperature:Shallow object must be included in the input
The soil temperature, amplitude, and phase shift must all be included or omitted together
Units: days
value < 365.0
Parameters:value (float) – value for IDD Field Phase Shift of Minimum Surface Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of phase_shift_of_minimum_surface_temperature or None if not set
Return type:float
soil_density

field Soil Density

Units: kg/m3
Parameters:value (float) – value for IDD Field Soil Density
Raises:ValueError – if value is not a valid value
Returns:the value of soil_density or None if not set
Return type:float
soil_specific_heat

field Soil Specific Heat

Units: J/kg-K
Parameters:value (float) – value for IDD Field Soil Specific Heat
Raises:ValueError – if value is not a valid value
Returns:the value of soil_specific_heat or None if not set
Return type:float
soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K
Parameters:value (float) – value for IDD Field Soil Thermal Conductivity
Raises:ValueError – if value is not a valid value
Returns:the value of soil_thermal_conductivity or None if not set
Return type:float
class pyidf.location_and_climate.SiteGroundTemperatureUndisturbedXing

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:GroundTemperature:Undisturbed:Xing Undisturbed ground temperature object using the Xing 2014 2 harmonic parameter model.

average_soil_surface_tempeature

field Average Soil Surface Tempeature

Units: C
Parameters:value (float) – value for IDD Field Average Soil Surface Tempeature
Raises:ValueError – if value is not a valid value
Returns:the value of average_soil_surface_tempeature or None if not set
Return type:float
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
phase_shift_of_temperature_amplitude_1

field Phase Shift of Temperature Amplitude 1

Units: days
value < 365.0
Parameters:value (float) – value for IDD Field Phase Shift of Temperature Amplitude 1
Raises:ValueError – if value is not a valid value
Returns:the value of phase_shift_of_temperature_amplitude_1 or None if not set
Return type:float
phase_shift_of_temperature_amplitude_2

field Phase Shift of Temperature Amplitude 2

Units: days
value < 365.0
Parameters:value (float) – value for IDD Field Phase Shift of Temperature Amplitude 2
Raises:ValueError – if value is not a valid value
Returns:the value of phase_shift_of_temperature_amplitude_2 or None if not set
Return type:float
soil_density

field Soil Density

Units: kg/m3
Parameters:value (float) – value for IDD Field Soil Density
Raises:ValueError – if value is not a valid value
Returns:the value of soil_density or None if not set
Return type:float
soil_specific_heat

field Soil Specific Heat

Units: J/kg-K
Parameters:value (float) – value for IDD Field Soil Specific Heat
Raises:ValueError – if value is not a valid value
Returns:the value of soil_specific_heat or None if not set
Return type:float
soil_surface_temperature_amplitude_1

field Soil Surface Temperature Amplitude 1

Units: deltaC
Parameters:value (float) – value for IDD Field Soil Surface Temperature Amplitude 1
Raises:ValueError – if value is not a valid value
Returns:the value of soil_surface_temperature_amplitude_1 or None if not set
Return type:float
soil_surface_temperature_amplitude_2

field Soil Surface Temperature Amplitude 2

Units: deltaC
Parameters:value (float) – value for IDD Field Soil Surface Temperature Amplitude 2
Raises:ValueError – if value is not a valid value
Returns:the value of soil_surface_temperature_amplitude_2 or None if not set
Return type:float
soil_thermal_conductivity

field Soil Thermal Conductivity

Units: W/m-K
Parameters:value (float) – value for IDD Field Soil Thermal Conductivity
Raises:ValueError – if value is not a valid value
Returns:the value of soil_thermal_conductivity or None if not set
Return type:float
class pyidf.location_and_climate.SiteHeightVariation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:HeightVariation This object is used if the user requires advanced control over height-dependent variations in wind speed and temperature. When this object is not present, the default model for temperature dependence on height is used, and the wind speed is modeled according to the Terrain field of the BUILDING object.

air_temperature_gradient_coefficient

field Air Temperature Gradient Coefficient

Set to zero for no air temperature dependence on height.
Units: K/m
Default value: 0.0065
Parameters:value (float) – value for IDD Field Air Temperature Gradient Coefficient
Raises:ValueError – if value is not a valid value
Returns:the value of air_temperature_gradient_coefficient or None if not set
Return type:float
wind_speed_profile_boundary_layer_thickness

field Wind Speed Profile Boundary Layer Thickness

Units: m
Default value: 370.0
Parameters:value (float) – value for IDD Field Wind Speed Profile Boundary Layer Thickness
Raises:ValueError – if value is not a valid value
Returns:the value of wind_speed_profile_boundary_layer_thickness or None if not set
Return type:float
wind_speed_profile_exponent

field Wind Speed Profile Exponent

Set to zero for no wind speed dependence on height.
Default value: 0.22
Parameters:value (float) – value for IDD Field Wind Speed Profile Exponent
Raises:ValueError – if value is not a valid value
Returns:the value of wind_speed_profile_exponent or None if not set
Return type:float
class pyidf.location_and_climate.SiteLocation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:Location Specifies the building’s location. Only one location is allowed. Weather data file location, if it exists, will override this object.

elevation

field Elevation

Units: m
value >= -300.0
value < 8900.0
Parameters:value (float) – value for IDD Field Elevation
Raises:ValueError – if value is not a valid value
Returns:the value of elevation or None if not set
Return type:float
latitude

field Latitude

+ is North, - is South, degree minutes represented in decimal (i.e. 30 minutes is .5)
Units: deg
value >= -90.0
value <= 90.0
Parameters:value (float) – value for IDD Field Latitude
Raises:ValueError – if value is not a valid value
Returns:the value of latitude or None if not set
Return type:float
longitude

field Longitude

- is West, + is East, degree minutes represented in decimal (i.e. 30 minutes is .5)
Units: deg
value >= -180.0
value <= 180.0
Parameters:value (float) – value for IDD Field Longitude
Raises:ValueError – if value is not a valid value
Returns:the value of longitude or None if not set
Return type:float
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
time_zone

field Time Zone

basic these limits on the WorldTimeZone Map (2003)
Time relative to GMT. Decimal hours.
Units: hr
value >= -12.0
value <= 14.0
Parameters:value (float) – value for IDD Field Time Zone
Raises:ValueError – if value is not a valid value
Returns:the value of time_zone or None if not set
Return type:float
class pyidf.location_and_climate.SitePrecipitation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:Precipitation Used to describe the amount of water precipitation at the building site. Precipitation includes both rain and the equivalent water content of snow.

average_total_annual_precipitation

field Average Total Annual Precipitation

meters of water per year from average weather statistics
Units: m/yr
Parameters:value (float) – value for IDD Field Average Total Annual Precipitation
Raises:ValueError – if value is not a valid value
Returns:the value of average_total_annual_precipitation or None if not set
Return type:float
design_level_for_total_annual_precipitation

field Design Level for Total Annual Precipitation

meters of water per year used for design level
Units: m/yr
Parameters:value (float) – value for IDD Field Design Level for Total Annual Precipitation
Raises:ValueError – if value is not a valid value
Returns:the value of design_level_for_total_annual_precipitation or None if not set
Return type:float
precipitation_model_type

field Precipitation Model Type

Parameters:value (str) – value for IDD Field Precipitation Model Type
Raises:ValueError – if value is not a valid value
Returns:the value of precipitation_model_type or None if not set
Return type:str
precipitation_rates_schedule_name

field Precipitation Rates Schedule Name

Schedule values in meters of water per hour
values should be non-negative
Parameters:value (str) – value for IDD Field Precipitation Rates Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of precipitation_rates_schedule_name or None if not set
Return type:str
class pyidf.location_and_climate.SiteSolarAndVisibleSpectrum

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:SolarAndVisibleSpectrum If this object is omitted, the default solar and visible spectrum data will be used.

name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
solar_spectrum_data_object_name

field Solar Spectrum Data Object Name

Parameters:value (str) – value for IDD Field Solar Spectrum Data Object Name
Raises:ValueError – if value is not a valid value
Returns:the value of solar_spectrum_data_object_name or None if not set
Return type:str
spectrum_data_method

field Spectrum Data Method

The method specifies which of the solar and visible spectrum data to use in the calculations.
Choices: Default - existing hard-wired spectrum data in EnergyPlus.
UserDefined - user specified spectrum data referenced by the next two fields
Default value: Default
Parameters:value (str) – value for IDD Field Spectrum Data Method
Raises:ValueError – if value is not a valid value
Returns:the value of spectrum_data_method or None if not set
Return type:str
visible_spectrum_data_object_name

field Visible Spectrum Data Object Name

Parameters:value (str) – value for IDD Field Visible Spectrum Data Object Name
Raises:ValueError – if value is not a valid value
Returns:the value of visible_spectrum_data_object_name or None if not set
Return type:str
class pyidf.location_and_climate.SiteSpectrumData

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:SpectrumData Spectrum Data Type is followed by up to 107 sets of normal-incidence measured values of [wavelength, spectrum] for wavelengths covering the solar (0.25 to 2.5 microns) or visible spectrum (0.38 to 0.78 microns)

name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
spectrum

field Spectrum

Parameters:value (float) – value for IDD Field Spectrum
Raises:ValueError – if value is not a valid value
Returns:the value of spectrum or None if not set
Return type:float
spectrum_data_type

field Spectrum Data Type

Parameters:value (str) – value for IDD Field Spectrum Data Type
Raises:ValueError – if value is not a valid value
Returns:the value of spectrum_data_type or None if not set
Return type:str
spectrum_v3

field Spectrum v3

Parameters:value (float) – value for IDD Field Spectrum v3
Raises:ValueError – if value is not a valid value
Returns:the value of spectrum_v3 or None if not set
Return type:float
spectrum_v4_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3

field Spectrum v4 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3

Parameters:value (float) – value for IDD Field Spectrum v4 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3 v3
Raises:ValueError – if value is not a valid value
Returns:the value of spectrum_v4_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3_v3 or None if not set
Return type:float
wavelength

field Wavelength

Units: micron
Parameters:value (float) – value for IDD Field Wavelength
Raises:ValueError – if value is not a valid value
Returns:the value of wavelength or None if not set
Return type:float
wavelength_v3

field Wavelength v3

Units: micron
Parameters:value (float) – value for IDD Field Wavelength v3
Raises:ValueError – if value is not a valid value
Returns:the value of wavelength_v3 or None if not set
Return type:float
wavelength_v4

field Wavelength v4

Units: micron
Parameters:value (float) – value for IDD Field Wavelength v4
Raises:ValueError – if value is not a valid value
Returns:the value of wavelength_v4 or None if not set
Return type:float
class pyidf.location_and_climate.SiteWaterMainsTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:WaterMainsTemperature Used to calculate water mains temperatures delivered by underground water main pipes. Water mains temperatures are a function of outdoor climate conditions and vary with time of year.

annual_average_outdoor_air_temperature

field Annual Average Outdoor Air Temperature

Units: C
Parameters:value (float) – value for IDD Field Annual Average Outdoor Air Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of annual_average_outdoor_air_temperature or None if not set
Return type:float
calculation_method

field Calculation Method

Parameters:value (str) – value for IDD Field Calculation Method
Raises:ValueError – if value is not a valid value
Returns:the value of calculation_method or None if not set
Return type:str
maximum_difference_in_monthly_average_outdoor_air_temperatures

field Maximum Difference In Monthly Average Outdoor Air Temperatures

Units: deltaC
Parameters:value (float) – value for IDD Field Maximum Difference In Monthly Average Outdoor Air Temperatures
Raises:ValueError – if value is not a valid value
Returns:the value of maximum_difference_in_monthly_average_outdoor_air_temperatures or None if not set
Return type:float
temperature_schedule_name

field Temperature Schedule Name

Parameters:value (str) – value for IDD Field Temperature Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of temperature_schedule_name or None if not set
Return type:str
class pyidf.location_and_climate.SiteWeatherStation

Bases: pyidf.helper.DataObject

Corresponds to IDD object Site:WeatherStation This object should only be used for non-standard weather data. Standard weather data such as TMY2, IWEC, and ASHRAE design day data are all measured at the default conditions and do not require this object.

air_temperature_sensor_height_above_ground

field Air Temperature Sensor Height Above Ground

Units: m
Default value: 1.5
Parameters:value (float) – value for IDD Field Air Temperature Sensor Height Above Ground
Raises:ValueError – if value is not a valid value
Returns:the value of air_temperature_sensor_height_above_ground or None if not set
Return type:float
wind_sensor_height_above_ground

field Wind Sensor Height Above Ground

Units: m
Default value: 10.0
Parameters:value (float) – value for IDD Field Wind Sensor Height Above Ground
Raises:ValueError – if value is not a valid value
Returns:the value of wind_sensor_height_above_ground or None if not set
Return type:float
wind_speed_profile_boundary_layer_thickness

field Wind Speed Profile Boundary Layer Thickness

Units: m
Default value: 270.0
Parameters:value (float) – value for IDD Field Wind Speed Profile Boundary Layer Thickness
Raises:ValueError – if value is not a valid value
Returns:the value of wind_speed_profile_boundary_layer_thickness or None if not set
Return type:float
wind_speed_profile_exponent

field Wind Speed Profile Exponent

Default value: 0.14
Parameters:value (float) – value for IDD Field Wind Speed Profile Exponent
Raises:ValueError – if value is not a valid value
Returns:the value of wind_speed_profile_exponent or None if not set
Return type:float
class pyidf.location_and_climate.SizingPeriodDesignDay

Bases: pyidf.helper.DataObject

Corresponds to IDD object SizingPeriod:DesignDay The design day object creates the parameters for the program to create the 24 hour weather profile that can be used for sizing as well as running to test the other simulation parameters. Parameters in this include a date (month and day), a day type (which uses the appropriate schedules for either sizing or simple tests), min/max temperatures, wind speeds, and solar radiation values.

ashrae_clear_sky_optical_depth_for_beam_irradiance_taub

field ASHRAE Clear Sky Optical Depth for Beam Irradiance (taub)

Required if Solar Model Indicator = ASHRAETau
Units: dimensionless
value <= 1.2
Parameters:value (float) – value for IDD Field ASHRAE Clear Sky Optical Depth for Beam Irradiance (taub)
Raises:ValueError – if value is not a valid value
Returns:the value of ashrae_clear_sky_optical_depth_for_beam_irradiance_taub or None if not set
Return type:float
ashrae_clear_sky_optical_depth_for_diffuse_irradiance_taud

field ASHRAE Clear Sky Optical Depth for Diffuse Irradiance (taud)

Required if Solar Model Indicator = ASHRAETau
Units: dimensionless
value <= 3.0
Parameters:value (float) – value for IDD Field ASHRAE Clear Sky Optical Depth for Diffuse Irradiance (taud)
Raises:ValueError – if value is not a valid value
Returns:the value of ashrae_clear_sky_optical_depth_for_diffuse_irradiance_taud or None if not set
Return type:float
barometric_pressure

field Barometric Pressure

This field’s value is also checked against the calculated “standard barometric pressure”
for the location. If out of range (>10%) or blank, then is replaced by standard value.
Units: Pa
IP-Units: inHg
value >= 31000.0
value <= 120000.0
Parameters:value (float) – value for IDD Field Barometric Pressure
Raises:ValueError – if value is not a valid value
Returns:the value of barometric_pressure or None if not set
Return type:float
beam_solar_day_schedule_name

field Beam Solar Day Schedule Name

if Solar Model Indicator = Schedule, then beam schedule name (for day)
Parameters:value (str) – value for IDD Field Beam Solar Day Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of beam_solar_day_schedule_name or None if not set
Return type:str
daily_drybulb_temperature_range

field Daily Dry-Bulb Temperature Range

Must still produce appropriate maximum dry-bulb (within range)
This field is not needed if Dry-Bulb Temperature Range Modifier Type
is “delta”.
Units: deltaC
Parameters:value (float) – value for IDD Field Daily Dry-Bulb Temperature Range
Raises:ValueError – if value is not a valid value
Returns:the value of daily_drybulb_temperature_range or None if not set
Return type:float
daily_wetbulb_temperature_range

field Daily Wet-Bulb Temperature Range

Required only if Humidity Condition Type = “WetbulbProfileMultiplierSchedule” or
“WetBulbProfileDefaultMultipliers”
Units: deltaC
Parameters:value (float) – value for IDD Field Daily Wet-Bulb Temperature Range
Raises:ValueError – if value is not a valid value
Returns:the value of daily_wetbulb_temperature_range or None if not set
Return type:float
day_of_month

field Day of Month

must be valid for Month field
value >= 1
value <= 31
Parameters:value (int) – value for IDD Field Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of day_of_month or None if not set
Return type:int
day_type

field Day Type

Day Type selects the schedules appropriate for this design day
Parameters:value (str) – value for IDD Field Day Type
Raises:ValueError – if value is not a valid value
Returns:the value of day_type or None if not set
Return type:str
daylight_saving_time_indicator

field Daylight Saving Time Indicator

Yes – use schedules modified for Daylight Saving Time Schedules.
No - do not use schedules modified for Daylight Saving Time Schedules
Default value: No
Parameters:value (str) – value for IDD Field Daylight Saving Time Indicator
Raises:ValueError – if value is not a valid value
Returns:the value of daylight_saving_time_indicator or None if not set
Return type:str
diffuse_solar_day_schedule_name

field Diffuse Solar Day Schedule Name

if Solar Model Indicator = Schedule, then diffuse schedule name (for day)
Parameters:value (str) – value for IDD Field Diffuse Solar Day Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of diffuse_solar_day_schedule_name or None if not set
Return type:str
drybulb_temperature_range_modifier_day_schedule_name

field Dry-Bulb Temperature Range Modifier Day Schedule Name

Only used when previous field is “MultiplierSchedule”, “DifferenceSchedule” or
“TemperatureProfileSchedule”.
For type “MultiplierSchedule” the hour/time interval values should specify
the fraction (0-1) of the dry-bulb temperature range to be subtracted
from the maximum dry-bulb temperature for each timestep in the day
For type “DifferenceSchedule” the values should specify a number to be subtracted
from the maximum dry-bulb temperature for each timestep in the day.
Note that numbers in the difference schedule cannot be negative as that
would result in a higher maximum than the maximum previously specified.
For type “TemperatureProfileSchedule” the values should specify the actual dry-bulb
temperature for each timestep in the day.
Parameters:value (str) – value for IDD Field Dry-Bulb Temperature Range Modifier Day Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of drybulb_temperature_range_modifier_day_schedule_name or None if not set
Return type:str
drybulb_temperature_range_modifier_type

field Dry-Bulb Temperature Range Modifier Type

Type of modifier to the dry-bulb temperature calculated for the timestep
Default value: DefaultMultipliers
Parameters:value (str) – value for IDD Field Dry-Bulb Temperature Range Modifier Type
Raises:ValueError – if value is not a valid value
Returns:the value of drybulb_temperature_range_modifier_type or None if not set
Return type:str
humidity_condition_day_schedule_name

field Humidity Condition Day Schedule Name

Only used when Humidity Condition Type is “RelativeHumiditySchedule”,
“WetBulbProfileMultiplierSchedule”, or “WetBulbProfileDifferenceSchedule”
For type “RelativeHumiditySchedule”, the hour/time interval values should specify
relative humidity (percent) from 0.0 to 100.0.
For type “WetBulbProfileMultiplierSchedule” the hour/time interval values should specify
the fraction (0-1) of the wet-bulb temperature range to be subtracted from the
maximum wet-bulb temperature for each timestep in the day (units = Fraction)
For type “WetBulbProfileDifferenceSchedule” the values should specify a number to be subtracted
from the maximum wet-bulb temperature for each timestep in the day. (units = deltaC)
Parameters:value (str) – value for IDD Field Humidity Condition Day Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of humidity_condition_day_schedule_name or None if not set
Return type:str
humidity_condition_type

field Humidity Condition Type

values/schedules indicated here and in subsequent fields create the humidity
values in the 24 hour design day conditions profile.
Default value: WetBulb
Parameters:value (str) – value for IDD Field Humidity Condition Type
Raises:ValueError – if value is not a valid value
Returns:the value of humidity_condition_type or None if not set
Return type:str
humidity_ratio_at_maximum_drybulb_v3

field Humidity Ratio at Maximum Dry-Bulb v3

Humidity ratio coincident with the maximum temperature (constant humidity ratio throughout day).
Required only if field Humidity Condition Type is “HumidityRatio”.
Enthalpy coincident with the maximum temperature.
Required only if field Humidity Condition Type is “Enthalpy”.
Units: J/kg
Parameters:value (float) – value for IDD Field Humidity Ratio at Maximum Dry-Bulb v3
Raises:ValueError – if value is not a valid value
Returns:the value of humidity_ratio_at_maximum_drybulb_v3 or None if not set
Return type:float
maximum_drybulb_temperature

field Maximum Dry-Bulb Temperature

This field is required when field “Dry-Bulb Temperature Range Modifier Type”
is not “TemperatureProfileSchedule”.
Units: C
value >= -90.0
value <= 70.0
Parameters:value (float) – value for IDD Field Maximum Dry-Bulb Temperature
Raises:ValueError – if value is not a valid value
Returns:the value of maximum_drybulb_temperature or None if not set
Return type:float
month

field Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field Month
Raises:ValueError – if value is not a valid value
Returns:the value of month or None if not set
Return type:int
name

field Name

Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
rain_indicator

field Rain Indicator

Yes is raining (all day), No is not raining
Default value: No
Parameters:value (str) – value for IDD Field Rain Indicator
Raises:ValueError – if value is not a valid value
Returns:the value of rain_indicator or None if not set
Return type:str
sky_clearness

field Sky Clearness

Used if Sky Model Indicator = ASHRAEClearSky or ZhangHuang
0.0 is totally unclear, 1.0 is totally clear
value <= 1.2
Parameters:value (float) – value for IDD Field Sky Clearness
Raises:ValueError – if value is not a valid value
Returns:the value of sky_clearness or None if not set
Return type:float
snow_indicator

field Snow Indicator

Yes is Snow on Ground, No is no Snow on Ground
Default value: No
Parameters:value (str) – value for IDD Field Snow Indicator
Raises:ValueError – if value is not a valid value
Returns:the value of snow_indicator or None if not set
Return type:str
solar_model_indicator

field Solar Model Indicator

Default value: ASHRAEClearSky
Parameters:value (str) – value for IDD Field Solar Model Indicator
Raises:ValueError – if value is not a valid value
Returns:the value of solar_model_indicator or None if not set
Return type:str
wetbulb_or_dewpoint_at_maximum_drybulb

field Wetbulb or DewPoint at Maximum Dry-Bulb

Wetbulb or dewpoint temperature coincident with the maximum temperature.
Required only if field Humidity Condition Type is “Wetbulb”, “Dewpoint”,
“WetBulbProfileMultiplierSchedule”, “WetBulbProfileDifferenceSchedule”,
or “WetBulbProfileDefaultMultipliers”
Units: C
Parameters:value (float) – value for IDD Field Wetbulb or DewPoint at Maximum Dry-Bulb
Raises:ValueError – if value is not a valid value
Returns:the value of wetbulb_or_dewpoint_at_maximum_drybulb or None if not set
Return type:float
wind_direction

field Wind Direction

North=0.0 East=90.0
0 and 360 are the same direction.
Units: deg
value <= 360.0
Parameters:value (float) – value for IDD Field Wind Direction
Raises:ValueError – if value is not a valid value
Returns:the value of wind_direction or None if not set
Return type:float
wind_speed

field Wind Speed

Units: m/s
IP-Units: miles/hr
value <= 40.0
Parameters:value (float) – value for IDD Field Wind Speed
Raises:ValueError – if value is not a valid value
Returns:the value of wind_speed or None if not set
Return type:float
class pyidf.location_and_climate.SizingPeriodWeatherFileConditionType

Bases: pyidf.helper.DataObject

Corresponds to IDD object SizingPeriod:WeatherFileConditionType Use a weather file period for design sizing calculations. EPW weather files are created with typical and extreme periods created heuristically from the weather file data. For more details on these periods, see AuxiliaryPrograms document.

day_of_week_for_start_day

field Day of Week for Start Day

=[|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|SummerDesignDay|WinterDesignDay|
|CustomDay1|CustomDay2];
if you use SummerDesignDay or WinterDesignDay or the CustomDays then this will apply
to the whole period; other days (i.e., Monday) will signify a start day and
normal sequence of subsequent days
Default value: Monday
Parameters:value (str) – value for IDD Field Day of Week for Start Day
Raises:ValueError – if value is not a valid value
Returns:the value of day_of_week_for_start_day or None if not set
Return type:str
name

field Name

user supplied name for reporting
Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
period_selection

field Period Selection

Following is a list of all possible types of Extreme and Typical periods that
might be identified in the Weather File. Not all possible types are available
for all weather files.
Parameters:value (str) – value for IDD Field Period Selection
Raises:ValueError – if value is not a valid value
Returns:the value of period_selection or None if not set
Return type:str
use_weather_file_daylight_saving_period

field Use Weather File Daylight Saving Period

If yes or blank, use daylight saving period as specified on Weatherfile.
If no, do not use the daylight saving period as specified on the Weatherfile.
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Daylight Saving Period
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_daylight_saving_period or None if not set
Return type:str
use_weather_file_rain_and_snow_indicators

field Use Weather File Rain and Snow Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Rain and Snow Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_rain_and_snow_indicators or None if not set
Return type:str
class pyidf.location_and_climate.SizingPeriodWeatherFileDays

Bases: pyidf.helper.DataObject

Corresponds to IDD object SizingPeriod:WeatherFileDays Use a weather file period for design sizing calculations.

begin_day_of_month

field Begin Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field Begin Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_day_of_month or None if not set
Return type:int
begin_month

field Begin Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field Begin Month
Raises:ValueError – if value is not a valid value
Returns:the value of begin_month or None if not set
Return type:int
day_of_week_for_start_day

field Day of Week for Start Day

=[|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|SummerDesignDay|WinterDesignDay|
|CustomDay1|CustomDay2];
if you use SummerDesignDay or WinterDesignDay or the CustomDays then this will apply
to the whole period; other days (i.e., Monday) will signify a start day and
normal sequence of subsequent days
Default value: Monday
Parameters:value (str) – value for IDD Field Day of Week for Start Day
Raises:ValueError – if value is not a valid value
Returns:the value of day_of_week_for_start_day or None if not set
Return type:str
end_day_of_month

field End Day of Month

value >= 1
value <= 31
Parameters:value (int) – value for IDD Field End Day of Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_day_of_month or None if not set
Return type:int
end_month

field End Month

value >= 1
value <= 12
Parameters:value (int) – value for IDD Field End Month
Raises:ValueError – if value is not a valid value
Returns:the value of end_month or None if not set
Return type:int
name

field Name

user supplied name for reporting
Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
use_weather_file_daylight_saving_period

field Use Weather File Daylight Saving Period

If yes or blank, use daylight saving period as specified on Weatherfile.
If no, do not use the daylight saving period as specified on the Weatherfile.
Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Daylight Saving Period
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_daylight_saving_period or None if not set
Return type:str
use_weather_file_rain_and_snow_indicators

field Use Weather File Rain and Snow Indicators

Default value: Yes
Parameters:value (str) – value for IDD Field Use Weather File Rain and Snow Indicators
Raises:ValueError – if value is not a valid value
Returns:the value of use_weather_file_rain_and_snow_indicators or None if not set
Return type:str
class pyidf.location_and_climate.WeatherPropertySkyTemperature

Bases: pyidf.helper.DataObject

Corresponds to IDD object WeatherProperty:SkyTemperature This object is used to override internal sky temperature calculations.

calculation_type

field Calculation Type

Parameters:value (str) – value for IDD Field Calculation Type
Raises:ValueError – if value is not a valid value
Returns:the value of calculation_type or None if not set
Return type:str
name

field Name

blank in this field will apply to all run periods (that is, all objects=
SizingPeriod:WeatherFileDays, SizingPeriod:WeatherFileConditionType or RunPeriod
otherwise, this name must match one of the environment object names.
Parameters:value (str) – value for IDD Field Name
Raises:ValueError – if value is not a valid value
Returns:the value of name or None if not set
Return type:str
schedule_name

field Schedule Name

if name matches a SizingPeriod:DesignDay, put in a day schedule of this name
if name is for a SizingPeriod:WeatherFileDays, SizingPeriod:WeatherFileConditionType or
RunPeriod, put in a full year schedule that covers the appropriate days.
Parameters:value (str) – value for IDD Field Schedule Name
Raises:ValueError – if value is not a valid value
Returns:the value of schedule_name or None if not set
Return type:str