HB-Energy Primer
Ladybug Tools for Grasshopper Documentation
  • HB-Energy Primer
  • Components
    • 0 :: Basic Properties
      • Building Vintages
      • Climate Zones
      • Face Energy Attributes
      • Room Energy Attributes
      • Blend ProgramTypes
      • Building Programs
      • ProgramType
      • Search Programs
      • ConstructionSet
      • Construction Set by Climate
      • Construction Types
      • Search Construction Sets
      • Exterior Construction Subset
      • Ground Construction Subset
      • Interior Construction Subset
      • Subface Subset
      • Adiabatic by Type
      • Plenum
      • Ground
      • Internal Mass
      • Other Side Temperature
      • Patch Missing Adjacency
    • 1 :: Constructions
      • Search Constructions
      • Search Materials
      • Deconstruct Construction
      • Deconstruct ConstructionSet
      • Deconstruct ConstructionSet Interior
      • Deconstruct Material
      • Apply ConstructionSet
      • Apply Opaque Construction
      • Apply Shade Construction
      • Apply Window Construction
      • Opaque Construction
      • Shade Construction
      • Window Construction
      • Window Construction Shade
      • Opaque Material
      • Opaque Material No Mass
      • Glass Material
      • Shade Material
      • Window Frame
      • Window Material
      • Blind Material
      • Custom Window Gap Material
      • Vegetation Material
      • Window Construction Dynamic
      • Window Gap Material
    • 2 :: Schedules
      • Gene Pool to Day Schedule
      • Search Schedules
      • Deconstruct Schedule
      • Schedule to Data
      • Apply Room Schedules
      • Apply Shade Schedule
      • Constant Schedule
      • Fixed Interval Schedule
      • Seasonal Schedule
      • Weekly Schedule
      • Type Limit
    • 3 :: Loads
      • Apply ProgramType
      • Deconstruct ProgramType
      • Apply Absolute Load Values
      • Apply Daylight Control
      • Apply Load Values
      • Apply Setpoint Values
      • Equipment
      • Infiltration
      • Lighting
      • People
      • Process Load
      • Service Hot Water
      • Setpoint
      • Ventilation
      • Airflow Newtwork
      • Fan Ventilation
      • Ventilation Control
      • Window Opening
      • Blower Pressure Converter
      • Deconstruct Equipment
      • Deconstruct Hot Water
      • Deconstruct Infiltration
      • Deconstruct Lighting
      • Deconstruct People
      • Deconstruct Setpoint
      • Deconstruct Ventilation
    • 4 :: HVAC
      • IdealAir
      • Set Conditioned
      • All-Air HVAC
      • All-Air HVAC Templates
      • DOAS HVAC
      • DOAS HVAC Templates
      • HeatCool HVAC
      • HeatCool HVAC Templates
      • SHW System
      • SHW Templates
      • Electric Load Center
      • Photovoltaic Properties
      • Detailed HVAC
      • Radiant HVAC Properties
    • 5 :: Simulate
      • Model to OSM
      • Annual Loads
      • Generation Loads
      • Load Shade Benefit
      • Peak Loads
      • Custom Simulation Output
      • Shadow Calculation
      • Simulation Control
      • Simulation Output
      • Simulation Parameter
      • Sizing Parameter
      • Load Measure
      • Run OSW
      • Run IDF
      • Run OSM
      • Create OSM Measure
    • 6 :: Result
      • End Use Intensity
      • Read Custom Result
      • Read Face Result
      • Read HVAC Sizing
      • Read Room Comfort Result
      • Read Room Energy Result
      • Color Faces
      • Color Rooms
      • Read Tabular Data
      • Thermal Load Balance
      • Balance Temperature
      • Carbon Emission Intensity
      • Face Result by Type
      • Normalize by Floor Area
      • Read Generation Result
      • Read Result Dictionary
      • Read Zone Sizing
    • 7 :: Thermal Map
      • Adaptive Comfort Map
      • PMV Comfort Map
      • UTCI Comfort Map
      • Read Thermal Matrix
      • Visualize Thermal Map
      • Read Environment Matrix
Powered by GitBook
On this page
  • Inputs
  • Outputs
Export as PDF
  1. Components
  2. 2 :: Schedules

Schedule to Data

PreviousDeconstruct ScheduleNextApply Room Schedules

Last updated 3 years ago

-

Get a ladybug DataCollection representing this schedule at a given timestep.

This DataCollection can be used to visualize timeseries schedule values over the entire period of a simulation using a component like the "LB Hourly Plot".

This DataCollection can also be used in the crafting of conditional statements with the ladybug components. For example, making a psychrometric chart of zone temperature/humidity for only the hours that the occupancy schedule is above a certain threshold.

Inputs

  • schedule [Required]

    A ScheduleRuleSet or SchedileFixedInterval for which a DataCollection of timeseries schedule values will be produced. This can also be the identifier of a Schedule to be looked up in the schedule library.

  • analysis_period

    An optional AnalysisPeriod to set the start and end datetimes of the resulting DataCollection. The timestep of this AnalysisPeriod will also be used to determine the timestep of the resulting DataCollection.

  • week_start_day

    An optional text string to set the start day of the week of the schedule timeseries data. Default: Sunday. Choose from the following:

    • Sunday

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

  • holidays

    An optional list of strings (eq: 25 Dec) to represent the holidays in the resulting timeseries. Holiday schedules will be used for these dates in the resulting timeseries.

Outputs

  • data

    A ladybug DataCollection representing the timeseries values of the schedule. This can be used to visualize timeseries schedule values over the entire period of a simulation using a component like the "LB Hourly Plot".

[source code]