Reference¶
Reference states facts: what each package contains, how a command behaves, what a format holds, and which defaults apply. These pages are here to be consulted, not read cover to cover. When you need a signature, a default, a valid range, or an exit code, this is where it lives. For a task, see the How-to guides; for the reasoning behind the design, see Explanation.
The API pages are generated from the source, so they stay faithful to the code. Pages that describe one language only say so.
Versions and schema data¶
- Supported EnergyPlus versions: the 17 releases both libraries bundle, how the version written in a file is matched to one of them, and which releases have generated static types.
- Slim schema format: the reduced schema form
@idfkit/schemasships, key by key. TypeScript only.
Python API¶
Generated from the docstrings in the source. The navigation carries the full list; these are the entry points:
- Core: Document, Objects, I/O, Schema, Validation, Geometry, References, Thermal, Visualization, Exceptions, Versions.
- Simulation: Runner, Async, Results, SQL, Batch, Cache.
- Weather: Station, Download, Design days.
TypeScript API¶
Not published on this site yet. It will be generated from a pinned TypeDoc
artefact and will appear in this section. Until it does, the TSDoc comments it
is generated from are the ones your editor already shows for @idfkit/core,
@idfkit/schemas, and @idfkit/weather.
CLI and configuration¶
Both pages describe the Python package. There is no JavaScript CLI, and the JavaScript packages read no environment variables.
idfkit tmy: search for and download weather files.- Environment variables: every variable idfkit reads, where it is read, and its default.
The other two commands are documented with the task they serve:
idfkit migrate forward-migrates a model
to a newer EnergyPlus version, and
idfkit check lints source for objects
and fields that do not exist in a target version.