Skip to content

1.2 Extending the Model Schema

Chris Mackey edited this page Sep 4, 2020 · 2 revisions

The Model object and all 4 of the geometry objects that make up the Model are meant to be extended with properties for different simulation engines like EnergyPlus/OpenStudio and Radiance. This extension is done through a "properties" key that each of these objects possesses.

The "properties" key

Underneath the "properties" key that each geometry object possesses, keys are added for a specific simulation engine. These keys mus be consistent across all geometry objects in the model. For example, the "energy" key is used to house all of the properties of the object for energy simulation and the "radiance"key houses all properties of the object for radiance simulation. The "type" (or class) of the object in each of these slots follows a standard naming convention starting with the name of the object and ending with the word "Properties".

For example, the Model object has been extended to work for both energy and radiance simulations would be structured like so: Extended Dragonfly Model

The various keys under "properties" are all optional, meaning that radiance properties are not necessary when a model is only intended for energy simulation and vice versa.

Example extension for energy simulation

Underneath the key of a given extension, the properties related to that extension are stored. For example, extending the Model for energy simulation involves the addition of keys for materials, constructions, construction_sets, schedules and program_types like so: Extended Dragonfly Model for Energy