Location and Climate¶

27 object types from idfpy.models.location · EnergyPlus 26.2

Object	Summary
RoofIrrigation	Used to describe the amount of irrigation on the ecoroof surface over the course of the simulation runperiod.
RunPeriod	Specify a range of dates and other parameters for a simulation.
RunPeriodControl:DaylightSavingTime	This object sets up the daylight saving time period for any RunPeriod.
RunPeriodControl:SpecialDays	This object sets up holidays/special days to be used during weather file run periods.
Site:GroundDomain:Basement	Ground-coupled basement model for simulating basements or other underground zones.
Site:GroundDomain:Slab	Ground-coupled slab model for on-grade and in-grade cases with or without insulation.
Site:GroundReflectance	Specifies the ground reflectance values used to calculate ground reflected solar.
Site:GroundReflectance:SnowModifier	Specifies ground reflectance multipliers when snow resident on the ground.
Site:GroundTemperature:BuildingSurface	These temperatures are specifically for those surfaces that have the outside environment of "Ground".
Site:GroundTemperature:Deep	These temperatures are specifically for the ground heat exchangers that would use "deep" (3-4 m depth) ground …
Site:GroundTemperature:FCfactorMethod	These temperatures are specifically for underground walls and ground floors defined with the C-factor and …
Site:GroundTemperature:Shallow	These temperatures are specifically for the Surface Ground Heat Exchanger and should probably be close to the …
Site:GroundTemperature:Undisturbed:FiniteDifference	Undisturbed ground temperature object using a detailed finite difference 1-D model
Site:GroundTemperature:Undisturbed:KusudaAchenbach	Undisturbed ground temperature object using the Kusuda-Achenbach 1965 correlation.
Site:GroundTemperature:Undisturbed:Xing	Undisturbed ground temperature object using the Xing 2014 2 harmonic parameter model.
Site:HeightVariation	This object is used if the user requires advanced control over height-dependent variations in wind speed and …
Site:Location	Specifies the building's location.
Site:Precipitation	Used to describe the amount of water precipitation at the building site.
Site:SolarAndVisibleSpectrum	If this object is omitted, the default solar and visible spectrum data will be used.
Site:SpectrumData	Spectrum Data Type is followed by up to 107 sets of normal-incidence measured values of [wavelength, …
Site:VariableLocation	Captures the scheduling of a moving/reorienting building, or more likely a vessel
Site:WaterMainsTemperature	Used to calculate water mains temperatures delivered by underground water main pipes.
Site:WeatherStation	This object should only be used for non-standard weather data.
SizingPeriod:DesignDay	The design day object creates the parameters for the program to create the 24 hour weather profile that can …
SizingPeriod:WeatherFileConditionType	Use a weather file period for design sizing calculations.
SizingPeriod:WeatherFileDays	Use a weather file period for design sizing calculations.
WeatherProperty:SkyTemperature	This object is used to override internal sky temperature calculations.

RoofIrrigation¶

from idfpy.models import RoofIrrigation

Used to describe the amount of irrigation on the ecoroof surface over the course of the simulation runperiod.

Field	Type	Default	Details
`irrigation_model_type` Irrigation Model Type	choice		SmartSchedule will not allow irrigation when soil is already moist. Current threshold set at 30% of saturation. One of `Schedule`, `SmartSchedule`
`irrigation_rate_schedule_name` Irrigation Rate Schedule Name	reference		Schedule values in meters of water per hour values should be non-negative Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`irrigation_maximum_saturation_threshold` Irrigation Maximum Saturation Threshold	number percent	`40.0`	Used with SmartSchedule to set the saturation level at which no irrigation is allowed. Range: ≥ 0, ≤ 100

RunPeriod¶

from idfpy.models import RunPeriod

Specify a range of dates and other parameters for a simulation. Multiple run periods may be input, but they may not overlap.

Field	Type	Default	Details
`name` Name required	string		descriptive name (used in reporting mainly) Cannot be not blank and must be unique
`begin_month` Begin Month required	integer		Range: ≥ 1, ≤ 12
`begin_day_of_month` Begin Day of Month required	integer		Range: ≥ 1, ≤ 31
`begin_year` Begin Year	number		Start year of the simulation, if this field is specified it must agree with the Day of Week for Start Day If this field is blank, the year will be selected to match the weekday, which is Sunday if not specified
`end_month` End Month required	integer		Range: ≥ 1, ≤ 12
`end_day_of_month` End Day of Month required	integer		Range: ≥ 1, ≤ 31
`end_year` End Year	number		end year of simulation, if specified
`day_of_week_for_start_day` Day of Week for Start Day	choice		=[Sunday\|Monday\|Tuesday\|Wednesday\|Thursday\|Friday\|Saturday]; If no year is input, this field will default to Sunday If a year is input and this field is blank, the correct weekday is determined One of `Friday`, `Monday`, `Saturday`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`
`use_weather_file_holidays_and_special_days` Use Weather File Holidays and Special Days	choice	`Yes`	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). One of `No`, `Yes`
`use_weather_file_daylight_saving_period` Use Weather File Daylight Saving Period	choice	`Yes`	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. One of `No`, `Yes`
`apply_weekend_holiday_rule` Apply Weekend Holiday Rule	choice	`No`	if yes and single day holiday falls on weekend, "holiday" occurs on following Monday One of `No`, `Yes`
`use_weather_file_rain_indicators` Use Weather File Rain Indicators	choice	`Yes`	One of `No`, `Yes`
`use_weather_file_snow_indicators` Use Weather File Snow Indicators	choice	`Yes`	One of `No`, `Yes`
`treat_weather_as_actual` Treat Weather as Actual	choice	`No`	One of `No`, `Yes`
`first_hour_interpolation_starting_values` First Hour Interpolation Starting Values	choice	`Hour24`	When the weather data timestep is longer than the simulation timestep, weather data is interpolated. For the first hour of the simulation, this field specifies which values from the first day of the run period to use as the interpolation starting point. This same interpolation will be used for repeated warmup days. One of `Hour1`, `Hour24`

Referenced by 1 object types

WeatherProperty:SkyTemperature

RunPeriodControl:DaylightSavingTime¶

from idfpy.models import RunPeriodControlDaylightSavingTime unique

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.

Field	Type	Default	Details
`start_date` Start Date required	string
`end_date` End Date required	string		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 1^st, 2 or 2^nd, etc. up to 5(?)

RunPeriodControl:SpecialDays¶

from idfpy.models import RunPeriodControlSpecialDays

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).

Field	Type	Default	Details
`name` Name required	string
`start_date` Start Date required	string		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 1^st, 2 or 2^nd, etc. up to 5(?)
`duration` Duration	number days	`1.0`	Range: ≥ 1, ≤ 366
`special_day_type` Special Day Type	choice	`Holiday`	Special Day Type selects the schedules appropriate for each day so labeled One of `CustomDay1`, `CustomDay2`, `Holiday`, `SummerDesignDay`, `WinterDesignDay`

Site:GroundDomain:Basement¶

from idfpy.models import SiteGroundDomainBasement

Ground-coupled basement model for simulating basements or other underground zones.

Field	Type	Default	Details
`name` Name required	string
`ground_domain_depth` Ground Domain Depth	number m	`10.0`	The depth from ground surface to the deep ground boundary of the domain. Range: > 0
`aspect_ratio` Aspect Ratio	number	`1.0`	This defines the height to width ratio of the basement zone.
`perimeter_offset` Perimeter Offset	number m	`5.0`	The distance from the basement wall edge to the edge of the ground domain Range: > 0
`soil_thermal_conductivity` Soil Thermal Conductivity	number W/m-K	`1.5`	Range: > 0
`soil_density` Soil Density	number kg/m3	`2800.0`	Range: > 0
`soil_specific_heat` Soil Specific Heat	number J/kg-K	`850.0`	Range: > 0
`soil_moisture_content_volume_fraction` Soil Moisture Content Volume Fraction	number percent	`30.0`	Range: ≥ 0, ≤ 100
`soil_moisture_content_volume_fraction_at_saturation` Soil Moisture Content Volume Fraction at Saturation	number percent	`50.0`	Range: ≥ 0, ≤ 100
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`evapotranspiration_ground_cover_parameter` Evapotranspiration Ground Cover Parameter	number	`0.4`	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 Range: ≥ 0, ≤ 1.5
`basement_floor_boundary_condition_model_name` Basement Floor Boundary Condition Model Name required	reference		Names a SurfaceProperty:OtherSideConditionsModel
`horizontal_insulation` Horizontal Insulation	choice	`No`	This field specifies the presence of insulation beneath the basement floor. One of `No`, `Yes`
`horizontal_insulation_material_name` Horizontal Insulation Material Name	reference		Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`horizontal_insulation_extents` Horizontal Insulation Extents	choice	`Full`	This field specifies whether the horizontal insulation fully insulates the surface or is perimeter only insulation One of `Full`, `Perimeter`
`perimeter_horizontal_insulation_width` Perimeter Horizontal Insulation Width	number m		Width of horizontal perimeter insulation measured from foundation wall inside surface. Range: > 0
`basement_wall_depth` Basement Wall Depth	number m		Depth measured from ground surface. Range: > 0
`basement_wall_boundary_condition_model_name` Basement Wall Boundary Condition Model Name required	reference		Names a SurfaceProperty:OtherSideConditionsModel
`vertical_insulation` Vertical Insulation	choice	`No`	One of `No`, `Yes`
`basement_wall_vertical_insulation_material_name` Basement Wall Vertical Insulation Material Name	reference		Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`vertical_insulation_depth` Vertical Insulation Depth	number m		Depth measured from the ground surface. Range: > 0
`simulation_timestep` Simulation Timestep	choice	`Hourly`	This field specifies the basement domain simulation interval. One of `Hourly`, `Timestep`
`mesh_density_parameter` Mesh Density Parameter	integer	`4`	Range: ≥ 2

Site:GroundDomain:Slab¶

from idfpy.models import SiteGroundDomainSlab

Ground-coupled slab model for on-grade and in-grade cases with or without insulation.

Field	Type	Default	Details
`name` Name required	string
`ground_domain_depth` Ground Domain Depth	number m	`10.0`	Range: > 0
`aspect_ratio` Aspect Ratio	number	`1.0`
`perimeter_offset` Perimeter Offset	number m	`5.0`	Range: > 0
`soil_thermal_conductivity` Soil Thermal Conductivity	number W/m-K	`1.5`	Range: > 0
`soil_density` Soil Density	number kg/m3	`2800.0`	Range: > 0
`soil_specific_heat` Soil Specific Heat	number J/kg-K	`850.0`	Range: > 0
`soil_moisture_content_volume_fraction` Soil Moisture Content Volume Fraction	number percent	`30.0`	Range: ≥ 0, ≤ 100
`soil_moisture_content_volume_fraction_at_saturation` Soil Moisture Content Volume Fraction at Saturation	number percent	`50.0`	Range: ≥ 0, ≤ 100
`undisturbed_ground_temperature_model_type` Undisturbed Ground Temperature Model Type required	choice		One of `Site:GroundTemperature:Undisturbed:FiniteDifference`, `Site:GroundTemperature:Undisturbed:KusudaAchenbach`, `Site:GroundTemperature:Undisturbed:Xing`
`undisturbed_ground_temperature_model_name` Undisturbed Ground Temperature Model Name required	reference		Names a Site:GroundTemperature:Undisturbed:FiniteDifference, Site:GroundTemperature:Undisturbed:KusudaAchenbach, Site:GroundTemperature:Undisturbed:Xing
`evapotranspiration_ground_cover_parameter` Evapotranspiration Ground Cover Parameter	number	`0.4`	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 Range: ≥ 0, ≤ 1.5
`slab_boundary_condition_model_name` Slab Boundary Condition Model Name required	reference		Names a SurfaceProperty:OtherSideConditionsModel
`slab_location` Slab Location required	choice		This field specifies whether the slab is located "in-grade" or "on-grade" One of `InGrade`, `OnGrade`
`slab_material_name` Slab Material Name	reference		Only applicable for the in-grade case Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`horizontal_insulation` Horizontal Insulation	choice	`No`	This field specifies the presence of insulation beneath the slab. Only required for in-grade case. One of `No`, `Yes`
`horizontal_insulation_material_name` Horizontal Insulation Material Name	reference		This field specifies the horizontal insulation material. Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`horizontal_insulation_extents` Horizontal Insulation Extents	choice	`Full`	This field specifies whether the horizontal insulation fully insulates the surface or is perimeter only insulation One of `Full`, `Perimeter`
`perimeter_insulation_width` Perimeter Insulation Width	number m		This field specifies the width of the underfloor perimeter insulation Range: > 0
`vertical_insulation` Vertical Insulation	choice	`No`	This field specifies the presence of vertical insulation at the slab edge. One of `No`, `Yes`
`vertical_insulation_material_name` Vertical Insulation Material Name	reference		This field specifies the vertical insulation material. Names a Material, Material:AirGap, Material:InfraredTransparent, Material:NoMass, Material:RoofVegetation, WindowMaterial:Blind, WindowMaterial:Gas, WindowMaterial:GasMixture, WindowMaterial:Glazing, WindowMaterial:Glazing:RefractionExtinctionMethod, WindowMaterial:GlazingGroup:Thermochromic, WindowMaterial:Screen and 2 more
`vertical_insulation_depth` Vertical Insulation Depth	number m		Only used when including vertical insulation This field specifies the depth of the vertical insulation Range: > 0
`simulation_timestep` Simulation Timestep	choice	`Hourly`	This field specifies the ground domain simulation timestep. One of `Hourly`, `Timestep`
`geometric_mesh_coefficient` Geometric Mesh Coefficient	number	`1.6`	Range: ≥ 1, ≤ 2
`mesh_density_parameter` Mesh Density Parameter	integer	`6`	Range: ≥ 4

Site:GroundReflectance¶

from idfpy.models import SiteGroundReflectance unique

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.

Field	Type	Default	Details
`january_ground_reflectance` January Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`february_ground_reflectance` February Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`march_ground_reflectance` March Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`april_ground_reflectance` April Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`may_ground_reflectance` May Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`june_ground_reflectance` June Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`july_ground_reflectance` July Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`august_ground_reflectance` August Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`september_ground_reflectance` September Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`october_ground_reflectance` October Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`november_ground_reflectance` November Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1
`december_ground_reflectance` December Ground Reflectance	number dimensionless	`0.2`	Range: ≥ 0, ≤ 1

Site:GroundReflectance:SnowModifier¶

from idfpy.models import SiteGroundReflectanceSnowModifier

Specifies ground reflectance multipliers when snow resident on the ground. These multipliers are applied to the "normal" ground reflectances specified in Site:GroundReflectance.

Field	Type	Default	Details
`ground_reflected_solar_modifier` Ground Reflected Solar Modifier	number	`1.0`	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 = (BeamSolarCosSunZenith + 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] Range: ≥ 0
`daylighting_ground_reflected_solar_modifier` Daylighting Ground Reflected Solar Modifier	number	`1.0`	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 = (BeamSolarCosSunZenith + 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] Range: ≥ 0

Site:GroundTemperature:BuildingSurface¶

from idfpy.models import SiteGroundTemperatureBuildingSurface unique

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.

Field	Type	Default
`january_ground_temperature` January Ground Temperature	number C	`18.0`
`february_ground_temperature` February Ground Temperature	number C	`18.0`
`march_ground_temperature` March Ground Temperature	number C	`18.0`
`april_ground_temperature` April Ground Temperature	number C	`18.0`
`may_ground_temperature` May Ground Temperature	number C	`18.0`
`june_ground_temperature` June Ground Temperature	number C	`18.0`
`july_ground_temperature` July Ground Temperature	number C	`18.0`
`august_ground_temperature` August Ground Temperature	number C	`18.0`
`september_ground_temperature` September Ground Temperature	number C	`18.0`
`october_ground_temperature` October Ground Temperature	number C	`18.0`
`november_ground_temperature` November Ground Temperature	number C	`18.0`
`december_ground_temperature` December Ground Temperature	number C	`18.0`

Site:GroundTemperature:Deep¶

from idfpy.models import SiteGroundTemperatureDeep unique

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.

Field	Type	Default
`january_deep_ground_temperature` January Deep Ground Temperature	number C	`16.0`
`february_deep_ground_temperature` February Deep Ground Temperature	number C	`16.0`
`march_deep_ground_temperature` March Deep Ground Temperature	number C	`16.0`
`april_deep_ground_temperature` April Deep Ground Temperature	number C	`16.0`
`may_deep_ground_temperature` May Deep Ground Temperature	number C	`16.0`
`june_deep_ground_temperature` June Deep Ground Temperature	number C	`16.0`
`july_deep_ground_temperature` July Deep Ground Temperature	number C	`16.0`
`august_deep_ground_temperature` August Deep Ground Temperature	number C	`16.0`
`september_deep_ground_temperature` September Deep Ground Temperature	number C	`16.0`
`october_deep_ground_temperature` October Deep Ground Temperature	number C	`16.0`
`november_deep_ground_temperature` November Deep Ground Temperature	number C	`16.0`
`december_deep_ground_temperature` December Deep Ground Temperature	number C	`16.0`

Site:GroundTemperature:FCfactorMethod¶

from idfpy.models import SiteGroundTemperatureFCfactorMethod unique

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.

Field	Type	Default
`january_ground_temperature` January Ground Temperature	number C	`13.0`
`february_ground_temperature` February Ground Temperature	number C	`13.0`
`march_ground_temperature` March Ground Temperature	number C	`13.0`
`april_ground_temperature` April Ground Temperature	number C	`13.0`
`may_ground_temperature` May Ground Temperature	number C	`13.0`
`june_ground_temperature` June Ground Temperature	number C	`13.0`
`july_ground_temperature` July Ground Temperature	number C	`13.0`
`august_ground_temperature` August Ground Temperature	number C	`13.0`
`september_ground_temperature` September Ground Temperature	number C	`13.0`
`october_ground_temperature` October Ground Temperature	number C	`13.0`
`november_ground_temperature` November Ground Temperature	number C	`13.0`
`december_ground_temperature` December Ground Temperature	number C	`13.0`

Site:GroundTemperature:Shallow¶

from idfpy.models import SiteGroundTemperatureShallow unique

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.

Field	Type	Default
`january_surface_ground_temperature` January Surface Ground Temperature	number C	`13.0`
`february_surface_ground_temperature` February Surface Ground Temperature	number C	`13.0`
`march_surface_ground_temperature` March Surface Ground Temperature	number C	`13.0`
`april_surface_ground_temperature` April Surface Ground Temperature	number C	`13.0`
`may_surface_ground_temperature` May Surface Ground Temperature	number C	`13.0`
`june_surface_ground_temperature` June Surface Ground Temperature	number C	`13.0`
`july_surface_ground_temperature` July Surface Ground Temperature	number C	`13.0`
`august_surface_ground_temperature` August Surface Ground Temperature	number C	`13.0`
`september_surface_ground_temperature` September Surface Ground Temperature	number C	`13.0`
`october_surface_ground_temperature` October Surface Ground Temperature	number C	`13.0`
`november_surface_ground_temperature` November Surface Ground Temperature	number C	`13.0`
`december_surface_ground_temperature` December Surface Ground Temperature	number C	`13.0`

Site:GroundTemperature:Undisturbed:FiniteDifference¶

from idfpy.models import SiteGroundTemperatureUndisturbedFiniteDifference

Undisturbed ground temperature object using a detailed finite difference 1-D model

Field	Type	Default	Details
`name` Name required	string
`soil_thermal_conductivity` Soil Thermal Conductivity required	number W/m-K		Range: > 0
`soil_density` Soil Density required	number kg/m3		Range: > 0
`soil_specific_heat` Soil Specific Heat required	number J/kg-K		Range: > 0
`soil_moisture_content_volume_fraction` Soil Moisture Content Volume Fraction	number percent	`30.0`	Range: ≥ 0, ≤ 100
`soil_moisture_content_volume_fraction_at_saturation` Soil Moisture Content Volume Fraction at Saturation	number percent	`50.0`	Range: ≥ 0, ≤ 100
`evapotranspiration_ground_cover_parameter` Evapotranspiration Ground Cover Parameter	number dimensionless	`0.4`	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 Range: ≥ 0, ≤ 1.5

Referenced by 7 object types

GroundHeatExchanger:HorizontalTrench, GroundHeatExchanger:Slinky, GroundHeatExchanger:System, Pipe:Underground, PipingSystem:Underground:Domain, Site:GroundDomain:Basement, Site:GroundDomain:Slab

Site:GroundTemperature:Undisturbed:KusudaAchenbach¶

from idfpy.models import SiteGroundTemperatureUndisturbedKusudaAchenbach

Undisturbed ground temperature object using the Kusuda-Achenbach 1965 correlation.

Field	Type	Details
`name` Name required	string
`soil_thermal_conductivity` Soil Thermal Conductivity required	number W/m-K	Range: > 0
`soil_density` Soil Density required	number kg/m3	Range: > 0
`soil_specific_heat` Soil Specific Heat required	number J/kg-K	Range: > 0
`average_soil_surface_temperature` Average Soil Surface Temperature	number C	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
`average_amplitude_of_surface_temperature` Average Amplitude of Surface Temperature	number deltaC	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 Range: ≥ 0
`phase_shift_of_minimum_surface_temperature` Phase Shift of Minimum Surface Temperature	number days	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 Range: ≥ 0, < 365

Referenced by 7 object types

GroundHeatExchanger:HorizontalTrench, GroundHeatExchanger:Slinky, GroundHeatExchanger:System, Pipe:Underground, PipingSystem:Underground:Domain, Site:GroundDomain:Basement, Site:GroundDomain:Slab

Site:GroundTemperature:Undisturbed:Xing¶

from idfpy.models import SiteGroundTemperatureUndisturbedXing

Undisturbed ground temperature object using the Xing 2014 2 harmonic parameter model.

Field	Type	Details
`name` Name required	string
`soil_thermal_conductivity` Soil Thermal Conductivity required	number W/m-K	Range: > 0
`soil_density` Soil Density required	number kg/m3	Range: > 0
`soil_specific_heat` Soil Specific Heat required	number J/kg-K	Range: > 0
`average_soil_surface_temperature` Average Soil Surface Temperature required	number C
`soil_surface_temperature_amplitude_1` Soil Surface Temperature Amplitude 1 required	number deltaC
`soil_surface_temperature_amplitude_2` Soil Surface Temperature Amplitude 2 required	number deltaC
`phase_shift_of_temperature_amplitude_1` Phase Shift of Temperature Amplitude 1 required	number days	Range: < 365
`phase_shift_of_temperature_amplitude_2` Phase Shift of Temperature Amplitude 2 required	number days	Range: < 365

Referenced by 7 object types

GroundHeatExchanger:HorizontalTrench, GroundHeatExchanger:Slinky, GroundHeatExchanger:System, Pipe:Underground, PipingSystem:Underground:Domain, Site:GroundDomain:Basement, Site:GroundDomain:Slab

Site:HeightVariation¶

from idfpy.models import SiteHeightVariation unique

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.

Field	Type	Default	Details
`wind_speed_profile_exponent` Wind Speed Profile Exponent	number	`0.22`	Set to zero for no wind speed dependence on height. Range: ≥ 0
`wind_speed_profile_boundary_layer_thickness` Wind Speed Profile Boundary Layer Thickness	number m	`370.0`	Range: > 0
`air_temperature_gradient_coefficient` Air Temperature Gradient Coefficient	number K/m	`0.0065`	Set to zero for no air temperature dependence on height. Range: ≥ 0

Site:Location¶

from idfpy.models import SiteLocation unique

Specifies the building's location. Only one location is allowed. Weather data file location, if it exists, will override this object.

Field	Type	Default	Details
`name` Name required	string
`latitude` Latitude	number deg	`0.0`	+ is North, - is South, degree minutes represented in decimal (i.e. 30 minutes is .5) Range: ≥ -90, ≤ 90
`longitude` Longitude	number deg	`0.0`	- is West, + is East, degree minutes represented in decimal (i.e. 30 minutes is .5) Range: ≥ -180, ≤ 180
`time_zone` Time Zone	number hr	`0.0`	basic these limits on the WorldTimeZone Map (2003) Time relative to GMT. Decimal hours. Range: ≥ -12, ≤ 14
`elevation` Elevation	number m	`0.0`	Range: ≥ -300, < 8900
`keep_site_location_information` Keep Site Location Information	choice	`No`	One of `No`, `Yes`

Site:Precipitation¶

from idfpy.models import SitePrecipitation

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

Field	Type	Details
`precipitation_model_type` Precipitation Model Type	choice	One of `ScheduleAndDesignLevel`
`design_level_for_total_annual_precipitation` Design Level for Total Annual Precipitation	number m/yr	meters of water per year used for design level
`precipitation_rates_schedule_name` Precipitation Rates Schedule Name	reference	Schedule values in meters of water per hour values should be non-negative Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`average_total_annual_precipitation` Average Total Annual Precipitation	number m/yr	meters of water per year from average weather statistics Range: ≥ 0

Site:SolarAndVisibleSpectrum¶

from idfpy.models import SiteSolarAndVisibleSpectrum unique

If this object is omitted, the default solar and visible spectrum data will be used.

Field	Type	Default	Details
`name` Name required	string
`spectrum_data_method` Spectrum Data Method	choice	`Default`	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 One of `Default`, `UserDefined`
`solar_spectrum_data_object_name` Solar Spectrum Data Object Name	reference		Names a Site:SpectrumData
`visible_spectrum_data_object_name` Visible Spectrum Data Object Name	reference		Names a Site:SpectrumData

Site:SpectrumData¶

from idfpy.models import SiteSpectrumData extensible

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)

Field	Type	Details
`name` Name required	string
`spectrum_data_type` Spectrum Data Type required	choice	One of `Solar`, `Visible`
`wavelength` Wavelength	number micron
`spectrum` Spectrum	number
`wavelength_1` Wavelength	number micron
`spectrum_2` Spectrum	number
`extensions`	list	Each item: `wavelength` (micron), `spectrum`

Referenced by 1 object types

Site:SolarAndVisibleSpectrum

Site:VariableLocation¶

from idfpy.models import SiteVariableLocation unique

Captures the scheduling of a moving/reorienting building, or more likely a vessel

Field	Type	Details
`name` Name required	string
`building_location_latitude_schedule` Building Location Latitude Schedule	reference	The name of a schedule that defines the latitude of the building at any time. If not entered, the latitude defined in the Site:Location, or the default latitude, will be used for the entirety of the simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`building_location_longitude_schedule` Building Location Longitude Schedule	reference	The name of a schedule that defines the longitude of the building at any time. If not entered, the longitude defined in the Site:Location, or the default longitude, will be used for the entirety of the simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`building_location_orientation_schedule` Building Location Orientation Schedule	reference	The name of a schedule that defines the orientation of the building at any time. This orientation is based on a change from the original orientation. -- NEED TO REFINE THIS If not entered, the original orientation will be used for the entirety of the simulation Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules

Site:WaterMainsTemperature¶

from idfpy.models import SiteWaterMainsTemperature

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.

Field	Type	Default	Details
`calculation_method` Calculation Method	choice	`CorrelationFromWeatherFile`	If calculation method is CorrelationFromWeatherFile, the two numeric input fields are ignored. Instead, EnergyPlus calculates them from weather file. One of `Correlation`, `CorrelationFromWeatherFile`, `Schedule`
`temperature_schedule_name` Temperature Schedule Name	reference		Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:File, Schedule:Year, Schedule:Year:Rules
`annual_average_outdoor_air_temperature` Annual Average Outdoor Air Temperature	number C		If calculation method is CorrelationFromWeatherFile or Schedule, this input field is ignored.
`maximum_difference_in_monthly_average_outdoor_air_temperatures` Maximum Difference In Monthly Average Outdoor Air Temperatures	number deltaC		If calculation method is CorrelationFromWeatherFile or Schedule, this input field is ignored. Range: ≥ 0
`temperature_multiplier` Temperature Multiplier	number dimensionless	`1.0`	If calculation method is Schedule, this input field is ignored. Range: ≥ 0
`temperature_offset` Temperature Offset	number deltaC	`0.0`	If calculation method is Schedule, this input field is ignored.

Site:WeatherStation¶

from idfpy.models import SiteWeatherStation unique

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.

Field	Type	Default	Details
`wind_sensor_height_above_ground` Wind Sensor Height Above Ground	number m	`10.0`	Range: > 0
`wind_speed_profile_exponent` Wind Speed Profile Exponent	number	`0.14`	Range: ≥ 0
`wind_speed_profile_boundary_layer_thickness` Wind Speed Profile Boundary Layer Thickness	number m	`270.0`	Range: ≥ 0
`air_temperature_sensor_height_above_ground` Air Temperature Sensor Height Above Ground	number m	`1.5`	Range: ≥ 0

SizingPeriod:DesignDay¶

from idfpy.models import SizingPeriodDesignDay

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.

Field	Type	Default	Details
`name` Name required	string
`month` Month required	integer		Range: ≥ 1, ≤ 12
`day_of_month` Day of Month required	integer		must be valid for Month field Range: ≥ 1, ≤ 31
`day_type` Day Type required	choice		Day Type selects the schedules appropriate for this design day One of `CustomDay1`, `CustomDay2`, `Friday`, `Holiday`, `Monday`, `Saturday`, `SummerDesignDay`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`, `WinterDesignDay`
`maximum_dry_bulb_temperature` Maximum Dry-Bulb Temperature	number C		This field is required when field "Dry-Bulb Temperature Range Modifier Type" is not "TemperatureProfileSchedule". Range: ≥ -90, ≤ 70
`daily_dry_bulb_temperature_range` Daily Dry-Bulb Temperature Range	number deltaC	`0.0`	Must still produce appropriate maximum dry-bulb (within range) This field is not needed if Dry-Bulb Temperature Range Modifier Type is "delta". Range: ≥ 0
`dry_bulb_temperature_range_modifier_type` Dry-Bulb Temperature Range Modifier Type	choice	`DefaultMultipliers`	Type of modifier to the dry-bulb temperature calculated for the timestep One of `DefaultMultipliers`, `DifferenceSchedule`, `MultiplierSchedule`, `TemperatureProfileSchedule`
`dry_bulb_temperature_range_modifier_day_schedule_name` Dry-Bulb Temperature Range Modifier Day Schedule Name	reference		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. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`humidity_condition_type` Humidity Condition Type	choice	`WetBulb`	values/schedules indicated here and in subsequent fields create the humidity values in the 24 hour design day conditions profile. One of `DewPoint`, `Enthalpy`, `HumidityRatio`, `RelativeHumiditySchedule`, `WetBulb`, `WetBulbProfileDefaultMultipliers`, `WetBulbProfileDifferenceSchedule`, `WetBulbProfileMultiplierSchedule`
`wetbulb_or_dewpoint_at_maximum_dry_bulb` Wetbulb or DewPoint at Maximum Dry-Bulb	number C		Wetbulb or dewpoint temperature coincident with the maximum temperature. Required only if field Humidity Condition Type is "Wetbulb", "Dewpoint", "WetBulbProfileMultiplierSchedule", "WetBulbProfileDifferenceSchedule", or "WetBulbProfileDefaultMultipliers"
`humidity_condition_day_schedule_name` Humidity Condition Day Schedule Name	reference		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) Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`humidity_ratio_at_maximum_dry_bulb` Humidity Ratio at Maximum Dry-Bulb	number kgWater/kgDryAir		Humidity ratio coincident with the maximum temperature (constant humidity ratio throughout day). Required only if field Humidity Condition Type is "HumidityRatio".
`enthalpy_at_maximum_dry_bulb` Enthalpy at Maximum Dry-Bulb	number J/kg		Enthalpy coincident with the maximum temperature. Required only if field Humidity Condition Type is "Enthalpy".
`daily_wet_bulb_temperature_range` Daily Wet-Bulb Temperature Range	number deltaC		Required only if Humidity Condition Type = "WetbulbProfileMultiplierSchedule" or "WetBulbProfileDefaultMultipliers"
`barometric_pressure` Barometric Pressure	number Pa		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. Range: ≥ 31000, ≤ 120000
`wind_speed` Wind Speed required	number m/s		Range: ≥ 0, ≤ 40
`wind_direction` Wind Direction required	number deg		North=0.0 East=90.0 0 and 360 are the same direction. Range: ≥ 0, ≤ 360
`rain_indicator` Rain Indicator	choice	`No`	Yes is raining (all day), No is not raining One of `No`, `Yes`
`snow_indicator` Snow Indicator	choice	`No`	Yes is Snow on Ground, No is no Snow on Ground One of `No`, `Yes`
`daylight_saving_time_indicator` Daylight Saving Time Indicator	choice	`No`	Yes -- use schedules modified for Daylight Saving Time Schedules. No - do not use schedules modified for Daylight Saving Time Schedules One of `No`, `Yes`
`solar_model_indicator` Solar Model Indicator	choice	`ASHRAEClearSky`	One of `ASHRAEClearSky`, `ASHRAETau`, `ASHRAETau2017`, `Schedule`, `ZhangHuang`
`beam_solar_day_schedule_name` Beam Solar Day Schedule Name	reference		if Solar Model Indicator = Schedule, then beam schedule name (for day) Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`diffuse_solar_day_schedule_name` Diffuse Solar Day Schedule Name	reference		if Solar Model Indicator = Schedule, then diffuse schedule name (for day) Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`ashrae_clear_sky_optical_depth_for_beam_irradiance_taub` ASHRAE Clear Sky Optical Depth for Beam Irradiance (taub)	number dimensionless	`0.0`	Required if Solar Model Indicator = ASHRAETau or ASHRAETau2017 ASHRAETau2017 solar model can be used with 2013 and 2017 HOF matching taub Range: ≥ 0, ≤ 1.2
`ashrae_clear_sky_optical_depth_for_diffuse_irradiance_taud` ASHRAE Clear Sky Optical Depth for Diffuse Irradiance (taud)	number dimensionless	`0.0`	Required if Solar Model Indicator = ASHRAETau or ASHRAETau2017 ASHRAETau2017 solar model can be used with 2013 and 2017 HOF matching taud Range: ≥ 0, ≤ 3
`sky_clearness` Sky Clearness	number	`0.0`	Used if Sky Model Indicator = ASHRAEClearSky or ZhangHuang 0.0 is totally unclear, 1.0 is totally clear Range: ≥ 0, ≤ 1.2
`maximum_number_warmup_days` Maximum Number Warmup Days	integer		If used this design day will be run with a custom limit on the maximum number of days that are repeated for warmup. Limiting the number of warmup days can improve run time.
`begin_environment_reset_mode` Begin Environment Reset Mode	choice	`FullResetAtBeginEnvironment`	If used this can control if you want the thermal history to be reset at the beginning of the design day. When using a series of similar design days, this field can be used to retain warmup state from the previous design day. One of `FullResetAtBeginEnvironment`, `SuppressAllBeginEnvironmentResets`

Referenced by 1 object types

WeatherProperty:SkyTemperature

SizingPeriod:WeatherFileConditionType¶

from idfpy.models import SizingPeriodWeatherFileConditionType

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.

Field	Type	Default	Details
`name` Name required	string		user supplied name for reporting
`period_selection` Period Selection required	choice		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. One of `AutumnTypical`, `DrySeason`, `NoDrySeason`, `NoDrySeasonMax`, `NoDrySeasonMin`, `NoWetSeason`, `NoWetSeasonMax`, `NoWetSeasonMin`, `SpringTypical`, `SummerExtreme`, `SummerTypical`, `TropicalCold`, `TropicalHot`, `WetSeason`, `WinterExtreme`, `WinterTypical`
`day_of_week_for_start_day` Day of Week for Start Day	choice	`Monday`	=[\|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 One of `CustomDay1`, `CustomDay2`, `Friday`, `Monday`, `Saturday`, `SummerDesignDay`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`, `WinterDesignDay`
`use_weather_file_daylight_saving_period` Use Weather File Daylight Saving Period	choice	`Yes`	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. One of `No`, `Yes`
`use_weather_file_rain_and_snow_indicators` Use Weather File Rain and Snow Indicators	choice	`Yes`	One of `No`, `Yes`

Referenced by 1 object types

WeatherProperty:SkyTemperature

SizingPeriod:WeatherFileDays¶

from idfpy.models import SizingPeriodWeatherFileDays

Use a weather file period for design sizing calculations.

Field	Type	Default	Details
`name` Name required	string		user supplied name for reporting
`begin_month` Begin Month required	integer		Range: ≥ 1, ≤ 12
`begin_day_of_month` Begin Day of Month required	integer		Range: ≥ 1, ≤ 31
`end_month` End Month required	integer		Range: ≥ 1, ≤ 12
`end_day_of_month` End Day of Month required	integer		Range: ≥ 1, ≤ 31
`day_of_week_for_start_day` Day of Week for Start Day	choice	`Monday`	=[\|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 One of `CustomDay1`, `CustomDay2`, `Friday`, `Monday`, `Saturday`, `SummerDesignDay`, `Sunday`, `Thursday`, `Tuesday`, `Wednesday`, `WinterDesignDay`
`use_weather_file_daylight_saving_period` Use Weather File Daylight Saving Period	choice	`Yes`	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. One of `No`, `Yes`
`use_weather_file_rain_and_snow_indicators` Use Weather File Rain and Snow Indicators	choice	`Yes`	One of `No`, `Yes`

Referenced by 2 object types

GroundHeatExchanger:Vertical:Sizing:Rectangle, WeatherProperty:SkyTemperature

WeatherProperty:SkyTemperature¶

from idfpy.models import WeatherPropertySkyTemperature

This object is used to override internal sky temperature calculations.

Field	Type	Default	Details
`name` Name	reference		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. Names a RunPeriod, SizingPeriod:DesignDay, SizingPeriod:WeatherFileConditionType, SizingPeriod:WeatherFileDays
`calculation_type` Calculation Type	choice	`ClarkAllen`	The field indicates that the sky temperature will be imported from external schedules or calculated by alternative methods other than default. One of `BerdahlMartin`, `Brunt`, `ClarkAllen`, `DifferenceScheduleDewPointValue`, `DifferenceScheduleDryBulbValue`, `Idso`, `ScheduleValue`
`schedule_name` Schedule Name	reference		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. Required if Calculation Type is ScheduleValue, DifferenceScheduleDryBulbValue or DifferenceScheduleDewPointValue. Names a ExternalInterface:FunctionalMockupUnitExport:To:Schedule, ExternalInterface:FunctionalMockupUnitImport:To:Schedule, ExternalInterface:Schedule, Schedule:Compact, Schedule:Constant, Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List, Schedule:File, Schedule:Year, Schedule:Year:Rules
`use_weather_file_horizontal_ir` Use Weather File Horizontal IR	choice	`Yes`	If yes or blank, use Horizontal IR values from weather file when present, otherwise use the specified sky model. If no, always use the specified sky model and ignore the horizontal IR values from the weather file. For Calculation Type = ScheduleValue, DifferenceScheduleDryBulbValue or DifferenceScheduleDewPointValue, this field is ignored and the scheduled values are used. One of `No`, `Yes`