Skip to content

How-to guides

Each guide here takes one task and walks it to a result. They assume you know what you want and are looking for the shortest correct route; if you are still learning the shape of the library, start with the Tutorials instead.

For exact signatures, options, and return types, see the Reference. For why something works the way it does, see Explanation.

Most guides show the same task in both languages, one tab each. Where a task exists in only one of them, the guide says so on its first screen.

Getting set up

Reading and editing models

In the browser

These two are TypeScript only, because there is no Python browser runtime.

Working with simulations

Running EnergyPlus locally is Python only, and needs an EnergyPlus installation on the machine.

Weather data

Schedules

Scaling out

Configuring and operating

When things go wrong