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. 5 :: Simulate

Custom Simulation Output

PreviousPeak LoadsNextShadow Calculation

Last updated 1 year ago

-

Create a custom simulation output object by plugging in one or more names of EnergyPlus simulation ouputs. The resulting object can be used to request output variables from EnergyPlus.

Inputs

  • base_sim_output

An optional simulation output object to serve as the starting point for the sim_output object returned by this component. All of the output names will simply be appended to this initial starting object.

  • output_names

A list of EnergyPlus output names as strings (eg. 'Surface Window System Solar Transmittance'. These outputs will be requested from the simulation.

  • report_frequency

Text for the frequency at which the outputs are reported. Default: 'Hourly'. Choose from the following:

* Annual

* Monthly

* Daily

* Hourly

* Timestep
  • summary_reports

An optional list of EnergyPlus summary report names as strings. If None, only the 'AllSummary' report will be requested from the simulation and will appear in the HTML report output by EnergyPlus. See the Input Output Reference SummaryReports section for a full list of all reports that can be requested. https://bigladdersoftware.com/ epx/docs/9-1/input-output-reference/output-table-summaryreports.html

  • unmet_setpt_tol

A number in degrees Celsius for the difference that the zone conditions must be from the thermostat setpoint in order for the setpoint to be considered unmet. This will affect how unmet hours are reported in the output. ASHRAE 90.1 uses a tolerance of 1.11C, which is equivalent to 1.8F. (Default: 1.11C).

Outputs

  • report

Report!

  • sim_output

A SimulationOutput object that can be connected to the "HB Simulation Parameter" component in order to specify which types of outputs should be written from EnergyPlus.

[source code]