> For the complete documentation index, see [llms.txt](https://docs.ladybug.tools/hb-energy-primer/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ladybug.tools/hb-energy-primer/components/5_simulate/custom_simulation_output.md).

# Custom Simulation Output

![](/files/-Mihpfkjet2-3pmOipVb)

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

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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
