honeybee_energy.simulation.control module

Simulation controls for which types of calculations to run.

class honeybee_energy.simulation.control.SimulationControl(do_zone_sizing=True, do_system_sizing=True, do_plant_sizing=True, run_for_sizing_periods=False, run_for_run_periods=True)[source]

Bases: object

Simulation controls for which types of calculations to run.

Parameters:

  • do_zone_sizing – Boolean for whether the zone sizing calculation should be run. Default: True.

  • do_system_sizing – Boolean for whether the system sizing calculation should be run. Default: True.

  • do_plant_sizing – Boolean for whether the plant sizing calculation should be run. Default: True.

  • run_for_sizing_periods – Boolean for whether the simulation should be run for the sizing periods. Default: False.

  • run_for_run_periods – Boolean for whether the simulation should be run for the run periods. Default: True.

Properties:

  • do_zone_sizing

  • do_system_sizing

  • do_plant_sizing

  • run_for_sizing_periods

  • run_for_run_periods

ToString()[source]

Overwrite .NET ToString.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a SimulationControl object from a dictionary.

Parameters:

data – A SimulationControl dictionary in following the format below.

{
"type": "SimulationControl",
"do_zone_sizing": True,
"do_system_sizing": True,
"do_plant_sizing": True,
"run_for_sizing_periods": False,
"run_for_run_periods": True
}
classmethod from_idf(idf_string)[source]

Create a SimulationControl object from an EnergyPlus IDF text string.

Parameters:

idf_string – A text string fully describing an EnergyPlus SimulationControl definition.

to_dict()[source]

SimulationControl dictionary representation.

to_idf()[source]

Get an EnergyPlus string representation of the SimulationControl.

SimulationControl,
    Yes,                      !- do zone sizing
    Yes,                      !- do system sizing
    Yes,                      !- do plant sizing
    No,                       !- run for sizing periods
    Yes;                      !- run for run periods
property do_plant_sizing

Get or set a boolean for whether the plant sizing calculation is run.

property do_system_sizing

Get or set a boolean for whether the system sizing calculation is run.

property do_zone_sizing

Get or set a boolean for whether the zone sizing calculation is run.

property run_for_run_periods

Get or set a boolean for whether the simulation is run for run periods.

property run_for_sizing_periods

Get or set a boolean for whether the simulation is run for sizing periods.