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

Simulation Parameter

PreviousSimulation OutputNextSizing Parameter

Last updated 3 years ago

-

Create a simulation parameter object that carries a complete set of EnergyPlus simulation settings and can be plugged into the "HB Model To OSM" component.

Inputs

  • north

A number between -360 and 360 for the counterclockwise difference between the North and the positive Y-axis in degrees. 90 is West and 270 is East. (Default: 0)

  • output

A SimulationOutput that lists the desired outputs from the simulation and the format in which to report them. This can be created using the "HB Simulation Output" component. Default is to request zone energy use at an hourly timestep.

  • run_period

A ladybyg AnalysisPeriod object to describe the time period over which to run the simulation. the default is to run the simulation for the whole year.

  • daylight_saving

An optional ladybug AnalysisPeriod object to describe start and end of daylight savings time in the simulation. If None, no daylight savings time will be applied to the simulation.

  • holidays

A list of Ladybug Date objects for the holidays within the simulation. These should be in the format of 'DD Month' (eg. '1 Jan', '25 Dec'). If None, no holidays are applied. Default: None.

  • start_dow

Text for the day of the week on which the simulation starts. Default: 'Sunday'. Choose from the following:

* Sunday

* Monday

* Tuesday

* Wednesday

* Thursday

* Friday

* Saturday
  • timestep

An integer for the number of timesteps per hour at which the calculation will be run. Default: 6. The following values are acceptable: (1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, 60)

  • terrain

Text for the terrain type in which the model sits, used to determine the wind profile. Default: 'City'. Choose from:

* Ocean

* Country

* Suburbs

* Urban

* City
  • sim_control

A SimulationControl object that describes which types of calculations to run. This can be generated from the "HB Simulation Control" component. Default: perform a sizing calculation but only run the simulation for the RunPeriod.

  • shadow_calc

A ShadowCalculation object describing settings for the EnergyPlus Shadow Calculation. This can be generated from the "HB Shadow Calculation" component. Default: Average over 30 days with FullExteriorWithReflections.

  • sizing

A SizingParameter object with criteria for sizing the heating and cooling system. This can be generated from the "HB Sizing Parameter" component.

Outputs

  • sim_par

A SimulationParameter object that can be connected to the "HB Model To IDF" component in order to specify EnergyPlus simulation settings

[source code]