Skip to content

3.4 SimulationParameter Schema

Chris Mackey edited this page Jan 22, 2020 · 3 revisions

The SimulationParamter object represents a complete set of EnergyPlus simulation settings, including what type of calculation to run, how long to run it, and what results to record. Since these attributes are not related to building design, the SimulationParameter schema is wholly separate from the Honeybee Model schema.

However, it is still described here under the Honeybee energy extension since it is essential for running an energy simulation and must be supplied alongside the model in order to execute a simulation (similar to how the .epw file must also be supplied for an energy simulation).

SimulationParameter Schema

SimulationParameter attributes

The SimulationParameter includes the following attributes:

  • output: A SimulationOutput that lists the desired outputs from the simulation and the format in which to report them. If None, no outputs will be requested. Default: None.
  • run_period: A RunPeriod object to describe the time period over which to run the simulation. Default: Run for the whole year starting on Sunday.
  • timestep: An integer for the number of timesteps per hour at which the calculation will be run. Default: 6.
  • simulation_control: A SimulationControl object that describes which typesof calculations to run. Default: perform a sizing calculation but onlyrun the simulation for the RunPeriod.shadow_calculation: A ShadowCalculation object describing settings for the EnergyPlus Shadow Calculation. Default: Average over 30 days with FullInteriorAndExteriorWithReflections.
  • sizing_parameter: A SizingParameter object with criteria for sizing the heating and cooling system.