# Simulation Output

![](/files/-MihpfpvGq9jkoPkhfF8)

![](/files/-Ma9Odp6qJHc3ItcmhOC) - [\[source code\]](https://github.com/ladybug-tools/honeybee-grasshopper-energy/blob/master/honeybee_grasshopper_energy/src//HB%20Simulation%20Output.py)

Create a simulation output object by selecting sets of commonly-requested output variables. The resulting object can be used to request output variables from EnergyPlus.

### Inputs

* **zone\_energy\_use**

Set to True to add outputs for zone energy use when ideal air systems are assigned. This includes, ideal air heating + cooling, lighting, electric + gas equipment, and fan electric energy.

* **system\_energy\_use**

Set to True to add outputs for HVAC energy use from detailed systems. This includes outputs for different pieces of HVAC equipment, which together catch all energy-consuming parts of a system. (eg. chillers, boilers, coils, humidifiers, fans, pumps). It also includes the energy use of components of Service Hot Water (SHW) systems as well as any electricity generated on site, such at that coming from photovoltaics.

* **gains\_and\_losses**

Set to True to Add outputs for zone gains and losses. This includes such as people gains, solar gains, infiltration losses/gains, and ventilation losses/gains.

* **comfort\_metrics**

Set to True to add outputs for zone thermal comfort analysis. This includes air temperature, mean radiant temperature, relative humidity, and unmet setpoint time.

* **surface\_temperature**

Set to True to add outputs for indoor and outdoor surface temperature.

* **surface\_energy\_flow**

Set to True to add outputs for energy flow across all surfaces.

* **load\_type**

An optional text value to set the type of load outputs requested. Default - 'All'. Choose from the following:

```
* All - all energy use including heat lost from the zone

* Total - the total load added to the zone (both sensible and latent)

* Sensible - the sensible load added to the zone

* Latent - the latent load added to the zone
```

* **report\_frequency**

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

```
* Annual

* Monthly

* Daily

* Hourly

* Timestep
```

### 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ladybug.tools/hb-energy-primer/components/5_simulate/simulation_output.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
