Schedules¶

13 object types from idfpy.models.schedules · EnergyPlus 26.2

Object	Summary
Schedule:Compact	Irregular object.
Schedule:Constant	Constant hourly value for entire year.
Schedule:Day:Hourly	A Schedule:Day:Hourly contains 24 values for each hour of the day.
Schedule:Day:Interval	A Schedule:Day:Interval contains a full day of values with specified end times for each value Currently, is …
Schedule:Day:List	Schedule:Day:List will allow the user to list 24 hours worth of values, which can be sub-hourly in nature.
Schedule:File	A Schedule:File points to a text computer file that has 8760-8784 hours of data.
Schedule:File:Shading	A Schedule:File:Shading points to a CSV file that has 8760-8784 hours of sunlit fraction data for all or some …
Schedule:Week:Compact	Compact definition for Schedule:Day:List
Schedule:Week:Daily	A Schedule:Week:Daily contains 12 Schedule:Day:Hourly objects, one for each day type.
Schedule:Week:Rule	A Schedule:Week:Rule defines one override rule for a Schedule:Year:Rules.
Schedule:Year	A Schedule:Year contains from 1 to 52 week schedules
Schedule:Year:Rules	A Schedule:Year:Rules defines a yearly schedule using a default day profile and a prioritized list of …
ScheduleTypeLimits	ScheduleTypeLimits specifies the data types and limits for the values contained in schedules

Schedule:Compact¶

from idfpy.models import ScheduleCompact extensible

Irregular object. Does not follow the usual definition for fields. Fields A3... are: Through: Date For: Applicable days (ref: Schedule:Week:Compact) Interpolate: Average/Linear/No (ref: Schedule:Day:Interval) -- optional, if not used will be "No" Until: <Time> (ref: Schedule:Day:Interval) <numeric value> words "Through","For","Interpolate","Until" must be included.

Field	Type	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference	Names a ScheduleTypeLimits
`data`	list	Each item: `field`

Referenced by 350 object types

Schedule:Constant¶

from idfpy.models import ScheduleConstant

Constant hourly value for entire year.

Field	Type	Default	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference		Names a ScheduleTypeLimits
`hourly_value` Hourly Value	number	`0.0`

Referenced by 350 object types

Schedule:Day:Hourly¶

from idfpy.models import ScheduleDayHourly

A Schedule:Day:Hourly contains 24 values for each hour of the day.

Field	Type	Default	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference		Names a ScheduleTypeLimits
`hour_1` Hour 1	number	`0.0`
`hour_2` Hour 2	number	`0.0`
`hour_3` Hour 3	number	`0.0`
`hour_4` Hour 4	number	`0.0`
`hour_5` Hour 5	number	`0.0`
`hour_6` Hour 6	number	`0.0`
`hour_7` Hour 7	number	`0.0`
`hour_8` Hour 8	number	`0.0`
`hour_9` Hour 9	number	`0.0`
`hour_10` Hour 10	number	`0.0`
`hour_11` Hour 11	number	`0.0`
`hour_12` Hour 12	number	`0.0`
`hour_13` Hour 13	number	`0.0`
`hour_14` Hour 14	number	`0.0`
`hour_15` Hour 15	number	`0.0`
`hour_16` Hour 16	number	`0.0`
`hour_17` Hour 17	number	`0.0`
`hour_18` Hour 18	number	`0.0`
`hour_19` Hour 19	number	`0.0`
`hour_20` Hour 20	number	`0.0`
`hour_21` Hour 21	number	`0.0`
`hour_22` Hour 22	number	`0.0`
`hour_23` Hour 23	number	`0.0`
`hour_24` Hour 24	number	`0.0`

Referenced by 6 object types

Schedule:Week:Compact, Schedule:Week:Daily, Schedule:Week:Rule, Schedule:Year:Rules, SizingPeriod:DesignDay, WeatherProperty:SkyTemperature

Schedule:Day:Interval¶

from idfpy.models import ScheduleDayInterval extensible

A Schedule:Day:Interval contains a full day of values with specified end times for each value Currently, is set up to allow for 10 minute intervals for an entire day.

Field	Type	Default	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference		Names a ScheduleTypeLimits
`interpolate_to_timestep` Interpolate to Timestep	choice	`No`	when the interval does not match the user specified timestep a Average choice will average between the intervals request (to timestep resolution. A No choice will use the interval value at the simulation timestep without regard to if it matches the boundary or not. A Linear choice will interpolate linearly between successive values. One of `Average`, `Linear`, `No`
`data`	list		Each item: `time` (hh:mm), `value_until_time`

Referenced by 6 object types

Schedule:Week:Compact, Schedule:Week:Daily, Schedule:Week:Rule, Schedule:Year:Rules, SizingPeriod:DesignDay, WeatherProperty:SkyTemperature

Schedule:Day:List¶

from idfpy.models import ScheduleDayList extensible

Schedule:Day:List will allow the user to list 24 hours worth of values, which can be sub-hourly in nature.

Field	Type	Default	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference		Names a ScheduleTypeLimits
`interpolate_to_timestep` Interpolate to Timestep	choice	`No`	when the interval does not match the user specified timestep a "Average" choice will average between the intervals request (to timestep resolution. A "No" choice will use the interval value at the simulation timestep without regard to if it matches the boundary or not. A "Linear" choice will interpolate linearly between successive values. One of `Average`, `Linear`, `No`
`minutes_per_item` Minutes per Item	integer		Must be evenly divisible into 60 Range: ≥ 1, ≤ 60
`extensions`	list		Each item: `value`

Referenced by 6 object types

Schedule:Week:Compact, Schedule:Week:Daily, Schedule:Week:Rule, Schedule:Year:Rules, SizingPeriod:DesignDay, WeatherProperty:SkyTemperature

Schedule:File¶

from idfpy.models import ScheduleFile

A Schedule:File points to a text computer file that has 8760-8784 hours of data.

Field	Type	Default	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference		Names a ScheduleTypeLimits
`file_name` File Name required	string
`column_number` Column Number required	integer		Range: ≥ 1
`rows_to_skip_at_top` Rows to Skip at Top required	integer		Range: ≥ 0
`number_of_hours_of_data` Number of Hours of Data	number	`8760.0`	8760 hours does not account for leap years, 8784 does. should be either 8760 or 8784 Range: ≥ 8760, ≤ 8784
`column_separator` Column Separator	choice	`Comma`	One of `Comma`, `Semicolon`, `Space`, `Tab`
`interpolate_to_timestep` Interpolate to Timestep	choice	`No`	when the interval does not match the user specified timestep a "Yes" choice will average between the intervals request (to timestep resolution. a "No" choice will use the interval value at the simulation timestep without regard to if it matches the boundary or not. One of `No`, `Yes`
`minutes_per_item` Minutes per Item	integer	`60`	Must be evenly divisible into 60 Range: ≥ 1, ≤ 60
`adjust_schedule_for_daylight_savings` Adjust Schedule for Daylight Savings	choice	`Yes`	"No" means do not include Daylight Savings Time in the schedule, instead, use the schedule directly from the Schedule:File csv (default) "Yes" means include Daylight Savings Time to the schedule One of `No`, `Yes`

Referenced by 350 object types

Schedule:File:Shading¶

from idfpy.models import ScheduleFileShading unique

A Schedule:File:Shading points to a CSV file that has 8760-8784 hours of sunlit fraction data for all or some of the exterior surfaces.

Field	Type	Default	Details
`file_name` File Name required	string		The name of the file that writes all shading data.

Schedule:Week:Compact¶

from idfpy.models import ScheduleWeekCompact extensible

Compact definition for Schedule:Day:List

Field	Type	Default	Details
`name` Name required	string
`data`	list		Each item: `daytype_list`, `schedule_day_name`

Referenced by 1 object types

Schedule:Year

Schedule:Week:Daily¶

from idfpy.models import ScheduleWeekDaily

A Schedule:Week:Daily contains 12 Schedule:Day:Hourly objects, one for each day type.

Field	Type	Details
`name` Name required	string
`sunday_schedule_day_name` Sunday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`monday_schedule_day_name` Monday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`tuesday_schedule_day_name` Tuesday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`wednesday_schedule_day_name` Wednesday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`thursday_schedule_day_name` Thursday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`friday_schedule_day_name` Friday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`saturday_schedule_day_name` Saturday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`holiday_schedule_day_name` Holiday Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`summerdesignday_schedule_day_name` SummerDesignDay Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`winterdesignday_schedule_day_name` WinterDesignDay Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`customday1_schedule_day_name` CustomDay1 Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`customday2_schedule_day_name` CustomDay2 Schedule:Day Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List

Referenced by 1 object types

Schedule:Year

Schedule:Week:Rule¶

from idfpy.models import ScheduleWeekRule extensible

A Schedule:Week:Rule defines one override rule for a Schedule:Year:Rules. Rules are evaluated in ascending Rule Priority Order; the first matching rule wins. A rule matches a day if: (a) the day falls within the specified date ranges, AND (b) the corresponding Apply <DayOfWeek> field is Yes.

Field	Type	Default	Details
`name` Name required	string
`schedule_year_rules_name` Schedule Year Rules Name required	reference		Names a Schedule:Year:Rules
`rule_priority_order` Rule Priority Order required	integer		Lower values have higher priority. Must be unique within a Schedule:Year:Rules. Range: ≥ 0
`day_schedule_name` Day Schedule Name required	reference		Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`apply_sunday` Apply Sunday	choice	`No`	One of `No`, `Yes`
`apply_monday` Apply Monday	choice	`No`	One of `No`, `Yes`
`apply_tuesday` Apply Tuesday	choice	`No`	One of `No`, `Yes`
`apply_wednesday` Apply Wednesday	choice	`No`	One of `No`, `Yes`
`apply_thursday` Apply Thursday	choice	`No`	One of `No`, `Yes`
`apply_friday` Apply Friday	choice	`No`	One of `No`, `Yes`
`apply_saturday` Apply Saturday	choice	`No`	One of `No`, `Yes`
`date_ranges`	list		Each item: `start_month`, `start_day`, `end_month`, `end_day`

Schedule:Year¶

from idfpy.models import ScheduleYear extensible

A Schedule:Year contains from 1 to 52 week schedules

Field	Type	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference	Names a ScheduleTypeLimits
`schedule_weeks`	list	Each item: `schedule_week_name`, `start_month`, `start_day`, `end_month`, `end_day`

Referenced by 350 object types

Schedule:Year:Rules¶

from idfpy.models import ScheduleYearRules

A Schedule:Year:Rules defines a yearly schedule using a default day profile and a prioritized list of override rules (Schedule:Week:Rule objects). Rules are evaluated in ascending Rule Priority Order; the first matching rule for a given day is used. If no rule matches, the Default Day Schedule is used. Exception: if no rule date range includes February 29, February 29 inherits February 28.

Field	Type	Details
`name` Name required	string
`schedule_type_limits_name` Schedule Type Limits Name	reference	Names a ScheduleTypeLimits
`default_day_schedule_name` Default Day Schedule Name required	reference	Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`summer_design_day_schedule_name` Summer Design Day Schedule Name	reference	If blank, the Default Day Schedule is used for Summer Design Days. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`winter_design_day_schedule_name` Winter Design Day Schedule Name	reference	If blank, the Default Day Schedule is used for Winter Design Days. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`holiday_schedule_name` Holiday Schedule Name	reference	If blank, the Default Day Schedule is used for Holidays. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`custom_day_1_schedule_name` Custom Day 1 Schedule Name	reference	If blank, the Default Day Schedule is used for Custom Day 1. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List
`custom_day_2_schedule_name` Custom Day 2 Schedule Name	reference	If blank, the Default Day Schedule is used for Custom Day 2. Names a Schedule:Day:Hourly, Schedule:Day:Interval, Schedule:Day:List

Referenced by 351 object types

ScheduleTypeLimits¶

from idfpy.models import ScheduleTypeLimits

ScheduleTypeLimits specifies the data types and limits for the values contained in schedules

Field	Type	Default	Details
`name` Name required	string		used to validate schedule types in various schedule objects
`lower_limit_value` Lower Limit Value	number		lower limit (real or integer) for the Schedule Type. e.g. if fraction, this is 0.0
`upper_limit_value` Upper Limit Value	number		upper limit (real or integer) for the Schedule Type. e.g. if fraction, this is 1.0
`numeric_type` Numeric Type	choice		Numeric type is either Continuous (all numbers within the min and max are valid or Discrete (only integer numbers between min and max are valid. (Could also allow REAL and INTEGER to mean the same things) One of `Continuous`, `Discrete`
`unit_type` Unit Type	choice	`Dimensionless`	Temperature (C or F) DeltaTemperature (C or F) PrecipitationRate (m/hr or ft/hr) Angle (degrees) Convection Coefficient (W/m2-K or Btu/sqft-hr-F) Activity Level (W/person) Velocity (m/s or ft/min) Capacity (W or Btu/h) Power (W) One of `ActivityLevel`, `Angle`, `Availability`, `Capacity`, `Control`, `ConvectionCoefficient`, `DeltaTemperature`, `Dimensionless`, `Mode`, `Percent`, `Power`, `PrecipitationRate`, `Temperature`, `Velocity`

Referenced by 11 object types

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