Deconstruct Schedule

Deconstruct a ScheduleRuleset into an array of day-long ladybug DataCollections representing each unique ScheduleDay that defines the ScheduleRuleset.

These DataCollections can be used to make visualizations of timeseries schedule values over each unique day of the schedule using a component like the "LB Line Chart".

Inputs

  • schedule [Required]

    A ScheduleRuleSet to be deconstructed into DataCollections of timeseries schedule values for each unique day. This can also be the identifier of a Schedule to be looked up in the schedule library.

  • timestep

    An integer for the number of steps per hour at which to make the resulting daily DataCollections.

Outputs

  • day_names

    A list of display names for each unique ScheduleDay that defines the input ScheduleRuleset.

  • day_data

    A list of day-long ladybug DataCollections representing each unique ScheduleDay that defines the ScheduleRuleset. These can be used to make visualizations of timeseries schedule values over each day of the schedule using a component like the "LB Line Chart".

  • type_limit

    The ScheduleTypeLimit object assigned to the ScheduleRuleset.

Last updated