Dragonfly logo
Documentation Powered by Redocly

Dragonfly Model Schema (1.11.1)

Download OpenAPI specification:Download

Ladybug Tools: info@ladybug.tools URL: https://github.com/ladybug-tools/dragonfly-core License: MIT

Documentation for Dragonfly model schema

OpenAPI Specification with Inheritance

_AllAirBase

type
string (Type) ^_AllAirBase$
Default: "_AllAirBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

economizer_type
string (AllAirEconomizerType)
Default: "NoEconomizer"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy" "DifferentialDryBulbAndEnthalpy" "FixedDryBulb" "FixedEnthalpy" "ElectronicEnthalpy"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

{
  • "type": "_AllAirBase",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "economizer_type": "NoEconomizer",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false
}

_DOASBase

type
string (Type) ^_DOASBase$
Default: "_DOASBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

doas_availability_schedule
string (Doas Availability Schedule) [ 1 .. 100 ] characters

An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.

{
  • "type": "_DOASBase",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "doas_availability_schedule": "string"
}

_EquipmentBase

type
string (Type) ^_EquipmentBase$
Default: "_EquipmentBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by equipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "_EquipmentBase",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

_FaceSubSet

type
string (Type) ^_FaceSubSet$
Default: "_FaceSubSet"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

exterior_construction
object (Exterior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ground_construction
object (Ground Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "_FaceSubSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

_FaceSubSetAbridged

type
string (Type) ^_FaceSubSetAbridged$
Default: "_FaceSubSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "_FaceSubSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

_GridParameterBase

type
string (Type) ^_GridParameterBase$
Default: "_GridParameterBase"

A base class to use when there is no baseclass available to fall on.

dimension
required
number <double> (Dimension) > 0

The dimension of the grid cells as a number.

include_mesh
boolean (Include Mesh)
Default: true

A boolean to note whether the resulting SensorGrid should include the mesh.

{
  • "type": "_GridParameterBase",
  • "dimension": 0,
  • "include_mesh": true
}

_HeatCoolBase

type
string (Type) ^_HeatCoolBase$
Default: "_HeatCoolBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

{
  • "type": "_HeatCoolBase",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019"
}

_LouversBase

type
string (Type) ^_LouversBase$
Default: "_LouversBase"

A base class to use when there is no baseclass available to fall on.

depth
required
number <double> (Depth) > 0

A number for the depth to extrude the louvers.

offset
number <double> (Offset) >= 0
Default: 0

A number for the distance to louvers from the wall.

angle
number <double> (Angle) [ -90 .. 90 ]
Default: 0

A number between -90 and 90 for the for an angle to rotate the louvers in degrees. 0 indicates louvers perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation.

contour_vector
Array of numbers <double> (Contour Vector) = 2 items [ items <double > ]
Default: [0,1]

A list of two float values representing the (x, y) of a 2D vector for the direction along which contours are generated. (0, 1) will generate horizontal contours, (1, 0) will generate vertical contours, and (1, 1) will generate diagonal contours.

flip_start_side
boolean (Flip Start Side)
Default: false

Boolean to note whether the side the louvers start from should be flipped. Default is False to have contours on top or right. Setting to True will start contours on the bottom or left.

{
  • "type": "_LouversBase",
  • "depth": 0,
  • "offset": 0,
  • "angle": 0,
  • "contour_vector": [
    ],
  • "flip_start_side": false
}

_OpenAPIGenBaseModel

type
string (Type)
Default: "InvalidType"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "InvalidType"
}

_PropertiesBaseAbridged

type
string (Type) ^_PropertiesBaseAbridged$
Default: "_PropertiesBaseAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "_PropertiesBaseAbridged",
  • "modifier": "string",
  • "modifier_blk": "string"
}

_TemplateSystem

type
string (Type) ^_TemplateSystem$
Default: "_TemplateSystem"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

{
  • "type": "_TemplateSystem",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019"
}

_WindowParameterBase

type
string (Type) ^_WindowParameterBase$
Default: "_WindowParameterBase"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

{
  • "type": "_WindowParameterBase",
  • "user_data": { }
}

Adiabatic

type
string (Type) ^Adiabatic$
Default: "Adiabatic"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Adiabatic"
}

AFNCrack

type
string (Type) ^AFNCrack$
Default: "AFNCrack"

A base class to use when there is no baseclass available to fall on.

flow_coefficient
required
number <double> (Flow Coefficient) > 0

A number in kg/s-m at 1 Pa per meter of crack length at the conditions defined in the ReferenceCrack condition; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage wall to be 0.00001 and 0.001 for external and internal constructions, respectively. Flow coefficients for a very poor, high-leakage wall are defined to be 0.0004 and 0.019 for external and internal constructions, respectively.

flow_exponent
number <double> (Flow Exponent) [ 0.5 .. 1 ]
Default: 0.65

An optional dimensionless number between 0.5 and 1 used to calculate the crack mass flow rate; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.

{
  • "type": "AFNCrack",
  • "flow_coefficient": 0,
  • "flow_exponent": 0.65
}

AirBoundaryConstruction

type
string (Type) ^AirBoundaryConstruction$
Default: "AirBoundaryConstruction"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

air_mixing_per_area
number <double> (Air Mixing Per Area) >= 0
Default: 0.1

A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Air Mixing Schedule)

A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction. If unspecified, an Always On schedule will be assumed.

{
  • "type": "AirBoundaryConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "air_mixing_per_area": 0.1,
  • "air_mixing_schedule": {
    }
}

AirBoundaryConstructionAbridged

type
string (Type) ^AirBoundaryConstructionAbridged$
Default: "AirBoundaryConstructionAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

air_mixing_per_area
number <double> (Air Mixing Per Area) >= 0
Default: 0.1

A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.

air_mixing_schedule
string (Air Mixing Schedule) [ 1 .. 100 ] characters

Identifier of a fractional schedule for the air mixing schedule across the construction. If unspecified, an Always On schedule will be assumed.

{
  • "type": "AirBoundaryConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "air_mixing_per_area": 0.1,
  • "air_mixing_schedule": "string"
}

AllAirEconomizerType

string (AllAirEconomizerType)
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy" "DifferentialDryBulbAndEnthalpy" "FixedDryBulb" "FixedEnthalpy" "ElectronicEnthalpy"

An enumeration.

"NoEconomizer"

Aperture

type
string (Type) ^Aperture$
Default: "Aperture"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

A single planar face in 3D space.

required
Outdoors (object) or Surface (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_operable
boolean (Is Operable)
Default: false

Boolean to note whether the Aperture can be opened for ventilation.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object (eg. window sill, light shelf).

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. mullions, louvers).

{
  • "type": "Aperture",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "is_operable": false,
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

ApertureConstructionSet

type
string (Type) ^ApertureConstructionSet$
Default: "ApertureConstructionSet"

A base class to use when there is no baseclass available to fall on.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Interior Construction)

A WindowConstruction for all apertures with a Surface boundary condition.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Window Construction)

A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Skylight Construction)

A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Operable Construction)

A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.

{
  • "type": "ApertureConstructionSet",
  • "interior_construction": {
    },
  • "window_construction": {
    },
  • "skylight_construction": {
    },
  • "operable_construction": {
    }
}

ApertureConstructionSetAbridged

type
string (Type) ^ApertureConstructionSetAbridged$
Default: "ApertureConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all apertures with a Surface boundary condition.

window_construction
string (Window Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.

skylight_construction
string (Skylight Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

operable_construction
string (Operable Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.

{
  • "type": "ApertureConstructionSetAbridged",
  • "interior_construction": "string",
  • "window_construction": "string",
  • "skylight_construction": "string",
  • "operable_construction": "string"
}

ApertureEnergyPropertiesAbridged

type
string (Type) ^ApertureEnergyPropertiesAbridged$
Default: "ApertureEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of a WindowConstruction for the aperture. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_opening
object (Vent Opening) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "ApertureEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_opening": {
    }
}

ApertureModifierSet

type
string (Type) ^ApertureModifierSet$
Default: "ApertureModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Window Modifier)

A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A modifier object for apertures with a Surface boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Skylight Modifier)

A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Operable Modifier)

A modifier object for apertures with an Outdoors boundary condition and a True is_operable property.

{
  • "type": "ApertureModifierSet",
  • "window_modifier": {
    },
  • "interior_modifier": {
    },
  • "skylight_modifier": {
    },
  • "operable_modifier": {
    }
}

ApertureModifierSetAbridged

type
string (Type) ^ApertureModifierSetAbridged$
Default: "ApertureModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

window_modifier
string (Window Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.

interior_modifier
string (Interior Modifier)

Identifier of modifier object for apertures with a Surface boundary condition.

skylight_modifier
string (Skylight Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.

operable_modifier
string (Operable Modifier)

Identifier of modifier object for apertures with an Outdoors boundary condition and a True is_operable property.

{
  • "type": "ApertureModifierSetAbridged",
  • "window_modifier": "string",
  • "interior_modifier": "string",
  • "skylight_modifier": "string",
  • "operable_modifier": "string"
}

AperturePropertiesAbridged

type
string (Type) ^AperturePropertiesAbridged$
Default: "AperturePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (ApertureEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ApertureRadiancePropertiesAbridged) Recursive

Base class of Abridged Radiance Properties.

{
  • "type": "AperturePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

ApertureRadiancePropertiesAbridged

type
string (Type) ^ApertureRadiancePropertiesAbridged$
Default: "ApertureRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Aperture is a part of. Apertures sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Aperture is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "ApertureRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

Autocalculate

type
string (Type) ^Autocalculate$
Default: "Autocalculate"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Autocalculate"
}

Autosize

type
string (Type) ^Autosize$
Default: "Autosize"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Autosize"
}

Baseboard

type
string (Type) ^Baseboard$
Default: "Baseboard"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (BaseboardEquipmentType)
Default: "ElectricBaseboard"
Enum: "ElectricBaseboard" "BoilerBaseboard" "ASHPBaseboard" "DHWBaseboard"

An enumeration.

{
  • "type": "Baseboard",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "ElectricBaseboard"
}

BaseboardEquipmentType

string (BaseboardEquipmentType)
Enum: "ElectricBaseboard" "BoilerBaseboard" "ASHPBaseboard" "DHWBaseboard"

An enumeration.

"ElectricBaseboard"

BaseModifierSet

type
string (Type) ^BaseModifierSet$
Default: "BaseModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "BaseModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

BaseModifierSetAbridged

type
string (Type) ^BaseModifierSetAbridged$
Default: "BaseModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "BaseModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

BSDF

type
string (Type) ^BSDF$
Default: "BSDF"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

bsdf_data
required
string (Bsdf Data)

A string with the contents of the BSDF XML file.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

up_orientation
Array of numbers <double> (Up Orientation) = 3 items [ items <double > ]
Default: [0.01,0.01,1]

Vector as sequence that sets the hemisphere that the BSDF material faces.

thickness
number <double> (Thickness)
Default: 0

Optional number to set the thickness of the BSDF material Sign of thickness indicates whether proxied geometry is behind the BSDF surface (when thickness is positive) or in front (when thickness is negative).

function_file
string (Function File) [ 1 .. 100 ] characters
Default: "."

Optional input for function file. Using "." will ensure that BSDF data is written to the root of wherever a given study is run.

transform
string (Transform) [ 1 .. 100 ] characters

Optional transform input to scale the thickness and reorient the up vector.

front_diffuse_reflectance
Array of numbers <double> (Front Diffuse Reflectance) = 3 items [ items <double > ]

Optional additional front diffuse reflectance as sequence of three RGB numbers.

back_diffuse_reflectance
Array of numbers <double> (Back Diffuse Reflectance) = 3 items [ items <double > ]

Optional additional back diffuse reflectance as sequence of three RGB numbers.

diffuse_transmittance
Array of numbers <double> (Diffuse Transmittance) = 3 items [ items <double > ]

Optional additional diffuse transmittance as sequence of three RGB numbers.

{
  • "type": "BSDF",
  • "identifier": "string",
  • "display_name": "string",
  • "bsdf_data": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "up_orientation": [
    ],
  • "thickness": 0,
  • "function_file": ".",
  • "transform": "string",
  • "front_diffuse_reflectance": [
    ],
  • "back_diffuse_reflectance": [
    ],
  • "diffuse_transmittance": [
    ]
}

Building

type
string (Type) ^Building$
Default: "Building"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Array of objects (Unique Stories)

An array of unique dragonfly Story objects that together form the entire building. Stories should generally be ordered from lowest floor to highest floor, though this is not required. Note that, if a given Story is repeated several times over the height of the building and this is represented by the multiplier, the unique story included in this list should be the first (lowest) story of the repeated floors.

Array of objects (Room 3Ds)

An optional array of 3D Honeybee Room objects for additional Rooms that are a part of the Building but are not represented within the unique_stories. This is useful when there are parts of the Building geometry that cannot easily be represented with the extruded floor plate and sloped roof assumptions that underlie Dragonfly Room2Ds and RoofSpecification. Cases where this input is most useful include sloped walls and certain types of domed roofs that become tedious to implement with RoofSpecification. Matching the Honeybee Room.story property to the Dragonfly Story.display_name of an object within the unique_stories will effectively place the Honeybee Room on that Story for the purposes of floor_area, exterior_wall_area, etc. However, note that the Honeybee Room.multiplier property takes precedence over whatever multiplier is assigned to the Dragonfly Story that the Room.story may reference. (Default: None).

{
  • "type": "Building",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "properties": {
    },
  • "unique_stories": [
    ],
  • "room_3ds": [
    ]
}

BuildingEnergyPropertiesAbridged

type
string (Type) ^BuildingEnergyPropertiesAbridged$
Default: "BuildingEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction_set
string (Construction Set) [ 1 .. 100 ] characters

Name of a ConstructionSet to specify all constructions for the Building. If None, the Model global_construction_set will be used.

{
  • "type": "BuildingEnergyPropertiesAbridged",
  • "construction_set": "string"
}

BuildingPropertiesAbridged

type
string (Type) ^BuildingPropertiesAbridged$
Default: "BuildingPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (BuildingEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (BuildingRadiancePropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "BuildingPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

BuildingRadiancePropertiesAbridged

type
string (Type) ^BuildingRadiancePropertiesAbridged$
Default: "BuildingRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier_set
string (Modifier Set)

Name of a ModifierSet to specify all modifiers for the Building. If None, the Model global_modifier_set will be used.

{
  • "type": "BuildingRadiancePropertiesAbridged",
  • "modifier_set": "string"
}

Color

type
string (Type) ^Color$
Default: "Color"

A base class to use when there is no baseclass available to fall on.

r
required
integer <int32> (R) [ 0 .. 255 ]

Value for red channel.

g
required
integer <int32> (G) [ 0 .. 255 ]

Value for green channel.

b
required
integer <int32> (B) [ 0 .. 255 ]

Value for blue channel.

a
integer <int32> (A) [ 0 .. 255 ]
Default: 255

Value for the alpha channel, which defines the opacity as a number between 0 (fully transparent) and 255 (fully opaque).

{
  • "type": "Color",
  • "r": 255,
  • "g": 255,
  • "b": 255,
  • "a": 255
}

ConstructionSet

type
string (Type) ^ConstructionSet$
Default: "ConstructionSet"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

wall_set
object (Wall Set) Recursive

A set of constructions for wall assemblies.

floor_set
object (Floor Set) Recursive

A set of constructions for floor assemblies.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

A set of constructions for roof and ceiling assemblies.

aperture_set
object (Aperture Set) Recursive

A set of constructions for aperture assemblies.

door_set
object (Door Set) Recursive

A set of constructions for door assemblies.

shade_construction
object (Shade Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

AirBoundaryConstruction (object) or OpaqueConstruction (object) (Air Boundary Construction)

An AirBoundaryConstruction or OpaqueConstruction to set the properties of Faces with an AirBoundary type.

{
  • "type": "ConstructionSet",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_construction": {
    },
  • "air_boundary_construction": {
    }
}

ConstructionSetAbridged

type
string (Type) ^ConstructionSetAbridged$
Default: "ConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

wall_set
object (Wall Set) Recursive

A set of constructions for wall, floor, or roof assemblies.

floor_set
object (Floor Set) Recursive

A set of constructions for wall, floor, or roof assemblies.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

A set of constructions for wall, floor, or roof assemblies.

aperture_set
object (Aperture Set) Recursive

A set of constructions for aperture assemblies.

door_set
object (Door Set) Recursive

A set of constructions for door assemblies.

shade_construction
string (Shade Construction) [ 1 .. 100 ] characters

The identifier of a ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.

air_boundary_construction
string (Air Boundary Construction) [ 1 .. 100 ] characters

The identifier of an AirBoundaryConstruction or OpaqueConstruction to set the properties of Faces with an AirBoundary type.

{
  • "type": "ConstructionSetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_construction": "string",
  • "air_boundary_construction": "string"
}

ContextShade

type
string (Type) ^ContextShade$
Default: "ContextShade"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of Face3D (object) or Mesh3D (object) (Geometry)

An array of planar Face3Ds and or Mesh3Ds that together represent the context shade.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_detached
boolean (Is Detached)
Default: true

Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context.

{
  • "type": "ContextShade",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": [
    ],
  • "properties": {
    },
  • "is_detached": true
}

ContextShadeEnergyPropertiesAbridged

type
string (Type) ^ContextShadeEnergyPropertiesAbridged$
Default: "ContextShadeEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Name of a ShadeConstruction to set the reflectance and specularity of the ContextShade. If None, the the EnergyPlus default of 0.2 diffuse reflectance will be used.

transmittance_schedule
string (Transmittance Schedule) [ 1 .. 100 ] characters

Name of a schedule to set the transmittance of the ContextShade, which can vary throughout the simulation. If None, the ContextShade will be completely opaque.

{
  • "type": "ContextShadeEnergyPropertiesAbridged",
  • "construction": "string",
  • "transmittance_schedule": "string"
}

ContextShadePropertiesAbridged

type
string (Type) ^ContextShadePropertiesAbridged$
Default: "ContextShadePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (ContextShadeEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ContextShadeRadiancePropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "ContextShadePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

ContextShadeRadiancePropertiesAbridged

type
string (Type) ^ContextShadeRadiancePropertiesAbridged$
Default: "ContextShadeRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

Name of a Modifier to set the reflectance and specularity of the ContextShade. If None, the the default of 0.2 diffuse reflectance will be used.

{
  • "type": "ContextShadeRadiancePropertiesAbridged",
  • "modifier": "string"
}

ControlType

string (ControlType)
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Choices for how the shading device is controlled.

"AlwaysOn"

DatedBaseModel

type
string (Type) ^DatedBaseModel$
Default: "DatedBaseModel"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "DatedBaseModel"
}

DaylightingControl

type
string (Type) ^DaylightingControl$
Default: "DaylightingControl"

A base class to use when there is no baseclass available to fall on.

sensor_position
required
Array of numbers <double> (Sensor Position) = 3 items [ items <double > ]

A point as 3 (x, y, z) values for the position of the daylight sensor within the parent Room. This point should lie within the Room volume in order for the results to be meaningful.

illuminance_setpoint
number <double> (Illuminance Setpoint) > 0
Default: 300

A number for the illuminance setpoint in lux beyond which electric lights are dimmed if there is sufficient daylight.

control_fraction
number <double> (Control Fraction) [ 0 .. 1 ]
Default: 1

A number between 0 and 1 that represents the fraction of the Room lights that are dimmed when the illuminance at the sensor position is at the specified illuminance. 1 indicates that all lights are dim-able while 0 indicates that no lights are dim-able. Deeper rooms should have lower control fractions to account for the face that the lights in the back of the space do not dim in response to suitable daylight at the front of the room.

min_power_input
number <double> (Min Power Input) [ 0 .. 1 ]
Default: 0.3

A number between 0 and 1 for the the lowest power the lighting system can dim down to, expressed as a fraction of maximum input power.

min_light_output
number <double> (Min Light Output) [ 0 .. 1 ]
Default: 0.2

A number between 0 and 1 the lowest lighting output the lighting system can dim down to, expressed as a fraction of maximum light output.

off_at_minimum
boolean (Off At Minimum)
Default: false

Boolean to note whether lights should switch off completely when they get to the minimum power input.

{
  • "type": "DaylightingControl",
  • "sensor_position": [
    ],
  • "illuminance_setpoint": 300,
  • "control_fraction": 1,
  • "min_power_input": 0.3,
  • "min_light_output": 0.2,
  • "off_at_minimum": false
}

DetailedHVAC

type
string (Type) ^DetailedHVAC$
Default: "DetailedHVAC"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

specification
required
object (Specification)

A JSON-serializable dictionary representing the full specification of the detailed system. This can be obtained by calling the ToJson() method on any IronBug HVAC system and then serializing the resulting JSON string into a Python dictionary using the native Python json package. Note that the Rooms that the HVAC is assigned to must be specified as ThermalZones under this specification in order for the resulting Model this HVAC is a part of to be valid.

{
  • "type": "DetailedHVAC",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "specification": { }
}

DetailedSkylights

type
string (Type) ^DetailedSkylights$
Default: "DetailedSkylights"

A base class to use when there is no baseclass available to fall on.

polygons
required
Array of numbers (Polygons) [ items >= 3 items [ items <double > = 2 items [ items <double > ] ] ]

An array of arrays with each sub-array representing a polygonal boundary of a skylight. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the world XY system. These coordinate values should lie within the parent Room2D Polygon.

are_doors
Array of booleans (Are Doors)

An array of booleans that align with the polygons and note whether each of the polygons represents an overhead door (True) or a skylight (False). If None, it will be assumed that all polygons represent skylights and they will be translated to Apertures in any resulting Honeybee model.

{
  • "type": "DetailedSkylights",
  • "polygons": [
    ],
  • "are_doors": [
    ]
}

DetailedWindows

type
string (Type) ^DetailedWindows$
Default: "DetailedWindows"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

polygons
required
Array of numbers (Polygons) [ items >= 3 items [ items <double > [ 2 .. 3 ] items [ items <double > > 0 ] ] ]

An array of arrays with each sub-array representing a polygonal boundary of a window. Each sub-array should consist of arrays representing points, which can either contain 2 values (indicating they are 2D vertices within the plane of a parent wall segment) or they can contain 3 values (indicating they are 3D world coordinates). For 2D points, the wall plane is assumed to have an origin at the first point of the wall segment and an X-axis extending along the length of the segment. The wall plane Y-axis always points upwards. Therefore, both X and Y values of each point in the polygon should always be positive. Some sample code to convert from 2D vertices to 2D vertices in the plane of the wall can be found here: https://www.ladybug.tools/dragonfly-core/docs/dragonfly.windowparameter.html#dragonfly.windowparameter.DetailedWindows

are_doors
Array of booleans (Are Doors)

An array of booleans that align with the polygons and note whether each of the polygons represents a door (True) or a window (False). If None, it will be assumed that all polygons represent windows and they will be translated to Apertures in any resulting Honeybee model.

{
  • "type": "DetailedWindows",
  • "user_data": { },
  • "polygons": [
    ],
  • "are_doors": [
    ]
}

Door

type
string (Type) ^Door$
Default: "Door"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

A single planar face in 3D space.

required
Outdoors (object) or Surface (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_glass
boolean (Is Glass)
Default: false

Boolean to note whether this object is a glass door as opposed to an opaque door.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object.

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. entryway awning).

{
  • "type": "Door",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "is_glass": false,
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

DoorConstructionSet

type
string (Type) ^DoorConstructionSet$
Default: "DoorConstructionSet"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

exterior_construction
object (Exterior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

overhead_construction
object (Overhead Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Exterior Glass Construction)

A WindowConstruction for all glass doors with an Outdoors boundary condition.

WindowConstruction (object) or WindowConstructionShade (object) or WindowConstructionDynamic (object) (Interior Glass Construction)

A WindowConstruction for all glass doors with a Surface boundary condition.

{
  • "type": "DoorConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "overhead_construction": {
    },
  • "exterior_glass_construction": {
    },
  • "interior_glass_construction": {
    }
}

DoorConstructionSetAbridged

type
string (Type) ^DoorConstructionSetAbridged$
Default: "DoorConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for all opaque doors with a Surface boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.

overhead_construction
string (Overhead Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.

exterior_glass_construction
string (Exterior Glass Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all glass doors with an Outdoors boundary condition.

interior_glass_construction
string (Interior Glass Construction) [ 1 .. 100 ] characters

Identifier for a WindowConstruction for all glass doors with a Surface boundary condition.

{
  • "type": "DoorConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "overhead_construction": "string",
  • "exterior_glass_construction": "string",
  • "interior_glass_construction": "string"
}

DoorEnergyPropertiesAbridged

type
string (Type) ^DoorEnergyPropertiesAbridged$
Default: "DoorEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of an OpaqueConstruction or WindowConstruction for the door. Note that the host door must have the is_glass property set to True to assign a WindowConstruction. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_opening
object (Vent Opening) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "DoorEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_opening": {
    }
}

DoorModifierSet

type
string (Type) ^DoorModifierSet$
Default: "DoorModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Glass Modifier)

A modifier object for glass with a Surface boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Glass Modifier)

A modifier object for glass with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Overhead Modifier)

A window modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

{
  • "type": "DoorModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    },
  • "interior_glass_modifier": {
    },
  • "exterior_glass_modifier": {
    },
  • "overhead_modifier": {
    }
}

DoorModifierSetAbridged

type
string (Type) ^DoorModifierSetAbridged$
Default: "DoorModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

interior_glass_modifier
string (Interior Glass Modifier)

Identifier of modifier object for glass with a Surface boundary condition.

exterior_glass_modifier
string (Exterior Glass Modifier)

Identifier of modifier object for glass with an Outdoors boundary condition.

overhead_modifier
string (Overhead Modifier)

Identifier of a modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.

{
  • "type": "DoorModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string",
  • "interior_glass_modifier": "string",
  • "exterior_glass_modifier": "string",
  • "overhead_modifier": "string"
}

DoorPropertiesAbridged

type
string (Type) ^DoorPropertiesAbridged$
Default: "DoorPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (DoorEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (DoorRadiancePropertiesAbridged) Recursive

Base class of Abridged Radiance Properties.

{
  • "type": "DoorPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

DoorRadiancePropertiesAbridged

type
string (Type) ^DoorRadiancePropertiesAbridged$
Default: "DoorRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Door is a part of. Doors sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Door is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "DoorRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

EconomizerType

string (EconomizerType)
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

An enumeration.

"NoEconomizer"

ElectricEquipment

type
string (Type) ^ElectricEquipment$
Default: "ElectricEquipment"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by equipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "ElectricEquipment",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

ElectricEquipmentAbridged

type
string (Type) ^ElectricEquipmentAbridged$
Default: "ElectricEquipmentAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by equipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "ElectricEquipmentAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

EnergyBaseModel

type
string (Type) ^EnergyBaseModel$
Default: "EnergyBaseModel"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "EnergyBaseModel",
  • "identifier": "string",
  • "display_name": "string"
}

EnergyMaterial

type
string (Type) ^EnergyMaterial$
Default: "EnergyMaterial"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

thickness
required
number <double> (Thickness) ( 0 .. 3 ]

Thickness of the material layer in meters.

conductivity
required
number <double> (Conductivity) > 0

Thermal conductivity of the material layer in W/m-K.

density
required
number <double> (Density) > 0

Density of the material layer in kg/m3.

specific_heat
required
number <double> (Specific Heat) >= 100

Specific heat of the material layer in J/kg-K.

roughness
string (Roughness)
Default: "MediumRough"
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

thermal_absorptance
number <double> (Thermal Absorptance) ( 0 .. 0.99999 ]
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the material. Default: 0.9.

solar_absorptance
number <double> (Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the material. Default: 0.7.

visible_absorptance
number <double> (Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.

{
  • "type": "EnergyMaterial",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "thickness": 3,
  • "conductivity": 0,
  • "density": 0,
  • "specific_heat": 100,
  • "roughness": "MediumRough",
  • "thermal_absorptance": 0.9,
  • "solar_absorptance": 0.7,
  • "visible_absorptance": 0.7
}

EnergyMaterialNoMass

type
string (Type) ^EnergyMaterialNoMass$
Default: "EnergyMaterialNoMass"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

r_value
required
number <double> (R Value) >= 0.001

The thermal resistance (R-value) of the material layer [m2-K/W].

roughness
string (Roughness)
Default: "MediumRough"
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

thermal_absorptance
number <double> (Thermal Absorptance) ( 0 .. 0.99999 ]
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the material. Default: 0.9.

solar_absorptance
number <double> (Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the material. Default: 0.7.

visible_absorptance
number <double> (Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.

{
  • "type": "EnergyMaterialNoMass",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "r_value": 0.001,
  • "roughness": "MediumRough",
  • "thermal_absorptance": 0.9,
  • "solar_absorptance": 0.7,
  • "visible_absorptance": 0.7
}

EnergyMaterialVegetation

type
string (Type) ^EnergyMaterialVegetation$
Default: "EnergyMaterialVegetation"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

roughness
string (Roughness)
Default: "MediumRough"
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

thickness
number <double> (Thickness) ( 0 .. 3 ]
Default: 0.1

Thickness of the soil layer in meters.

conductivity
number <double> (Conductivity) > 0
Default: 0.35

Thermal conductivity of the dry soil in W/m-K.

density
number <double> (Density) > 0
Default: 1100

Density of the dry soil in kg/m3.

specific_heat
number <double> (Specific Heat) >= 100
Default: 1200

Specific heat of the dry soil in J/kg-K.

soil_thermal_absorptance
number <double> (Soil Thermal Absorptance) ( 0 .. 0.99999 ]
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the soil. Default: 0.9.

soil_solar_absorptance
number <double> (Soil Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the soil. Default: 0.7.

soil_visible_absorptance
number <double> (Soil Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the material. Default: 0.7.

plant_height
number <double> (Plant Height) [ 0.005 .. 1 ]
Default: 0.2

The height of plants in the vegetation in meters.

leaf_area_index
number <double> (Leaf Area Index) [ 0.001 .. 5 ]
Default: 1

The projected leaf area per unit area of soil surface (aka. Leaf Area Index or LAI). Note that the fraction of vegetation cover is calculated directly from LAI using an empirical relation.

leaf_reflectivity
number <double> (Leaf Reflectivity) [ 0.005 .. 0.5 ]
Default: 0.22

The fraction of incident solar radiation that is reflected by the leaf surfaces. Solar radiation includes the visible spectrum as well as infrared and ultraviolet wavelengths. Typical values are 0.18 to 0.25.

leaf_emissivity
number <double> (Leaf Emissivity) [ 0.8 .. 1 ]
Default: 0.95

The ratio of thermal radiation emitted from leaf surfaces to that emitted by an ideal black body at the same temperature.

min_stomatal_resist
number <double> (Min Stomatal Resist) [ 50 .. 300 ]
Default: 180

The resistance of the plants to moisture transport [s/m]. Plants with low values of stomatal resistance will result in higher evapotranspiration rates than plants with high resistance.

sat_vol_moist_cont
number <double> (Sat Vol Moist Cont) [ 0.1 .. 0.5 ]
Default: 0.3

The saturation moisture content of the soil by volume.

residual_vol_moist_cont
number <double> (Residual Vol Moist Cont) [ 0.01 .. 0.1 ]
Default: 0.01

The residual moisture content of the soil by volume.

init_vol_moist_cont
number <double> (Init Vol Moist Cont) [ 0.05 .. 0.5 ]
Default: 0.01

The initial moisture content of the soil by volume.

moist_diff_model
string (MoistureDiffusionModel)
Default: "Simple"
Enum: "Simple" "Advanced"

Acceptable values for the moisture diffusion model for vegetation.

{
  • "type": "EnergyMaterialVegetation",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "roughness": "MediumRough",
  • "thickness": 0.1,
  • "conductivity": 0.35,
  • "density": 1100,
  • "specific_heat": 1200,
  • "soil_thermal_absorptance": 0.9,
  • "soil_solar_absorptance": 0.7,
  • "soil_visible_absorptance": 0.7,
  • "plant_height": 0.2,
  • "leaf_area_index": 1,
  • "leaf_reflectivity": 0.22,
  • "leaf_emissivity": 0.95,
  • "min_stomatal_resist": 180,
  • "sat_vol_moist_cont": 0.3,
  • "residual_vol_moist_cont": 0.01,
  • "init_vol_moist_cont": 0.01,
  • "moist_diff_model": "Simple"
}

EnergyWindowFrame

type
string (Type) ^EnergyWindowFrame$
Default: "EnergyWindowFrame"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

width
required
number <double> (Width) ( 0 .. 1 ]

Number for the width of frame in plane of window [m]. The frame width is assumed to be the same on all sides of window..

conductance
required
number <double> (Conductance) > 0

Number for the thermal conductance of the frame material measured from inside to outside of the frame surface (no air films) and taking 2D conduction effects into account [W/m2-K].

edge_to_center_ratio
number <double> (Edge To Center Ratio) ( 0 .. 4 ]
Default: 1

Number between 0 and 4 for the ratio of the glass conductance near the frame (excluding air films) divided by the glass conductance at the center of the glazing (excluding air films). This is used only for multi-pane glazing constructions. This ratio should usually be greater than 1.0 since the spacer material that separates the glass panes is usually more conductive than the gap between panes. A value of 1 effectively indicates no spacer. Values should usually be obtained from the LBNL WINDOW program so that the unique characteristics of the window construction can be accounted for.

outside_projection
number <double> (Outside Projection) [ 0 .. 0.5 ]
Default: 0

Number for the distance that the frame projects outward from the outside face of the glazing [m]. This is used to calculate shadowing of frame onto glass, solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.

inside_projection
number <double> (Inside Projection) [ 0 .. 0.5 ]
Default: 0

Number for the distance that the frame projects inward from the inside face of the glazing [m]. This is used to calculate solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.

thermal_absorptance
number <double> (Thermal Absorptance) ( 0 .. 0.99999 ]
Default: 0.9

Fraction of incident long wavelength radiation that is absorbed by the frame material.

solar_absorptance
number <double> (Solar Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident solar radiation absorbed by the frame material.

visible_absorptance
number <double> (Visible Absorptance) [ 0 .. 1 ]
Default: 0.7

Fraction of incident visible wavelength radiation absorbed by the frame material.

{
  • "type": "EnergyWindowFrame",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "width": 1,
  • "conductance": 0,
  • "edge_to_center_ratio": 1,
  • "outside_projection": 0,
  • "inside_projection": 0,
  • "thermal_absorptance": 0.9,
  • "solar_absorptance": 0.7,
  • "visible_absorptance": 0.7
}

EnergyWindowMaterialBlind

type
string (Type) ^EnergyWindowMaterialBlind$
Default: "EnergyWindowMaterialBlind"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

slat_orientation
string (SlatOrientation)
Default: "Horizontal"
Enum: "Horizontal" "Vertical"

An enumeration.

slat_width
number <double> (Slat Width) ( 0 .. 1 ]
Default: 0.025

The width of slat measured from edge to edge in meters.

slat_separation
number <double> (Slat Separation) ( 0 .. 1 ]
Default: 0.01875

The distance between the front of a slat and the back of the adjacent slat in meters.

slat_thickness
number <double> (Slat Thickness) ( 0 .. 0.1 ]
Default: 0.001

The distance between the faces of a slat in meters. The default value is 0.001.

slat_angle
number <double> (Slat Angle) [ 0 .. 180 ]
Default: 45

The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.

slat_conductivity
number <double> (Slat Conductivity) > 0
Default: 221

The thermal conductivity of the slat in W/(m-K). Default: 221.

beam_solar_transmittance
number <double> (Beam Solar Transmittance) [ 0 .. 1 )
Default: 0

The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.

beam_solar_reflectance
number <double> (Beam Solar Reflectance) [ 0 .. 1 )
Default: 0.5

The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.

beam_solar_reflectance_back
number <double> (Beam Solar Reflectance Back) [ 0 .. 1 )
Default: 0.5

The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.

diffuse_solar_transmittance
number <double> (Diffuse Solar Transmittance) [ 0 .. 1 )
Default: 0

The slat transmittance for hemispherically diffuse solar radiation. Default: 0.

diffuse_solar_reflectance
number <double> (Diffuse Solar Reflectance) [ 0 .. 1 )
Default: 0.5

The front-side slat reflectance for hemispherically diffuse solar radiation. Default: 0.5.

diffuse_solar_reflectance_back
number <double> (Diffuse Solar Reflectance Back) [ 0 .. 1 )
Default: 0.5

The back-side slat reflectance for hemispherically diffuse solar radiation. Default: 0.5.

beam_visible_transmittance
number <double> (Beam Visible Transmittance) [ 0 .. 1 )
Default: 0

The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default: 0.

beam_visible_reflectance
number <double> (Beam Visible Reflectance) [ 0 .. 1 )
Default: 0.5

The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.

beam_visible_reflectance_back
number <double> (Beam Visible Reflectance Back) [ 0 .. 1 )
Default: 0.5

The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default: 0.5.

diffuse_visible_transmittance
number <double> (Diffuse Visible Transmittance) [ 0 .. 1 )
Default: 0

The slat transmittance for hemispherically diffuse visible radiation. This value should equal “Slat Beam Visible Transmittance.”

diffuse_visible_reflectance
number <double> (Diffuse Visible Reflectance) [ 0 .. 1 )
Default: 0.5

The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal “Front Side Slat Beam Visible Reflectance.” Default: 0.5.

diffuse_visible_reflectance_back
number <double> (Diffuse Visible Reflectance Back) [ 0 .. 1 )
Default: 0.5

The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal “Back Side Slat Beam Visible Reflectance. Default: 0.5.”

infrared_transmittance
number <double> (Infrared Transmittance) [ 0 .. 1 )
Default: 0

The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.

emissivity
number <double> (Emissivity) [ 0 .. 1 )
Default: 0.9

Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.

emissivity_back
number <double> (Emissivity Back) [ 0 .. 1 )
Default: 0.9

Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.

distance_to_glass
number <double> (Distance To Glass) [ 0.01 .. 1 ]
Default: 0.05

The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.

top_opening_multiplier
number <double> (Top Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade.

bottom_opening_multiplier
number <double> (Bottom Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade.

left_opening_multiplier
number <double> (Left Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade.

right_opening_multiplier
number <double> (Right Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade.

{
  • "type": "EnergyWindowMaterialBlind",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "slat_orientation": "Horizontal",
  • "slat_width": 0.025,
  • "slat_separation": 0.01875,
  • "slat_thickness": 0.001,
  • "slat_angle": 45,
  • "slat_conductivity": 221,
  • "beam_solar_transmittance": 0,
  • "beam_solar_reflectance": 0.5,
  • "beam_solar_reflectance_back": 0.5,
  • "diffuse_solar_transmittance": 0,
  • "diffuse_solar_reflectance": 0.5,
  • "diffuse_solar_reflectance_back": 0.5,
  • "beam_visible_transmittance": 0,
  • "beam_visible_reflectance": 0.5,
  • "beam_visible_reflectance_back": 0.5,
  • "diffuse_visible_transmittance": 0,
  • "diffuse_visible_reflectance": 0.5,
  • "diffuse_visible_reflectance_back": 0.5,
  • "infrared_transmittance": 0,
  • "emissivity": 0.9,
  • "emissivity_back": 0.9,
  • "distance_to_glass": 0.05,
  • "top_opening_multiplier": 0.5,
  • "bottom_opening_multiplier": 0.5,
  • "left_opening_multiplier": 0.5,
  • "right_opening_multiplier": 0.5
}

EnergyWindowMaterialGas

type
string (Type) ^EnergyWindowMaterialGas$
Default: "EnergyWindowMaterialGas"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

thickness
number <double> (Thickness) > 0
Default: 0.0125

Thickness of the gas layer in meters. Default: 0.0125.

gas_type
string (GasType)
Default: "Air"
Enum: "Air" "Argon" "Krypton" "Xenon"

An enumeration.

{
  • "type": "EnergyWindowMaterialGas",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "thickness": 0.0125,
  • "gas_type": "Air"
}

EnergyWindowMaterialGasCustom

type
string (Type) ^EnergyWindowMaterialGasCustom$
Default: "EnergyWindowMaterialGasCustom"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

conductivity_coeff_a
required
number <double> (Conductivity Coeff A)

The A coefficient for gas conductivity in W/(m-K).

viscosity_coeff_a
required
number <double> (Viscosity Coeff A) > 0

The A coefficient for gas viscosity in kg/(m-s).

specific_heat_coeff_a
required
number <double> (Specific Heat Coeff A) > 0

The A coefficient for gas specific heat in J/(kg-K).

specific_heat_ratio
required
number <double> (Specific Heat Ratio) > 1

The specific heat ratio for gas.

molecular_weight
required
number <double> (Molecular Weight) [ 20 .. 200 ]

The molecular weight for gas in g/mol.

thickness
number <double> (Thickness) > 0
Default: 0.0125

Thickness of the gas layer in meters. Default: 0.0125.

conductivity_coeff_b
number <double> (Conductivity Coeff B)
Default: 0

The B coefficient for gas conductivity in W/(m-K2).

conductivity_coeff_c
number <double> (Conductivity Coeff C)
Default: 0

The C coefficient for gas conductivity in W/(m-K3).

viscosity_coeff_b
number <double> (Viscosity Coeff B)
Default: 0

The B coefficient for gas viscosity in kg/(m-s-K).

viscosity_coeff_c
number <double> (Viscosity Coeff C)
Default: 0

The C coefficient for gas viscosity in kg/(m-s-K2).

specific_heat_coeff_b
number <double> (Specific Heat Coeff B)
Default: 0

The B coefficient for gas specific heat in J/(kg-K2).

specific_heat_coeff_c
number <double> (Specific Heat Coeff C)
Default: 0

The C coefficient for gas specific heat in J/(kg-K3).

{
  • "type": "EnergyWindowMaterialGasCustom",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "conductivity_coeff_a": 0,
  • "viscosity_coeff_a": 0,
  • "specific_heat_coeff_a": 0,
  • "specific_heat_ratio": 2,
  • "molecular_weight": 20,
  • "thickness": 0.0125,
  • "conductivity_coeff_b": 0,
  • "conductivity_coeff_c": 0,
  • "viscosity_coeff_b": 0,
  • "viscosity_coeff_c": 0,
  • "specific_heat_coeff_b": 0,
  • "specific_heat_coeff_c": 0
}

EnergyWindowMaterialGasMixture

type
string (Type) ^EnergyWindowMaterialGasMixture$
Default: "EnergyWindowMaterialGasMixture"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

gas_types
required
Array of strings (GasType) [ 2 .. 4 ] items
Items Enum: "Air" "Argon" "Krypton" "Xenon"

List of gases in the gas mixture.

gas_fractions
required
Array of numbers <double> (Gas Fractions) [ 2 .. 4 ] items [ items <double > ( 0 .. 1 ) ]

A list of fractional numbers describing the volumetric fractions of gas types in the mixture. This list must align with the gas_types list and must sum to 1.

thickness
number <double> (Thickness) > 0
Default: 0.0125

The thickness of the gas mixture layer in meters.

{
  • "type": "EnergyWindowMaterialGasMixture",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "gas_types": [
    ],
  • "gas_fractions": [
    ],
  • "thickness": 0.0125
}

EnergyWindowMaterialGlazing

type
string (Type) ^EnergyWindowMaterialGlazing$
Default: "EnergyWindowMaterialGlazing"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

thickness
number <double> (Thickness) > 0
Default: 0.003

The surface-to-surface thickness of the glass in meters. Default: 0.003.

solar_transmittance
number <double> (Solar Transmittance) [ 0 .. 1 ]
Default: 0.85

Transmittance of solar radiation through the glass at normal incidence. Default: 0.85 for clear glass.

solar_reflectance
number <double> (Solar Reflectance) [ 0 .. 1 ]
Default: 0.075

Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default: 0.075 for clear glass.

Autocalculate (object) or Solar Reflectance Back (number) (Solar Reflectance Back)
Default: {"type":"Autocalculate"}

Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.

visible_transmittance
number <double> (Visible Transmittance) [ 0 .. 1 ]
Default: 0.9

Transmittance of visible light through the glass at normal incidence. Default: 0.9 for clear glass.

visible_reflectance
number <double> (Visible Reflectance) [ 0 .. 1 ]
Default: 0.075

Reflectance of visible light off of the front side of the glass at normal incidence. Default: 0.075 for clear glass.

Autocalculate (object) or Visible Reflectance Back (number) (Visible Reflectance Back)
Default: {"type":"Autocalculate"}

Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.

infrared_transmittance
number <double> (Infrared Transmittance) [ 0 .. 1 ]
Default: 0

Long-wave transmittance at normal incidence.

emissivity
number <double> (Emissivity) [ 0 .. 1 ]
Default: 0.84

Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default: 0.84, which is typical for clear glass without a low-e coating.

emissivity_back
number <double> (Emissivity Back) [ 0 .. 1 ]
Default: 0.84

Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default: 0.84, which is typical for clear glass without a low-e coating.

conductivity
number <double> (Conductivity) > 0
Default: 0.9

Thermal conductivity of the glass in W/(m-K). Default: 0.9, which is typical for clear glass without a low-e coating.

dirt_correction
number <double> (Dirt Correction)
Default: 1

Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.

solar_diffusing
boolean (Solar Diffusing)
Default: false

If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.

{
  • "type": "EnergyWindowMaterialGlazing",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "thickness": 0.003,
  • "solar_transmittance": 0.85,
  • "solar_reflectance": 0.075,
  • "solar_reflectance_back": {
    },
  • "visible_transmittance": 0.9,
  • "visible_reflectance": 0.075,
  • "visible_reflectance_back": {
    },
  • "infrared_transmittance": 0,
  • "emissivity": 0.84,
  • "emissivity_back": 0.84,
  • "conductivity": 0.9,
  • "dirt_correction": 1,
  • "solar_diffusing": false
}

EnergyWindowMaterialShade

type
string (Type) ^EnergyWindowMaterialShade$
Default: "EnergyWindowMaterialShade"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

solar_transmittance
number <double> (Solar Transmittance) [ 0 .. 1 )
Default: 0.4

The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default: 0.4.

solar_reflectance
number <double> (Solar Reflectance) [ 0 .. 1 )
Default: 0.5

The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5

visible_transmittance
number <double> (Visible Transmittance) [ 0 .. 1 )
Default: 0.4

The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default: 0.4.

visible_reflectance
number <double> (Visible Reflectance) [ 0 .. 1 )
Default: 0.4

The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default: 0.4

emissivity
number <double> (Emissivity) ( 0 .. 1 )
Default: 0.9

The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default: 0.9.

infrared_transmittance
number <double> (Infrared Transmittance) [ 0 .. 1 )
Default: 0

The effective long-wave transmittance. It is assumed independent of incidence angle. Default: 0.

thickness
number <double> (Thickness) > 0
Default: 0.005

The thickness of the shade material in meters. Default: 0.005.

conductivity
number <double> (Conductivity) > 0
Default: 0.1

The conductivity of the shade material in W/(m-K). Default value is 0.1.

distance_to_glass
number <double> (Distance To Glass) [ 0.001 .. 1 ]
Default: 0.05

The distance from shade to adjacent glass in meters. Default value is 0.05

top_opening_multiplier
number <double> (Top Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default: 0.5.

bottom_opening_multiplier
number <double> (Bottom Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default: 0.5.

left_opening_multiplier
number <double> (Left Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default: 0.5.

right_opening_multiplier
number <double> (Right Opening Multiplier) [ 0 .. 1 ]
Default: 0.5

The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default: 0.5.

airflow_permeability
number <double> (Airflow Permeability) [ 0 .. 0.8 ]
Default: 0

The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default: 0.

{
  • "type": "EnergyWindowMaterialShade",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "solar_transmittance": 0.4,
  • "solar_reflectance": 0.5,
  • "visible_transmittance": 0.4,
  • "visible_reflectance": 0.4,
  • "emissivity": 0.9,
  • "infrared_transmittance": 0,
  • "thickness": 0.005,
  • "conductivity": 0.1,
  • "distance_to_glass": 0.05,
  • "top_opening_multiplier": 0.5,
  • "bottom_opening_multiplier": 0.5,
  • "left_opening_multiplier": 0.5,
  • "right_opening_multiplier": 0.5,
  • "airflow_permeability": 0
}

EnergyWindowMaterialSimpleGlazSys

type
string (Type) ^EnergyWindowMaterialSimpleGlazSys$
Default: "EnergyWindowMaterialSimpleGlazSys"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

u_factor
required
number <double> (U Factor) ( 0 .. 12 ]

The overall heat transfer coefficient for window system in W/m2-K. Note that constructions with U-values above 5.8 should not be assigned to skylights as this implies the resistance of the window is negative when air films are subtracted.

shgc
required
number <double> (Shgc) ( 0 .. 1 )

Unit-less quantity for the Solar Heat Gain Coefficient (solar transmittance + conduction) at normal incidence and vertical orientation.

vt
number <double> (Vt) ( 0 .. 1 )
Default: 0.54

The fraction of visible light falling on the window that makes it through the glass at normal incidence.

{
  • "type": "EnergyWindowMaterialSimpleGlazSys",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "u_factor": 12,
  • "shgc": 0,
  • "vt": 0.54
}

EvaporativeCooler

type
string (Type) ^EvaporativeCooler$
Default: "EvaporativeCooler"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (EvaporativeCoolerEquipmentType)
Default: "EvapCoolers_ElectricBaseboard"
Enum: "EvapCoolers_ElectricBaseboard" "EvapCoolers_BoilerBaseboard" "EvapCoolers_ASHPBaseboard" "EvapCoolers_DHWBaseboard" "EvapCoolers_Furnace" "EvapCoolers_UnitHeaters" "EvapCoolers"

An enumeration.

{
  • "type": "EvaporativeCooler",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "EvapCoolers_ElectricBaseboard"
}

EvaporativeCoolerEquipmentType

string (EvaporativeCoolerEquipmentType)
Enum: "EvapCoolers_ElectricBaseboard" "EvapCoolers_BoilerBaseboard" "EvapCoolers_ASHPBaseboard" "EvapCoolers_DHWBaseboard" "EvapCoolers_Furnace" "EvapCoolers_UnitHeaters" "EvapCoolers"

An enumeration.

"EvapCoolers_ElectricBaseboard"

ExteriorApertureGridParameter

type
string (Type) ^ExteriorApertureGridParameter$
Default: "ExteriorApertureGridParameter"

A base class to use when there is no baseclass available to fall on.

dimension
required
number <double> (Dimension) > 0

The dimension of the grid cells as a number.

include_mesh
boolean (Include Mesh)
Default: true

A boolean to note whether the resulting SensorGrid should include the mesh.

offset
number <double> (Offset)
Default: 0.1

A number for how far to offset the grid from the Apertures. (Default: 0.1, suitable for Models in Meters).

aperture_type
string (ExteriorApertureType)
Default: "All"
Enum: "Window" "Skylight" "All"

An enumeration.

{
  • "type": "ExteriorApertureGridParameter",
  • "dimension": 0,
  • "include_mesh": true,
  • "offset": 0.1,
  • "aperture_type": "All"
}

ExteriorApertureType

string (ExteriorApertureType)
Enum: "Window" "Skylight" "All"

An enumeration.

"Window"

ExteriorFaceGridParameter

type
string (Type) ^ExteriorFaceGridParameter$
Default: "ExteriorFaceGridParameter"

A base class to use when there is no baseclass available to fall on.

dimension
required
number <double> (Dimension) > 0

The dimension of the grid cells as a number.

include_mesh
boolean (Include Mesh)
Default: true

A boolean to note whether the resulting SensorGrid should include the mesh.

offset
number <double> (Offset)
Default: 0.1

A number for how far to offset the grid from the Faces. (Default: 0.1, suitable for Models in Meters).

face_type
string (ExteriorFaceType)
Default: "Wall"
Enum: "Wall" "Roof" "Floor" "All"

An enumeration.

punched_geometry
boolean (Punched Geometry)
Default: false

A boolean to note whether the punched_geometry of the faces should be used (True) with the areas of sub-faces removed from the grid or the full geometry should be used (False).

{
  • "type": "ExteriorFaceGridParameter",
  • "dimension": 0,
  • "include_mesh": true,
  • "offset": 0.1,
  • "face_type": "Wall",
  • "punched_geometry": false
}

ExteriorFaceType

string (ExteriorFaceType)
Enum: "Wall" "Roof" "Floor" "All"

An enumeration.

"Wall"

ExtrudedBorder

type
string (Type) ^ExtrudedBorder$
Default: "ExtrudedBorder"

A base class to use when there is no baseclass available to fall on.

depth
required
number <double> (Depth) > 0

A number for the depth of the border.

{
  • "type": "ExtrudedBorder",
  • "depth": 0
}

Face3D

type
string (Type) ^Face3D$
Default: "Face3D"

A base class to use when there is no baseclass available to fall on.

boundary
required
Array of numbers (Boundary) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the outer boundary vertices of the face. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

holes
Array of numbers (Holes) [ items >= 3 items [ items <double > = 3 items [ items <double > ] ] ]

Optional list of lists with one list for each hole in the face.Each hole should be a list of at least 3 points and each point a list of 3 (x, y, z) values. If None, it will be assumed that there are no holes in the face.

plane
object (Plane) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "Face3D",
  • "boundary": [
    ],
  • "holes": [
    ],
  • "plane": {
    }
}

Face

type
string (Type) ^Face$
Default: "Face"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

A single planar face in 3D space.

face_type
required
string (FaceType)
Enum: "Wall" "Floor" "RoofCeiling" "AirBoundary"

An enumeration.

required
Ground (object) or Outdoors (object) or Adiabatic (object) or Surface (object) or OtherSideTemperature (object) (Boundary Condition)
properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Array of objects (Apertures)

Apertures assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.

Array of objects (Doors)

Doors assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object.

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. balcony, overhang).

{
  • "type": "Face",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "face_type": "Wall",
  • "boundary_condition": {
    },
  • "properties": {
    },
  • "apertures": [
    ],
  • "doors": [
    ],
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ]
}

FaceEnergyPropertiesAbridged

type
string (Type) ^FaceEnergyPropertiesAbridged$
Default: "FaceEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of an OpaqueConstruction for the Face. If None, the construction is set by the parent Room construction_set or the Model global_construction_set.

vent_crack
object (Vent Crack) Recursive

Properties for airflow through a crack.

{
  • "type": "FaceEnergyPropertiesAbridged",
  • "construction": "string",
  • "vent_crack": {
    }
}

FacePropertiesAbridged

type
string (Type) ^FacePropertiesAbridged$
Default: "FacePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (FaceEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (FaceRadiancePropertiesAbridged) Recursive

Base class of Abridged Radiance Properties.

{
  • "type": "FacePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

FaceRadiancePropertiesAbridged

type
string (Type) ^FaceRadiancePropertiesAbridged$
Default: "FaceRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "FaceRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string"
}

FaceType

string (FaceType)
Enum: "Wall" "Floor" "RoofCeiling" "AirBoundary"

An enumeration.

"Wall"

FCU

type
string (Type) ^FCU$
Default: "FCU"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (FCUEquipmentType)
Default: "FCU_Chiller_Boiler"
Enum: "FCU_Chiller_Boiler" "FCU_Chiller_ASHP" "FCU_Chiller_DHW" "FCU_Chiller_ElectricBaseboard" "FCU_Chiller_GasHeaters" "FCU_Chiller" "FCU_ACChiller_Boiler" "FCU_ACChiller_ASHP" "FCU_ACChiller_DHW" "FCU_ACChiller_ElectricBaseboard" "FCU_ACChiller_GasHeaters" "FCU_ACChiller" "FCU_DCW_Boiler" "FCU_DCW_ASHP" "FCU_DCW_DHW" "FCU_DCW_ElectricBaseboard" "FCU_DCW_GasHeaters" "FCU_DCW"

An enumeration.

{
  • "type": "FCU",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "FCU_Chiller_Boiler"
}

FCUEquipmentType

string (FCUEquipmentType)
Enum: "FCU_Chiller_Boiler" "FCU_Chiller_ASHP" "FCU_Chiller_DHW" "FCU_Chiller_ElectricBaseboard" "FCU_Chiller_GasHeaters" "FCU_Chiller" "FCU_ACChiller_Boiler" "FCU_ACChiller_ASHP" "FCU_ACChiller_DHW" "FCU_ACChiller_ElectricBaseboard" "FCU_ACChiller_GasHeaters" "FCU_ACChiller" "FCU_DCW_Boiler" "FCU_DCW_ASHP" "FCU_DCW_DHW" "FCU_DCW_ElectricBaseboard" "FCU_DCW_GasHeaters" "FCU_DCW"

An enumeration.

"FCU_Chiller_Boiler"

FCUwithDOASAbridged

type
string (Type) ^FCUwithDOASAbridged$
Default: "FCUwithDOASAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

doas_availability_schedule
string (Doas Availability Schedule) [ 1 .. 100 ] characters

An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.

equipment_type
string (FCUwithDOASEquipmentType)
Default: "DOAS_FCU_Chiller_Boiler"
Enum: "DOAS_FCU_Chiller_Boiler" "DOAS_FCU_Chiller_ASHP" "DOAS_FCU_Chiller_DHW" "DOAS_FCU_Chiller_ElectricBaseboard" "DOAS_FCU_Chiller_GasHeaters" "DOAS_FCU_Chiller" "DOAS_FCU_ACChiller_Boiler" "DOAS_FCU_ACChiller_ASHP" "DOAS_FCU_ACChiller_DHW" "DOAS_FCU_ACChiller_ElectricBaseboard" "DOAS_FCU_ACChiller_GasHeaters" "DOAS_FCU_ACChiller" "DOAS_FCU_DCW_Boiler" "DOAS_FCU_DCW_ASHP" "DOAS_FCU_DCW_DHW" "DOAS_FCU_DCW_ElectricBaseboard" "DOAS_FCU_DCW_GasHeaters" "DOAS_FCU_DCW"

An enumeration.

{
  • "type": "FCUwithDOASAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "doas_availability_schedule": "string",
  • "equipment_type": "DOAS_FCU_Chiller_Boiler"
}

FCUwithDOASEquipmentType

string (FCUwithDOASEquipmentType)
Enum: "DOAS_FCU_Chiller_Boiler" "DOAS_FCU_Chiller_ASHP" "DOAS_FCU_Chiller_DHW" "DOAS_FCU_Chiller_ElectricBaseboard" "DOAS_FCU_Chiller_GasHeaters" "DOAS_FCU_Chiller" "DOAS_FCU_ACChiller_Boiler" "DOAS_FCU_ACChiller_ASHP" "DOAS_FCU_ACChiller_DHW" "DOAS_FCU_ACChiller_ElectricBaseboard" "DOAS_FCU_ACChiller_GasHeaters" "DOAS_FCU_ACChiller" "DOAS_FCU_DCW_Boiler" "DOAS_FCU_DCW_ASHP" "DOAS_FCU_DCW_DHW" "DOAS_FCU_DCW_ElectricBaseboard" "DOAS_FCU_DCW_GasHeaters" "DOAS_FCU_DCW"

An enumeration.

"DOAS_FCU_Chiller_Boiler"

FloorConstructionSet

type
string (Type) ^FloorConstructionSet$
Default: "FloorConstructionSet"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

exterior_construction
object (Exterior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ground_construction
object (Ground Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "FloorConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

FloorConstructionSetAbridged

type
string (Type) ^FloorConstructionSetAbridged$
Default: "FloorConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "FloorConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

FloorModifierSet

type
string (Type) ^FloorModifierSet$
Default: "FloorModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "FloorModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

FloorModifierSetAbridged

type
string (Type) ^FloorModifierSetAbridged$
Default: "FloorModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "FloorModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

ForcedAirFurnace

type
string (Type) ^ForcedAirFurnace$
Default: "ForcedAirFurnace"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (FurnaceEquipmentType)
Default: "Furnace"
Enum: "Furnace" "Furnace_Electric"

An enumeration.

{
  • "type": "ForcedAirFurnace",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "Furnace"
}

FuelTypes

string (FuelTypes)
Enum: "Electricity" "NaturalGas" "Propane" "FuelOilNo1" "FuelOilNo2" "Diesel" "Gasoline" "Coal" "Steam" "DistrictHeating" "DistrictCooling" "OtherFuel1" "OtherFuel2" "None"

Designates the acceptable fuel types for process loads.

"Electricity"

FurnaceEquipmentType

string (FurnaceEquipmentType)
Enum: "Furnace" "Furnace_Electric"

An enumeration.

"Furnace"

GasEquipment

type
string (Type) ^GasEquipment$
Default: "GasEquipment"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by equipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "GasEquipment",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

GasEquipmentAbridged

type
string (Type) ^GasEquipmentAbridged$
Default: "GasEquipmentAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Equipment level per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of equipment over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by equipment. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by equipment. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by equipment. The default value is 0.

{
  • "type": "GasEquipmentAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

GasType

string (GasType)
Enum: "Air" "Argon" "Krypton" "Xenon"

An enumeration.

"Air"

GasUnitHeater

type
string (Type) ^GasUnitHeater$
Default: "GasUnitHeater"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (GasUnitHeaterEquipmentType)
Default: "GasHeaters"
Value: "GasHeaters"

An enumeration.

{
  • "type": "GasUnitHeater",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "GasHeaters"
}

GasUnitHeaterEquipmentType

string (GasUnitHeaterEquipmentType)
Value: "GasHeaters"

An enumeration.

"GasHeaters"

Glass

type
string (Type) ^Glass$
Default: "Glass"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_transmissivity
number <double> (R Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel transmissivity.

g_transmissivity
number <double> (G Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel transmissivity.

b_transmissivity
number <double> (B Transmissivity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel transmissivity.

refraction_index
number <double> (Refraction Index) > 1
Default: 1.52

A value greater than 1 for the index of refraction. Typical values are 1.52 for float glass and 1.4 for ETFE.

{
  • "type": "Glass",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_transmissivity": 0,
  • "g_transmissivity": 0,
  • "b_transmissivity": 0,
  • "refraction_index": 1.52
}

GlobalConstructionSet

type
string (Type) ^GlobalConstructionSet$
Default: "GlobalConstructionSet"

A base class to use when there is no baseclass available to fall on.

Array of EnergyMaterial (object) or EnergyMaterialNoMass (object) or EnergyWindowMaterialGlazing (object) or EnergyWindowMaterialGas (object) (Materials)
Default: [{"identifier":"Generic Roof Membrane","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.01,"conductivity":0.16,"density":1120,"specific_heat":1460,"thermal_absorptance":0.9,"solar_absorptance":0.65,"visible_absorptance":0.65},{"identifier":"Generic Acoustic Tile","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.02,"conductivity":0.06,"density":368,"specific_heat":590,"thermal_absorptance":0.9,"solar_absorptance":0.2,"visible_absorptance":0.2},{"identifier":"Generic 25mm Wood","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.0254,"conductivity":0.15,"density":608,"specific_heat":1630,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic HW Concrete","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.2,"conductivity":1.95,"density":2240,"specific_heat":900,"thermal_absorptance":0.9,"solar_absorptance":0.8,"visible_absorptance":0.8},{"identifier":"Generic Window Air Gap","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGas","thickness":0.0127,"gas_type":"Air"},{"identifier":"Generic Gypsum Board","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.0127,"conductivity":0.16,"density":800,"specific_heat":1090,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic Wall Air Gap","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.1,"conductivity":0.667,"density":1.28,"specific_heat":1000,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Ceiling Air Gap","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.1,"conductivity":0.556,"density":1.28,"specific_heat":1000,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Brick","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.1,"conductivity":0.9,"density":1920,"specific_heat":790,"thermal_absorptance":0.9,"solar_absorptance":0.65,"visible_absorptance":0.65},{"identifier":"Generic 50mm Insulation","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.05,"conductivity":0.03,"density":43,"specific_heat":1210,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Low-e Glass","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGlazing","thickness":0.006,"solar_transmittance":0.45,"solar_reflectance":0.36,"solar_reflectance_back":0.36,"visible_transmittance":0.71,"visible_reflectance":0.21,"visible_reflectance_back":0.21,"infrared_transmittance":0,"emissivity":0.84,"emissivity_back":0.047,"conductivity":1,"dirt_correction":1,"solar_diffusing":false},{"identifier":"Generic Painted Metal","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.0015,"conductivity":45,"density":7690,"specific_heat":410,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic LW Concrete","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.1,"conductivity":0.53,"density":1280,"specific_heat":840,"thermal_absorptance":0.9,"solar_absorptance":0.8,"visible_absorptance":0.8},{"identifier":"Generic 25mm Insulation","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.025,"conductivity":0.03,"density":43,"specific_heat":1210,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Clear Glass","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGlazing","thickness":0.006,"solar_transmittance":0.77,"solar_reflectance":0.07,"solar_reflectance_back":0.07,"visible_transmittance":0.88,"visible_reflectance":0.08,"visible_reflectance_back":0.08,"infrared_transmittance":0,"emissivity":0.84,"emissivity_back":0.84,"conductivity":1,"dirt_correction":1,"solar_diffusing":false}]

Global Honeybee Energy materials.

Array of OpaqueConstructionAbridged (object) or WindowConstructionAbridged (object) or ShadeConstruction (object) or AirBoundaryConstructionAbridged (object) (Constructions)
Default: [{"identifier":"Generic Interior Door","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 25mm Wood"]},{"identifier":"Generic Single Pane","display_name":null,"user_data":null,"type":"WindowConstructionAbridged","materials":["Generic Clear Glass"],"frame":null},{"identifier":"Generic Shade","display_name":null,"user_data":null,"type":"ShadeConstruction","solar_reflectance":0.35,"visible_reflectance":0.35,"is_specular":false},{"identifier":"Generic Context","display_name":null,"user_data":null,"type":"ShadeConstruction","solar_reflectance":0.2,"visible_reflectance":0.2,"is_specular":false},{"identifier":"Generic Interior Ceiling","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic LW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Interior Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Gypsum Board","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Exposed Floor","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Painted Metal","Generic Ceiling Air Gap","Generic 50mm Insulation","Generic LW Concrete"]},{"identifier":"Generic Interior Floor","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Acoustic Tile","Generic Ceiling Air Gap","Generic LW Concrete"]},{"identifier":"Generic Ground Slab","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete"]},{"identifier":"Generic Roof","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Roof Membrane","Generic 50mm Insulation","Generic LW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Exterior Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Brick","Generic LW Concrete","Generic 50mm Insulation","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Underground Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Air Boundary","display_name":null,"user_data":null,"type":"AirBoundaryConstructionAbridged","air_mixing_per_area":0.1,"air_mixing_schedule":"Always On"},{"identifier":"Generic Underground Roof","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Double Pane","display_name":null,"user_data":null,"type":"WindowConstructionAbridged","materials":["Generic Low-e Glass","Generic Window Air Gap","Generic Clear Glass"],"frame":null},{"identifier":"Generic Exterior Door","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Painted Metal","Generic 25mm Insulation","Generic Painted Metal"]}]

Global Honeybee Energy constructions.

wall_set
object (Wall Set) Recursive
Default: {"interior_construction":"Generic Interior Wall","exterior_construction":"Generic Exterior Wall","ground_construction":"Generic Underground Wall","type":"WallConstructionSetAbridged"}

A set of constructions for wall, floor, or roof assemblies.

floor_set
object (Floor Set) Recursive
Default: {"interior_construction":"Generic Interior Floor","exterior_construction":"Generic Exposed Floor","ground_construction":"Generic Ground Slab","type":"FloorConstructionSetAbridged"}

A set of constructions for wall, floor, or roof assemblies.

roof_ceiling_set
object (Roof Ceiling Set) Recursive
Default: {"interior_construction":"Generic Interior Ceiling","exterior_construction":"Generic Roof","ground_construction":"Generic Underground Roof","type":"RoofCeilingConstructionSetAbridged"}

A set of constructions for wall, floor, or roof assemblies.

aperture_set
object (Aperture Set) Recursive
Default: {"type":"ApertureConstructionSetAbridged","interior_construction":"Generic Single Pane","window_construction":"Generic Double Pane","skylight_construction":"Generic Double Pane","operable_construction":"Generic Double Pane"}

A set of constructions for aperture assemblies.

door_set
object (Door Set) Recursive
Default: {"type":"DoorConstructionSetAbridged","interior_construction":"Generic Interior Door","exterior_construction":"Generic Exterior Door","overhead_construction":"Generic Exterior Door","exterior_glass_construction":"Generic Double Pane","interior_glass_construction":"Generic Single Pane"}

A set of constructions for door assemblies.

shade_construction
string (Shade Construction)
Default: "Generic Shade"

Global Honeybee Construction for building-attached Shades.

context_construction
string (Context Construction)
Default: "Generic Context"

Global Honeybee Construction for context Shades.

air_boundary_construction
string (Air Boundary Construction)
Default: "Generic Air Boundary"

Global Honeybee Construction for AirBoundary Faces.

{
  • "type": "GlobalConstructionSet",
  • "materials": [
    ],
  • "constructions": [
    ],
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_construction": "Generic Shade",
  • "context_construction": "Generic Context",
  • "air_boundary_construction": "Generic Air Boundary"
}

GlobalModifierSet

type
string (Type) ^GlobalModifierSet$
Default: "GlobalModifierSet"

A base class to use when there is no baseclass available to fall on.

Array of Plastic (object) or Glass (object) or Trans (object) (Modifiers)
Default: [{"identifier":"generic_floor_0.20","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.2,"g_reflectance":0.2,"b_reflectance":0.2,"specularity":0,"roughness":0},{"identifier":"generic_wall_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_ceiling_0.80","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.8,"g_reflectance":0.8,"b_reflectance":0.8,"specularity":0,"roughness":0},{"identifier":"generic_opaque_door_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_interior_shade_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_exterior_shade_0.35","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.35,"g_reflectance":0.35,"b_reflectance":0.35,"specularity":0,"roughness":0},{"identifier":"generic_context_0.20","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.2,"g_reflectance":0.2,"b_reflectance":0.2,"specularity":0,"roughness":0},{"identifier":"generic_interior_window_vis_0.88","display_name":null,"type":"Glass","modifier":null,"dependencies":[],"r_transmissivity":0.9584154328610596,"g_transmissivity":0.9584154328610596,"b_transmissivity":0.9584154328610596,"refraction_index":null},{"identifier":"generic_exterior_window_vis_0.64","display_name":null,"type":"Glass","modifier":null,"dependencies":[],"r_transmissivity":0.6975761815384331,"g_transmissivity":0.6975761815384331,"b_transmissivity":0.6975761815384331,"refraction_index":null},{"identifier":"air_boundary","display_name":null,"type":"Trans","modifier":null,"dependencies":[],"r_reflectance":1,"g_reflectance":1,"b_reflectance":1,"specularity":0,"roughness":0,"transmitted_diff":1,"transmitted_spec":1}]

Global Honeybee Radiance modifiers.

wall_set
object (Wall Set) Recursive
Default: {"exterior_modifier":"generic_wall_0.50","interior_modifier":"generic_wall_0.50","type":"WallModifierSetAbridged"}

Base class for the abridged modifier sets assigned to Faces.

floor_set
object (Floor Set) Recursive
Default: {"exterior_modifier":"generic_floor_0.20","interior_modifier":"generic_floor_0.20","type":"FloorModifierSetAbridged"}

Base class for the abridged modifier sets assigned to Faces.

roof_ceiling_set
object (Roof Ceiling Set) Recursive
Default: {"exterior_modifier":"generic_ceiling_0.80","interior_modifier":"generic_ceiling_0.80","type":"RoofCeilingModifierSetAbridged"}

Base class for the abridged modifier sets assigned to Faces.

aperture_set
object (Aperture Set) Recursive
Default: {"type":"ApertureModifierSetAbridged","window_modifier":"generic_exterior_window_vis_0.64","interior_modifier":"generic_interior_window_vis_0.88","skylight_modifier":"generic_exterior_window_vis_0.64","operable_modifier":"generic_exterior_window_vis_0.64"}

Abridged set containing radiance modifiers needed for a model's Apertures.

door_set
object (Door Set) Recursive
Default: {"exterior_modifier":"generic_opaque_door_0.50","interior_modifier":"generic_opaque_door_0.50","type":"DoorModifierSetAbridged","interior_glass_modifier":"generic_interior_window_vis_0.88","exterior_glass_modifier":"generic_exterior_window_vis_0.64","overhead_modifier":"generic_opaque_door_0.50"}

Base class for the abridged modifier sets assigned to Faces.

shade_set
object (Shade Set) Recursive
Default: {"exterior_modifier":"generic_exterior_shade_0.35","interior_modifier":"generic_interior_shade_0.50","type":"ShadeModifierSetAbridged"}

Base class for the abridged modifier sets assigned to Faces.

air_boundary_modifier
string (Air Boundary Modifier)
Default: "air_boundary"

Global Honeybee Modifier for AirBoundary Faces.

context_modifier
string (Context Modifier)
Default: "generic_context_0.20"

Global Honeybee Modifier for context Shades.

{
  • "type": "GlobalModifierSet",
  • "modifiers": [
    ],
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_set": {
    },
  • "air_boundary_modifier": "air_boundary",
  • "context_modifier": "generic_context_0.20"
}

Glow

type
string (Type) ^Glow$
Default: "Glow"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_emittance
number <double> (R Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel of the modifier.

g_emittance
number <double> (G Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel of the modifier.

b_emittance
number <double> (B Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel of the modifier.

max_radius
number <double> (Max Radius)
Default: 0

Maximum radius for shadow testing. Objects with zero radius are permissable and may participate in interreflection calculation (though they are not representative of real light sources). Negative values will never contribute to scene illumination.

{
  • "type": "Glow",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_emittance": 0,
  • "g_emittance": 0,
  • "b_emittance": 0,
  • "max_radius": 0
}

GriddedSkylightArea

type
string (Type) ^GriddedSkylightArea$
Default: "GriddedSkylightArea"

A base class to use when there is no baseclass available to fall on.

skylight_area
required
number <double> (Skylight Area) > 0

A number for the skylight area in current model units. If this area is larger than the area of the roof that it is applied to, the skylight will fill the parent roof at a 99 percent ratio.

Autocalculate (object) or Spacing (number) (Spacing)
Default: {"type":"Autocalculate"}

A number for the spacing between the centers of each grid cell. This should be less than a third of the dimension of the Roof geometry if multiple, evenly-spaced skylights are desired. If Autocalculate, a spacing of one third the smaller dimension of the parent Roof will be automatically assumed.

{
  • "type": "GriddedSkylightArea",
  • "skylight_area": 0,
  • "spacing": {
    }
}

GriddedSkylightRatio

type
string (Type) ^GriddedSkylightRatio$
Default: "GriddedSkylightRatio"

A base class to use when there is no baseclass available to fall on.

skylight_ratio
required
number <double> (Skylight Ratio) ( 0 .. 1 )

A number between 0 and 1 for the ratio between the skylight area and the total Roof face area.

Autocalculate (object) or Spacing (number) (Spacing)
Default: {"type":"Autocalculate"}

A number for the spacing between the centers of each grid cell. This should be less than a third of the dimension of the Roof geometry if multiple, evenly-spaced skylights are desired. If Autocalculate, a spacing of one third the smaller dimension of the parent Roof will be automatically assumed.

{
  • "type": "GriddedSkylightRatio",
  • "skylight_ratio": 0,
  • "spacing": {
    }
}

Ground

type
string (Type) ^Ground$
Default: "Ground"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Ground"
}

IDdBaseModel

type
string (Type) ^IDdBaseModel$
Default: "IDdBaseModel"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "IDdBaseModel",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { }
}

IDdEnergyBaseModel

type
string (Type) ^IDdEnergyBaseModel$
Default: "IDdEnergyBaseModel"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

{
  • "type": "IDdEnergyBaseModel",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { }
}

IDdRadianceBaseModel

type
string (Type) ^IDdRadianceBaseModel$
Default: "IDdRadianceBaseModel"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "IDdRadianceBaseModel",
  • "identifier": "string",
  • "display_name": "string"
}

IdealAirSystemAbridged

type
string (Type) ^IdealAirSystemAbridged$
Default: "IdealAirSystemAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

economizer_type
string (EconomizerType)
Default: "DifferentialDryBulb"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

An enumeration.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the zone.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

heating_air_temperature
number <double> (Heating Air Temperature) ( 0 .. 100 )
Default: 50

A number for the maximum heating supply air temperature [C].

cooling_air_temperature
number <double> (Cooling Air Temperature) ( -100 .. 50 )
Default: 13

A number for the minimum cooling supply air temperature [C].

Autosize (object) or NoLimit (object) or Heating Limit (number) (Heating Limit)
Default: {"type":"Autosize"}

A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the heating capacity.

Autosize (object) or NoLimit (object) or Cooling Limit (number) (Cooling Limit)
Default: {"type":"Autosize"}

A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the cooling capacity.

heating_availability
string (Heating Availability) [ 1 .. 100 ] characters

An optional identifier of a schedule to set the availability of heating over the course of the simulation.

cooling_availability
string (Cooling Availability) [ 1 .. 100 ] characters

An optional identifier of a schedule to set the availability of cooling over the course of the simulation.

{
  • "type": "IdealAirSystemAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "economizer_type": "DifferentialDryBulb",
  • "demand_controlled_ventilation": false,
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "heating_air_temperature": 50,
  • "cooling_air_temperature": 13,
  • "heating_limit": {
    },
  • "cooling_limit": {
    },
  • "heating_availability": "string",
  • "cooling_availability": "string"
}

Infiltration

type
string (Type) ^Infiltration$
Default: "Infiltration"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_exterior_area
required
number <double> (Flow Per Exterior Area) >= 0

Number for the infiltration per exterior surface area in m3/s-m2.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.

constant_coefficient
number <double> (Constant Coefficient) >= 0
Default: 1
temperature_coefficient
number <double> (Temperature Coefficient) >= 0
Default: 0
velocity_coefficient
number <double> (Velocity Coefficient) >= 0
Default: 0
{
  • "type": "Infiltration",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_exterior_area": 0,
  • "schedule": {
    },
  • "constant_coefficient": 1,
  • "temperature_coefficient": 0,
  • "velocity_coefficient": 0
}

InfiltrationAbridged

type
string (Type) ^InfiltrationAbridged$
Default: "InfiltrationAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_exterior_area
required
number <double> (Flow Per Exterior Area) >= 0

Number for the infiltration per exterior surface area in m3/s-m2.

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the infiltration over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.

constant_coefficient
number <double> (Constant Coefficient) >= 0
Default: 1
temperature_coefficient
number <double> (Temperature Coefficient) >= 0
Default: 0
velocity_coefficient
number <double> (Velocity Coefficient) >= 0
Default: 0
{
  • "type": "InfiltrationAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_exterior_area": 0,
  • "schedule": "string",
  • "constant_coefficient": 1,
  • "temperature_coefficient": 0,
  • "velocity_coefficient": 0
}

InternalMassAbridged

type
string (Type) ^InternalMassAbridged$
Default: "InternalMassAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

construction
required
string (Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction that represents the material that the internal thermal mass is composed of.

area
required
number <double> (Area) > 0

A number representing the surface area of the internal mass that is exposed to the Room air. This value should always be in square meters regardless of what units system the parent model is a part of.

{
  • "type": "InternalMassAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "construction": "string",
  • "area": 0
}

Light

type
string (Type) ^Light$
Default: "Light"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_emittance
number <double> (R Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel of the modifier.

g_emittance
number <double> (G Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel of the modifier.

b_emittance
number <double> (B Emittance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel of the modifier.

{
  • "type": "Light",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_emittance": 0,
  • "g_emittance": 0,
  • "b_emittance": 0
}

Lighting

type
string (Type) ^Lighting$
Default: "Lighting"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Lighting per floor area as [W/m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile.

visible_fraction
number <double> (Visible Fraction) [ 0 .. 1 ]
Default: 0.25

The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. (Default: 0.25).

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.32

The fraction of heat from lights that is long-wave radiation. (Default: 0.32).

return_air_fraction
number <double> (Return Air Fraction) [ 0 .. 1 ]
Default: 0

The fraction of the heat from lights that goes into the zone return air. (Default: 0).

baseline_watts_per_area
number <double> (Baseline Watts Per Area) >= 0
Default: 11.84029

The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.

{
  • "type": "Lighting",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": {
    },
  • "visible_fraction": 0.25,
  • "radiant_fraction": 0.32,
  • "return_air_fraction": 0,
  • "baseline_watts_per_area": 11.84029
}

LightingAbridged

type
string (Type) ^LightingAbridged$
Default: "LightingAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts_per_area
required
number <double> (Watts Per Area) >= 0

Lighting per floor area as [W/m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of lights over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts_per_area to yield a complete lighting profile.

visible_fraction
number <double> (Visible Fraction) [ 0 .. 1 ]
Default: 0.25

The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. (Default: 0.25).

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.32

The fraction of heat from lights that is long-wave radiation. (Default: 0.32).

return_air_fraction
number <double> (Return Air Fraction) [ 0 .. 1 ]
Default: 0

The fraction of the heat from lights that goes into the zone return air. (Default: 0).

baseline_watts_per_area
number <double> (Baseline Watts Per Area) >= 0
Default: 11.84029

The baseline lighting power density in [W/m2] of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.

{
  • "type": "LightingAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts_per_area": 0,
  • "schedule": "string",
  • "visible_fraction": 0.25,
  • "radiant_fraction": 0.32,
  • "return_air_fraction": 0,
  • "baseline_watts_per_area": 11.84029
}

LouversByCount

type
string (Type) ^LouversByCount$
Default: "LouversByCount"

A base class to use when there is no baseclass available to fall on.

depth
required
number <double> (Depth) > 0

A number for the depth to extrude the louvers.

offset
number <double> (Offset) >= 0
Default: 0

A number for the distance to louvers from the wall.

angle
number <double> (Angle) [ -90 .. 90 ]
Default: 0

A number between -90 and 90 for the for an angle to rotate the louvers in degrees. 0 indicates louvers perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation.

contour_vector
Array of numbers <double> (Contour Vector) = 2 items [ items <double > ]
Default: [0,1]

A list of two float values representing the (x, y) of a 2D vector for the direction along which contours are generated. (0, 1) will generate horizontal contours, (1, 0) will generate vertical contours, and (1, 1) will generate diagonal contours.

flip_start_side
boolean (Flip Start Side)
Default: false

Boolean to note whether the side the louvers start from should be flipped. Default is False to have contours on top or right. Setting to True will start contours on the bottom or left.

louver_count
required
integer <int32> (Louver Count) > 0

A positive integer for the number of louvers to generate.

{
  • "type": "LouversByCount",
  • "depth": 0,
  • "offset": 0,
  • "angle": 0,
  • "contour_vector": [
    ],
  • "flip_start_side": false,
  • "louver_count": 0
}

LouversByDistance

type
string (Type) ^LouversByDistance$
Default: "LouversByDistance"

A base class to use when there is no baseclass available to fall on.

depth
required
number <double> (Depth) > 0

A number for the depth to extrude the louvers.

offset
number <double> (Offset) >= 0
Default: 0

A number for the distance to louvers from the wall.

angle
number <double> (Angle) [ -90 .. 90 ]
Default: 0

A number between -90 and 90 for the for an angle to rotate the louvers in degrees. 0 indicates louvers perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation.

contour_vector
Array of numbers <double> (Contour Vector) = 2 items [ items <double > ]
Default: [0,1]

A list of two float values representing the (x, y) of a 2D vector for the direction along which contours are generated. (0, 1) will generate horizontal contours, (1, 0) will generate vertical contours, and (1, 1) will generate diagonal contours.

flip_start_side
boolean (Flip Start Side)
Default: false

Boolean to note whether the side the louvers start from should be flipped. Default is False to have contours on top or right. Setting to True will start contours on the bottom or left.

distance
required
number <double> (Distance) > 0

A number for the approximate distance between each louver.

{
  • "type": "LouversByDistance",
  • "depth": 0,
  • "offset": 0,
  • "angle": 0,
  • "contour_vector": [
    ],
  • "flip_start_side": false,
  • "distance": 0
}

Mesh3D

type
string (Type) ^Mesh3D$
Default: "Mesh3D"

A base class to use when there is no baseclass available to fall on.

vertices
required
Array of numbers (Vertices) >= 3 items [ items <double > = 3 items [ items <double > ] ]

A list of points representing the vertices of the mesh. The list should include at least 3 points and each point should be a list of 3 (x, y, z) values.

faces
required
Array of integers (Faces) non-empty [ items <int32 > [ 3 .. 4 ] items [ items <int32 > >= 0 ] ]

A list of lists with each sub-list having either 3 or 4 integers. These integers correspond to indices within the list of vertices.

Array of objects (Colors)

An optional list of colors that correspond to either the faces of the mesh or the vertices of the mesh.

{
  • "type": "Mesh3D",
  • "vertices": [
    ],
  • "faces": [
    ],
  • "colors": [
    ]
}

Metal

type
string (Type) ^Metal$
Default: "Metal"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance.

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance.

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance.

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0.9

A value between 0 and 1 for the fraction of specularity. Specularity fractions lower than 0.9 are not realistic for metallic materials.

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the RMS slope of surface facets. Roughness greater than 0.2 are not realistic.

{
  • "type": "Metal",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0.9,
  • "roughness": 0
}

Mirror

type
string (Type) ^Mirror$
Default: "Mirror"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the red channel reflectance.

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the green channel reflectance.

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 1

A value between 0 and 1 for the blue channel reflectance.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Alternate Material)

An optional material (like the illum type) that may be used to specify a different material to be used for shading non-source rays. If None, this will keep the alternat_material as mirror. If this alternate material is given as Void, then the mirror surface will be invisible. Using Void is only appropriate if the surface hides other (more detailed) geometry with the same overall reflectance.

{
  • "type": "Mirror",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 1,
  • "g_reflectance": 1,
  • "b_reflectance": 1,
  • "alternate_material": {
    }
}

Model

type
string (Type) ^Model$
Default: "Model"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

version
string (Version) ([0-9]+)\.([0-9]+)\.([0-9]+)
Default: "0.0.0"

Text string for the current version of the schema.

Array of objects (Buildings)

A list of Buildings in the model.

Array of objects (Context Shades)

A list of ContextShades in the model.

units
string (Units)
Default: "Meters"
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

An enumeration.

tolerance
number <double> (Tolerance) >= 0
Default: 0.01

The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and is used in a variety of checks and operations. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.

angle_tolerance
number <double> (Angle Tolerance) >= 0
Default: 1

The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks and operations that can be performed on geometry. A value of 0 will result in no checks and an inability to perform certain operations so it is recommended that this always be a positive number when checks have not already been performed on a given Model.

{
  • "type": "Model",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "properties": {
    },
  • "version": "0.0.0",
  • "buildings": [
    ],
  • "context_shades": [
    ],
  • "units": "Meters",
  • "tolerance": 0.01,
  • "angle_tolerance": 1
}

ModelEnergyProperties

type
string (Type) ^ModelEnergyProperties$
Default: "ModelEnergyProperties"

A base class to use when there is no baseclass available to fall on.

global_construction_set
object (Global Construction Set) Recursive
Default: {"type":"GlobalConstructionSet","materials":[{"identifier":"Generic Roof Membrane","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.01,"conductivity":0.16,"density":1120,"specific_heat":1460,"thermal_absorptance":0.9,"solar_absorptance":0.65,"visible_absorptance":0.65},{"identifier":"Generic Acoustic Tile","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.02,"conductivity":0.06,"density":368,"specific_heat":590,"thermal_absorptance":0.9,"solar_absorptance":0.2,"visible_absorptance":0.2},{"identifier":"Generic 25mm Wood","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.0254,"conductivity":0.15,"density":608,"specific_heat":1630,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic HW Concrete","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.2,"conductivity":1.95,"density":2240,"specific_heat":900,"thermal_absorptance":0.9,"solar_absorptance":0.8,"visible_absorptance":0.8},{"identifier":"Generic Window Air Gap","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGas","thickness":0.0127,"gas_type":"Air"},{"identifier":"Generic Gypsum Board","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumSmooth","thickness":0.0127,"conductivity":0.16,"density":800,"specific_heat":1090,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic Wall Air Gap","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.1,"conductivity":0.667,"density":1.28,"specific_heat":1000,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Ceiling Air Gap","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.1,"conductivity":0.556,"density":1.28,"specific_heat":1000,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Brick","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.1,"conductivity":0.9,"density":1920,"specific_heat":790,"thermal_absorptance":0.9,"solar_absorptance":0.65,"visible_absorptance":0.65},{"identifier":"Generic 50mm Insulation","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.05,"conductivity":0.03,"density":43,"specific_heat":1210,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Low-e Glass","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGlazing","thickness":0.006,"solar_transmittance":0.45,"solar_reflectance":0.36,"solar_reflectance_back":0.36,"visible_transmittance":0.71,"visible_reflectance":0.21,"visible_reflectance_back":0.21,"infrared_transmittance":0,"emissivity":0.84,"emissivity_back":0.047,"conductivity":1,"dirt_correction":1,"solar_diffusing":false},{"identifier":"Generic Painted Metal","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"Smooth","thickness":0.0015,"conductivity":45,"density":7690,"specific_heat":410,"thermal_absorptance":0.9,"solar_absorptance":0.5,"visible_absorptance":0.5},{"identifier":"Generic LW Concrete","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.1,"conductivity":0.53,"density":1280,"specific_heat":840,"thermal_absorptance":0.9,"solar_absorptance":0.8,"visible_absorptance":0.8},{"identifier":"Generic 25mm Insulation","display_name":null,"user_data":null,"type":"EnergyMaterial","roughness":"MediumRough","thickness":0.025,"conductivity":0.03,"density":43,"specific_heat":1210,"thermal_absorptance":0.9,"solar_absorptance":0.7,"visible_absorptance":0.7},{"identifier":"Generic Clear Glass","display_name":null,"user_data":null,"type":"EnergyWindowMaterialGlazing","thickness":0.006,"solar_transmittance":0.77,"solar_reflectance":0.07,"solar_reflectance_back":0.07,"visible_transmittance":0.88,"visible_reflectance":0.08,"visible_reflectance_back":0.08,"infrared_transmittance":0,"emissivity":0.84,"emissivity_back":0.84,"conductivity":1,"dirt_correction":1,"solar_diffusing":false}],"constructions":[{"identifier":"Generic Interior Door","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 25mm Wood"]},{"identifier":"Generic Single Pane","display_name":null,"user_data":null,"type":"WindowConstructionAbridged","materials":["Generic Clear Glass"],"frame":null},{"identifier":"Generic Shade","display_name":null,"user_data":null,"type":"ShadeConstruction","solar_reflectance":0.35,"visible_reflectance":0.35,"is_specular":false},{"identifier":"Generic Context","display_name":null,"user_data":null,"type":"ShadeConstruction","solar_reflectance":0.2,"visible_reflectance":0.2,"is_specular":false},{"identifier":"Generic Interior Ceiling","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic LW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Interior Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Gypsum Board","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Exposed Floor","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Painted Metal","Generic Ceiling Air Gap","Generic 50mm Insulation","Generic LW Concrete"]},{"identifier":"Generic Interior Floor","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Acoustic Tile","Generic Ceiling Air Gap","Generic LW Concrete"]},{"identifier":"Generic Ground Slab","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete"]},{"identifier":"Generic Roof","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Roof Membrane","Generic 50mm Insulation","Generic LW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Exterior Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Brick","Generic LW Concrete","Generic 50mm Insulation","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Underground Wall","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete","Generic Wall Air Gap","Generic Gypsum Board"]},{"identifier":"Generic Air Boundary","display_name":null,"user_data":null,"type":"AirBoundaryConstructionAbridged","air_mixing_per_area":0.1,"air_mixing_schedule":"Always On"},{"identifier":"Generic Underground Roof","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic 50mm Insulation","Generic HW Concrete","Generic Ceiling Air Gap","Generic Acoustic Tile"]},{"identifier":"Generic Double Pane","display_name":null,"user_data":null,"type":"WindowConstructionAbridged","materials":["Generic Low-e Glass","Generic Window Air Gap","Generic Clear Glass"],"frame":null},{"identifier":"Generic Exterior Door","display_name":null,"user_data":null,"type":"OpaqueConstructionAbridged","materials":["Generic Painted Metal","Generic 25mm Insulation","Generic Painted Metal"]}],"wall_set":{"interior_construction":"Generic Interior Wall","exterior_construction":"Generic Exterior Wall","ground_construction":"Generic Underground Wall","type":"WallConstructionSetAbridged"},"floor_set":{"interior_construction":"Generic Interior Floor","exterior_construction":"Generic Exposed Floor","ground_construction":"Generic Ground Slab","type":"FloorConstructionSetAbridged"},"roof_ceiling_set":{"interior_construction":"Generic Interior Ceiling","exterior_construction":"Generic Roof","ground_construction":"Generic Underground Roof","type":"RoofCeilingConstructionSetAbridged"},"aperture_set":{"type":"ApertureConstructionSetAbridged","interior_construction":"Generic Single Pane","window_construction":"Generic Double Pane","skylight_construction":"Generic Double Pane","operable_construction":"Generic Double Pane"},"door_set":{"type":"DoorConstructionSetAbridged","interior_construction":"Generic Interior Door","exterior_construction":"Generic Exterior Door","overhead_construction":"Generic Exterior Door","exterior_glass_construction":"Generic Double Pane","interior_glass_construction":"Generic Single Pane"},"shade_construction":"Generic Shade","context_construction":"Generic Context","air_boundary_construction":"Generic Air Boundary"}

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

Array of ConstructionSetAbridged (object) or ConstructionSet (object) (Construction Sets)

List of all ConstructionSets in the Model.

Array of OpaqueConstructionAbridged (object) or WindowConstructionAbridged (object) or ShadeConstruction (object) or AirBoundaryConstructionAbridged (object) or OpaqueConstruction (object) or WindowConstruction (object) or AirBoundaryConstruction (object) (Constructions)

A list of all unique constructions in the model. This includes constructions across all the Model construction_sets.

Array of EnergyMaterial (object) or EnergyMaterialNoMass (object) or EnergyMaterialVegetation (object) or EnergyWindowMaterialGlazing (object) or EnergyWindowMaterialSimpleGlazSys (object) or EnergyWindowMaterialGas (object) or EnergyWindowMaterialGasMixture (object) or EnergyWindowMaterialGasCustom (object) or EnergyWindowFrame (object) or EnergyWindowMaterialBlind (object) or EnergyWindowMaterialShade (object) (Materials)

A list of all unique materials in the model. This includes materials needed to make the Model constructions.

Array of IdealAirSystemAbridged (object) or VAV (object) or PVAV (object) or PSZ (object) or PTAC (object) or ForcedAirFurnace (object) or FCUwithDOASAbridged (object) or WSHPwithDOASAbridged (object) or VRFwithDOASAbridged (object) or RadiantwithDOASAbridged (object) or FCU (object) or WSHP (object) or VRF (object) or Baseboard (object) or EvaporativeCooler (object) or Residential (object) or WindowAC (object) or GasUnitHeater (object) or Radiant (object) or DetailedHVAC (object) (Hvacs)

List of all HVAC systems in the Model.

Array of objects (Shws)

List of all Service Hot Water (SHW) systems in the Model.

Array of ProgramTypeAbridged (object) or ProgramType (object) (Program Types)

List of all ProgramTypes in the Model.

Array of ScheduleRulesetAbridged (object) or ScheduleFixedIntervalAbridged (object) or ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedules)

A list of all unique schedules in the model. This includes schedules across all HVAC systems, ProgramTypes and ContextShades.

Array of objects (Schedule Type Limits)

A list of all unique ScheduleTypeLimits in the model. This all ScheduleTypeLimits needed to make the Model schedules.

{
  • "type": "ModelEnergyProperties",
  • "global_construction_set": {
    },
  • "construction_sets": [
    ],
  • "constructions": [
    ],
  • "materials": [
    ],
  • "hvacs": [
    ],
  • "shws": [
    ],
  • "program_types": [
    ],
  • "schedules": [
    ],
  • "schedule_type_limits": [
    ]
}

ModelProperties

type
string (Type) ^ModelProperties$
Default: "ModelProperties"

A base class to use when there is no baseclass available to fall on.

energy
object (ModelEnergyProperties) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ModelRadianceProperties) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "ModelProperties",
  • "energy": {
    },
  • "radiance": {
    }
}

ModelRadianceProperties

type
string (Type) ^ModelRadianceProperties$
Default: "ModelRadianceProperties"

A base class to use when there is no baseclass available to fall on.

global_modifier_set
object (Global Modifier Set) Recursive
Default: {"type":"GlobalModifierSet","modifiers":[{"identifier":"generic_floor_0.20","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.2,"g_reflectance":0.2,"b_reflectance":0.2,"specularity":0,"roughness":0},{"identifier":"generic_wall_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_ceiling_0.80","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.8,"g_reflectance":0.8,"b_reflectance":0.8,"specularity":0,"roughness":0},{"identifier":"generic_opaque_door_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_interior_shade_0.50","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.5,"g_reflectance":0.5,"b_reflectance":0.5,"specularity":0,"roughness":0},{"identifier":"generic_exterior_shade_0.35","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.35,"g_reflectance":0.35,"b_reflectance":0.35,"specularity":0,"roughness":0},{"identifier":"generic_context_0.20","display_name":null,"type":"Plastic","modifier":null,"dependencies":[],"r_reflectance":0.2,"g_reflectance":0.2,"b_reflectance":0.2,"specularity":0,"roughness":0},{"identifier":"generic_interior_window_vis_0.88","display_name":null,"type":"Glass","modifier":null,"dependencies":[],"r_transmissivity":0.9584154328610596,"g_transmissivity":0.9584154328610596,"b_transmissivity":0.9584154328610596,"refraction_index":null},{"identifier":"generic_exterior_window_vis_0.64","display_name":null,"type":"Glass","modifier":null,"dependencies":[],"r_transmissivity":0.6975761815384331,"g_transmissivity":0.6975761815384331,"b_transmissivity":0.6975761815384331,"refraction_index":null},{"identifier":"air_boundary","display_name":null,"type":"Trans","modifier":null,"dependencies":[],"r_reflectance":1,"g_reflectance":1,"b_reflectance":1,"specularity":0,"roughness":0,"transmitted_diff":1,"transmitted_spec":1}],"wall_set":{"exterior_modifier":"generic_wall_0.50","interior_modifier":"generic_wall_0.50","type":"WallModifierSetAbridged"},"floor_set":{"exterior_modifier":"generic_floor_0.20","interior_modifier":"generic_floor_0.20","type":"FloorModifierSetAbridged"},"roof_ceiling_set":{"exterior_modifier":"generic_ceiling_0.80","interior_modifier":"generic_ceiling_0.80","type":"RoofCeilingModifierSetAbridged"},"aperture_set":{"type":"ApertureModifierSetAbridged","window_modifier":"generic_exterior_window_vis_0.64","interior_modifier":"generic_interior_window_vis_0.88","skylight_modifier":"generic_exterior_window_vis_0.64","operable_modifier":"generic_exterior_window_vis_0.64"},"door_set":{"exterior_modifier":"generic_opaque_door_0.50","interior_modifier":"generic_opaque_door_0.50","type":"DoorModifierSetAbridged","interior_glass_modifier":"generic_interior_window_vis_0.88","exterior_glass_modifier":"generic_exterior_window_vis_0.64","overhead_modifier":"generic_opaque_door_0.50"},"shade_set":{"exterior_modifier":"generic_exterior_shade_0.35","interior_modifier":"generic_interior_shade_0.50","type":"ShadeModifierSetAbridged"},"air_boundary_modifier":"air_boundary","context_modifier":"generic_context_0.20"}

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

Array of ModifierSet (object) or ModifierSetAbridged (object) (Modifier Sets)

List of all ModifierSets in the Model.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifiers)

A list of all unique modifiers in the model. This includes modifiers across all the Model modifier_sets.

{
  • "type": "ModelRadianceProperties",
  • "global_modifier_set": {
    },
  • "modifier_sets": [
    ],
  • "modifiers": [
    ]
}

ModifierBase

type
string (Type) ^ModifierBase$
Default: "ModifierBase"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

{
  • "type": "ModifierBase",
  • "identifier": "string",
  • "display_name": "string"
}

ModifierSet

type
string (Type) ^ModifierSet$
Default: "ModifierSet"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

Set containing radiance modifiers needed for a model's Walls.

floor_set
object (Floor Set) Recursive

Set containing radiance modifiers needed for a model's Floors.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

Set containing radiance modifiers needed for a model's roofs.

aperture_set
object (Aperture Set) Recursive

Set containing radiance modifiers needed for a model's Apertures.

door_set
object (Door Set) Recursive

Set containing radiance modifiers needed for a model's Doors.

shade_set
object (Shade Set) Recursive

Set containing radiance modifiers needed for a model's Shade.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Air Boundary Modifier)

An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.

{
  • "type": "ModifierSet",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_set": {
    },
  • "air_boundary_modifier": {
    }
}

ModifierSetAbridged

type
string (Type) ^ModifierSetAbridged$
Default: "ModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

wall_set
object (Wall Set) Recursive

Base class for the abridged modifier sets assigned to Faces.

floor_set
object (Floor Set) Recursive

Base class for the abridged modifier sets assigned to Faces.

roof_ceiling_set
object (Roof Ceiling Set) Recursive

Base class for the abridged modifier sets assigned to Faces.

aperture_set
object (Aperture Set) Recursive

Abridged set containing radiance modifiers needed for a model's Apertures.

door_set
object (Door Set) Recursive

Base class for the abridged modifier sets assigned to Faces.

shade_set
object (Shade Set) Recursive

Base class for the abridged modifier sets assigned to Faces.

air_boundary_modifier
string (Air Boundary Modifier)

Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.

{
  • "type": "ModifierSetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "wall_set": {
    },
  • "floor_set": {
    },
  • "roof_ceiling_set": {
    },
  • "aperture_set": {
    },
  • "door_set": {
    },
  • "shade_set": {
    },
  • "air_boundary_modifier": "string"
}

ModuleType

string (ModuleType)
Enum: "Standard" "Premium" "ThinFilm"

An enumeration.

"Standard"

MoistureDiffusionModel

string (MoistureDiffusionModel)
Enum: "Simple" "Advanced"

Acceptable values for the moisture diffusion model for vegetation.

"Simple"

MountingType

string (MountingType)
Enum: "FixedOpenRack" "FixedRoofMounted" "OneAxis" "OneAxisBacktracking" "TwoAxis"

An enumeration.

"FixedOpenRack"

NoLimit

type
string (Type) ^NoLimit$
Default: "NoLimit"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "NoLimit"
}

OpaqueConstruction

type
string (Type) ^OpaqueConstruction$
Default: "OpaqueConstruction"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of EnergyMaterial (object) or EnergyMaterialNoMass (object) or EnergyMaterialVegetation (object) (Materials) [ 1 .. 10 ] items

List of opaque material definitions. The order of the materials is from exterior to interior.

{
  • "type": "OpaqueConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "materials": [
    ]
}

OpaqueConstructionAbridged

type
string (Type) ^OpaqueConstructionAbridged$
Default: "OpaqueConstructionAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

materials
required
Array of strings (Materials) [ 1 .. 10 ] items [ items [ 1 .. 100 ] characters ]

List of strings for opaque material identifiers. The order of the materials is from exterior to interior.

{
  • "type": "OpaqueConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "materials": [
    ]
}

OtherSideTemperature

type
string (Type) ^OtherSideTemperature$
Default: "OtherSideTemperature"

A base class to use when there is no baseclass available to fall on.

heat_transfer_coefficient
number <double> (Heat Transfer Coefficient) >= 0
Default: 0

A value in W/m2-K to indicate the combined convective/radiative film coefficient. If equal to 0, then the specified temperature above is equal to the exterior surface temperature. Otherwise, the temperature above is considered the outside air temperature and this coefficient is used to determine the difference between this outside air temperature and the exterior surface temperature.

Autocalculate (object) or Temperature (number) (Temperature)
Default: {"type":"Autocalculate"}

A temperature value in Celsius to note the temperature on the other side of the object. This input can also be an Autocalculate object to signify that the temperature is equal to the outdoor air temperature.

{
  • "type": "OtherSideTemperature",
  • "heat_transfer_coefficient": 0,
  • "temperature": {
    }
}

Outdoors

type
string (Type) ^Outdoors$
Default: "Outdoors"

A base class to use when there is no baseclass available to fall on.

sun_exposure
boolean (Sun Exposure)
Default: true

A boolean noting whether the boundary is exposed to sun.

wind_exposure
boolean (Wind Exposure)
Default: true

A boolean noting whether the boundary is exposed to wind.

Autocalculate (object) or View Factor (number) (View Factor)
Default: {"type":"Autocalculate"}

A number for the view factor to the ground. This can also be an Autocalculate object to have the view factor automatically calculated.

{
  • "type": "Outdoors",
  • "sun_exposure": true,
  • "wind_exposure": true,
  • "view_factor": {
    }
}

Overhang

type
string (Type) ^Overhang$
Default: "Overhang"

A base class to use when there is no baseclass available to fall on.

depth
required
number <double> (Depth) > 0

A number for the overhang depth.

angle
number <double> (Angle) [ -90 .. 90 ]
Default: 0

A number between -90 and 90 for the for an angle to rotate the overhang in degrees. 0 indicates an overhang perpendicular to the wall. Positive values indicate a downward rotation. Negative values indicate an upward rotation.

{
  • "type": "Overhang",
  • "depth": 0,
  • "angle": 0
}

People

type
string (Type) ^People$
Default: "People"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

people_per_area
required
number <double> (People Per Area) >= 0

People per floor area expressed as [people/m2]

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Occupancy Schedule)

A schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Activity Schedule)

A schedule for the activity of the occupants over the course of the year. The type of this schedule should be ActivityLevel and the values of the schedule equal to the number of Watts given off by an individual person in the room. If None, a default constant schedule with 120 Watts per person will be used, which is typical of awake, adult humans who are seated.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.3

The radiant fraction of sensible heat released by people. (Default: 0.3).

Autocalculate (object) or Latent Fraction (number) (Latent Fraction)
Default: {"type":"Autocalculate"}

Number for the latent fraction of heat gain due to people or an Autocalculate object.

{
  • "type": "People",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "people_per_area": 0,
  • "occupancy_schedule": {
    },
  • "activity_schedule": {
    },
  • "radiant_fraction": 0.3,
  • "latent_fraction": {
    }
}

PeopleAbridged

type
string (Type) ^PeopleAbridged$
Default: "PeopleAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

people_per_area
required
number <double> (People Per Area) >= 0

People per floor area expressed as [people/m2]

occupancy_schedule
required
string (Occupancy Schedule) [ 1 .. 100 ] characters

Identifier of a schedule for the occupancy over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the people_per_area to yield a complete occupancy profile.

activity_schedule
string (Activity Schedule) [ 1 .. 100 ] characters

Identifier of a schedule for the activity of the occupants over the course of the year. The type of this schedule should be ActivityLevel and the values of the schedule equal to the number of Watts given off by an individual person in the room. If None, a default constant schedule with 120 Watts per person will be used, which is typical of awake, adult humans who are seated.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0.3

The radiant fraction of sensible heat released by people. (Default: 0.3).

Autocalculate (object) or Latent Fraction (number) (Latent Fraction)
Default: {"type":"Autocalculate"}

Number for the latent fraction of heat gain due to people or an Autocalculate object.

{
  • "type": "PeopleAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "people_per_area": 0,
  • "occupancy_schedule": "string",
  • "activity_schedule": "string",
  • "radiant_fraction": 0.3,
  • "latent_fraction": {
    }
}

Plane

type
string (Type) ^Plane$
Default: "Plane"

A base class to use when there is no baseclass available to fall on.

n
required
Array of numbers <double> (N) = 3 items [ items <double > ]

Plane normal as 3 (x, y, z) values.

o
required
Array of numbers <double> (O) = 3 items [ items <double > ]

Plane origin as 3 (x, y, z) values

x
Array of numbers <double> (X) = 3 items [ items <double > ]

Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.

{
  • "type": "Plane",
  • "n": [
    ],
  • "o": [
    ],
  • "x": [
    ]
}

Plastic

type
string (Type) ^Plastic$
Default: "Plastic"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance.

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance.

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance.

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials.

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the RMS slope of surface facets. Roughness greater than 0.2 are not realistic.

{
  • "type": "Plastic",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0,
  • "roughness": 0
}

ProcessAbridged

type
string (Type) ^ProcessAbridged$
Default: "ProcessAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

watts
required
number <double> (Watts) >= 0

A number for the process load power in Watts.

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the use of the process over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the watts to yield a complete equipment profile.

fuel_type
required
string (FuelTypes)
Enum: "Electricity" "NaturalGas" "Propane" "FuelOilNo1" "FuelOilNo2" "Diesel" "Gasoline" "Coal" "Steam" "DistrictHeating" "DistrictCooling" "OtherFuel1" "OtherFuel2" "None"

Designates the acceptable fuel types for process loads.

end_use_category
string (End Use Category) [ 1 .. 100 ] characters
Default: "Process"

Text to indicate the end-use subcategory, which will identify the process load in the end use output. For example, “Cooking”, “Clothes Drying”, etc. A new meter for reporting is created for each unique subcategory.

radiant_fraction
number <double> (Radiant Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of long-wave radiation heat given off by the process load. Default value is 0.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of latent heat given off by the process load. Default value is 0.

lost_fraction
number <double> (Lost Fraction) [ 0 .. 1 ]
Default: 0

Number for the amount of “lost” heat being given off by the process load. The default value is 0.

{
  • "type": "ProcessAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "watts": 0,
  • "schedule": "string",
  • "fuel_type": "Electricity",
  • "end_use_category": "Process",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

ProgramType

type
string (Type) ^ProgramType$
Default: "ProgramType"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

people
object (People) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

lighting
object (Lighting) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

electric_equipment
object (Electric Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

gas_equipment
object (Gas Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

service_hot_water
object (Service Hot Water) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

infiltration
object (Infiltration) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ventilation
object (Ventilation) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

setpoint
object (Setpoint) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "ProgramType",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    }
}

ProgramTypeAbridged

type
string (Type) ^ProgramTypeAbridged$
Default: "ProgramTypeAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

people
object (People) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

lighting
object (Lighting) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

electric_equipment
object (Electric Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

gas_equipment
object (Gas Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

service_hot_water
object (Service Hot Water) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

infiltration
object (Infiltration) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ventilation
object (Ventilation) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

setpoint
object (Setpoint) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "ProgramTypeAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    }
}

PSZ

type
string (Type) ^PSZ$
Default: "PSZ"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

economizer_type
string (AllAirEconomizerType)
Default: "NoEconomizer"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy" "DifferentialDryBulbAndEnthalpy" "FixedDryBulb" "FixedEnthalpy" "ElectronicEnthalpy"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

equipment_type
string (PSZEquipmentType)
Default: "PSZAC_ElectricBaseboard"
Enum: "PSZAC_ElectricBaseboard" "PSZAC_BoilerBaseboard" "PSZAC_DHWBaseboard" "PSZAC_GasHeaters" "PSZAC_ElectricCoil" "PSZAC_GasCoil" "PSZAC_Boiler" "PSZAC_ASHP" "PSZAC_DHW" "PSZAC" "PSZAC_DCW_ElectricBaseboard" "PSZAC_DCW_BoilerBaseboard" "PSZAC_DCW_GasHeaters" "PSZAC_DCW_ElectricCoil" "PSZAC_DCW_GasCoil" "PSZAC_DCW_Boiler" "PSZAC_DCW_ASHP" "PSZAC_DCW_DHW" "PSZAC_DCW" "PSZHP"

An enumeration.

{
  • "type": "PSZ",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "economizer_type": "NoEconomizer",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "equipment_type": "PSZAC_ElectricBaseboard"
}

PSZEquipmentType

string (PSZEquipmentType)
Enum: "PSZAC_ElectricBaseboard" "PSZAC_BoilerBaseboard" "PSZAC_DHWBaseboard" "PSZAC_GasHeaters" "PSZAC_ElectricCoil" "PSZAC_GasCoil" "PSZAC_Boiler" "PSZAC_ASHP" "PSZAC_DHW" "PSZAC" "PSZAC_DCW_ElectricBaseboard" "PSZAC_DCW_BoilerBaseboard" "PSZAC_DCW_GasHeaters" "PSZAC_DCW_ElectricCoil" "PSZAC_DCW_GasCoil" "PSZAC_DCW_Boiler" "PSZAC_DCW_ASHP" "PSZAC_DCW_DHW" "PSZAC_DCW" "PSZHP"

An enumeration.

"PSZAC_ElectricBaseboard"

PTAC

type
string (Type) ^PTAC$
Default: "PTAC"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (PTACEquipmentType)
Default: "PTAC_ElectricBaseboard"
Enum: "PTAC_ElectricBaseboard" "PTAC_BoilerBaseboard" "PTAC_DHWBaseboard" "PTAC_GasHeaters" "PTAC_ElectricCoil" "PTAC_GasCoil" "PTAC_Boiler" "PTAC_ASHP" "PTAC_DHW" "PTAC" "PTHP"

An enumeration.

{
  • "type": "PTAC",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "PTAC_ElectricBaseboard"
}

PTACEquipmentType

string (PTACEquipmentType)
Enum: "PTAC_ElectricBaseboard" "PTAC_BoilerBaseboard" "PTAC_DHWBaseboard" "PTAC_GasHeaters" "PTAC_ElectricCoil" "PTAC_GasCoil" "PTAC_Boiler" "PTAC_ASHP" "PTAC_DHW" "PTAC" "PTHP"

An enumeration.

"PTAC_ElectricBaseboard"

PVAV

type
string (Type) ^PVAV$
Default: "PVAV"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

economizer_type
string (AllAirEconomizerType)
Default: "NoEconomizer"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy" "DifferentialDryBulbAndEnthalpy" "FixedDryBulb" "FixedEnthalpy" "ElectronicEnthalpy"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

equipment_type
string (PVAVEquipmentType)
Default: "PVAV_Boiler"
Enum: "PVAV_Boiler" "PVAV_ASHP" "PVAV_DHW" "PVAV_PFP" "PVAV_BoilerElectricReheat"

An enumeration.

{
  • "type": "PVAV",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "economizer_type": "NoEconomizer",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "equipment_type": "PVAV_Boiler"
}

PVAVEquipmentType

string (PVAVEquipmentType)
Enum: "PVAV_Boiler" "PVAV_ASHP" "PVAV_DHW" "PVAV_PFP" "PVAV_BoilerElectricReheat"

An enumeration.

"PVAV_Boiler"

PVProperties

type
string (Type) ^PVProperties$
Default: "PVProperties"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

rated_efficiency
number <double> (Rated Efficiency) ( 0 .. 1 )
Default: 0.15

A number between 0 and 1 for the rated nameplate efficiency of the photovoltaic solar cells under standard test conditions (STC). Standard test conditions are 1,000 Watts per square meter solar irradiance, 25 degrees C cell temperature, and ASTM G173-03 standard spectrum. Nameplate efficiencies reported by manufacturers are typically under STC. Standard poly- or mono-crystalline silicon modules tend to have rated efficiencies in the range of 14-17%. Premium high efficiency mono-crystalline silicon modules with anti-reflective coatings can have efficiencies in the range of 18-20%. Thin film photovoltaic modules typically have efficiencies of 11% or less. (Default: 0.15 for standard silicon solar cells).

active_area_fraction
number <double> (Active Area Fraction) ( 0 .. 1 ]
Default: 0.9

The fraction of the parent Shade geometry that is covered in active solar cells. This fraction includes the difference between the PV panel (aka. PV module) area and the active cells within the panel as well as any losses for how the (typically rectangular) panels can be arranged on the Shade geometry. When the parent Shade geometry represents just the solar panels, this fraction is typically around 0.9 given that the framing elements of the panel reduce the overall active area. (Default: 0.9, assuming parent Shade geometry represents only the PV panel geometry).

module_type
string (ModuleType)
Default: "Standard"
Enum: "Standard" "Premium" "ThinFilm"

An enumeration.

mounting_type
string (MountingType)
Default: "FixedOpenRack"
Enum: "FixedOpenRack" "FixedRoofMounted" "OneAxis" "OneAxisBacktracking" "TwoAxis"

An enumeration.

system_loss_fraction
number <double> (System Loss Fraction) [ 0 .. 1 ]
Default: 0.14

A number between 0 and 1 for the fraction of the electricity output lost due to factors other than EPW weather conditions, panel efficiency/type, active area, mounting, and inverter conversion from DC to AC. Factors that should be accounted for in this input include soiling, snow, wiring losses, electrical connection losses, manufacturer defects/tolerances/mismatch in cell characteristics, losses from power grid availability, and losses due to age or light-induced degradation. Losses from these factors tend to be between 10-20% but can vary widely depending on the installation, maintenance and the grid to which the panels are connected..

{
  • "type": "PVProperties",
  • "identifier": "string",
  • "display_name": "string",
  • "rated_efficiency": 0.15,
  • "active_area_fraction": 0.9,
  • "module_type": "Standard",
  • "mounting_type": "FixedOpenRack",
  • "system_loss_fraction": 0.14
}

RadianceShadeStateAbridged

type
string (Type) ^RadianceShadeStateAbridged$
Default: "RadianceShadeStateAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A Radiance Modifier identifier (default: None).

Array of objects (Shades)

A list of StateGeometryAbridged objects (default: None).

{
  • "type": "RadianceShadeStateAbridged",
  • "modifier": "string",
  • "modifier_direct": "string",
  • "shades": [
    ]
}

RadianceSubFaceStateAbridged

type
string (Type) ^RadianceSubFaceStateAbridged$
Default: "RadianceSubFaceStateAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A Radiance Modifier identifier (default: None).

Array of objects (Shades)

A list of StateGeometryAbridged objects (default: None).

vmtx_geometry
object (Vmtx Geometry) Recursive

A single planar face in 3D space.

dmtx_geometry
object (Dmtx Geometry) Recursive

A single planar face in 3D space.

{
  • "type": "RadianceSubFaceStateAbridged",
  • "modifier": "string",
  • "modifier_direct": "string",
  • "shades": [
    ],
  • "vmtx_geometry": {
    },
  • "dmtx_geometry": {
    }
}

Radiant

type
string (Type) ^Radiant$
Default: "Radiant"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (RadiantEquipmentType)
Default: "Radiant_Chiller_Boiler"
Enum: "Radiant_Chiller_Boiler" "Radiant_Chiller_ASHP" "Radiant_Chiller_DHW" "Radiant_ACChiller_Boiler" "Radiant_ACChiller_ASHP" "Radiant_ACChiller_DHW" "Radiant_DCW_Boiler" "Radiant_DCW_ASHP" "Radiant_DCW_DHW"

An enumeration.

radiant_face_type
string (RadiantFaceTypes)
Default: "Floor"
Enum: "Floor" "Ceiling" "FloorWithCarpet" "CeilingMetalPanel" "FloorWithHardwood"

An enumeration.

minimum_operation_time
number <double> (Minimum Operation Time) > 0
Default: 1

A number for the minimum number of hours of operation for the radiant system before it shuts off.

switch_over_time
number <double> (Switch Over Time) > 0
Default: 24

A number for the minimum number of hours for when the system can switch between heating and cooling.

{
  • "type": "Radiant",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "Radiant_Chiller_Boiler",
  • "radiant_face_type": "Floor",
  • "minimum_operation_time": 1,
  • "switch_over_time": 24
}

RadiantEquipmentType

string (RadiantEquipmentType)
Enum: "Radiant_Chiller_Boiler" "Radiant_Chiller_ASHP" "Radiant_Chiller_DHW" "Radiant_ACChiller_Boiler" "Radiant_ACChiller_ASHP" "Radiant_ACChiller_DHW" "Radiant_DCW_Boiler" "Radiant_DCW_ASHP" "Radiant_DCW_DHW"

An enumeration.

"Radiant_Chiller_Boiler"

RadiantFaceTypes

string (RadiantFaceTypes)
Enum: "Floor" "Ceiling" "FloorWithCarpet" "CeilingMetalPanel" "FloorWithHardwood"

An enumeration.

"Floor"

RadiantwithDOASAbridged

type
string (Type) ^RadiantwithDOASAbridged$
Default: "RadiantwithDOASAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

doas_availability_schedule
string (Doas Availability Schedule) [ 1 .. 100 ] characters

An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.

equipment_type
string (RadiantwithDOASEquipmentType)
Default: "DOAS_Radiant_Chiller_Boiler"
Enum: "DOAS_Radiant_Chiller_Boiler" "DOAS_Radiant_Chiller_ASHP" "DOAS_Radiant_Chiller_DHW" "DOAS_Radiant_ACChiller_Boiler" "DOAS_Radiant_ACChiller_ASHP" "DOAS_Radiant_ACChiller_DHW" "DOAS_Radiant_DCW_Boiler" "DOAS_Radiant_DCW_ASHP" "DOAS_Radiant_DCW_DHW"

An enumeration.

radiant_face_type
string (RadiantFaceTypes)
Default: "Floor"
Enum: "Floor" "Ceiling" "FloorWithCarpet" "CeilingMetalPanel" "FloorWithHardwood"

An enumeration.

minimum_operation_time
number <double> (Minimum Operation Time) > 0
Default: 1

A number for the minimum number of hours of operation for the radiant system before it shuts off.

switch_over_time
number <double> (Switch Over Time) > 0
Default: 24

A number for the minimum number of hours for when the system can switch between heating and cooling.

{
  • "type": "RadiantwithDOASAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "doas_availability_schedule": "string",
  • "equipment_type": "DOAS_Radiant_Chiller_Boiler",
  • "radiant_face_type": "Floor",
  • "minimum_operation_time": 1,
  • "switch_over_time": 24
}

RadiantwithDOASEquipmentType

string (RadiantwithDOASEquipmentType)
Enum: "DOAS_Radiant_Chiller_Boiler" "DOAS_Radiant_Chiller_ASHP" "DOAS_Radiant_Chiller_DHW" "DOAS_Radiant_ACChiller_Boiler" "DOAS_Radiant_ACChiller_ASHP" "DOAS_Radiant_ACChiller_DHW" "DOAS_Radiant_DCW_Boiler" "DOAS_Radiant_DCW_ASHP" "DOAS_Radiant_DCW_DHW"

An enumeration.

"DOAS_Radiant_Chiller_Boiler"

RectangularWindows

type
string (Type) ^RectangularWindows$
Default: "RectangularWindows"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

origins
required
Array of numbers (Origins) non-empty [ items <double > = 2 items [ items <double > > 0 ] ]

An array of 2D points within the plane of the wall for the origin of each window. Each point should be a list of 2 (x, y) values. The wall plane is assumed to have an origin at the first point of the wall segment and an X-axis extending along the length of the segment. The wall plane Y-axis always points upwards. Therefore, both X and Y values of each origin point should be positive.

widths
required
Array of numbers <double> (Widths) non-empty [ items <double > > 0 ]

An array of positive numbers for the window widths. The length of this list must match the length of the origins.

heights
required
Array of numbers <double> (Heights) non-empty [ items <double > > 0 ]

An array of positive numbers for the window heights. The length of this list must match the length of the origins.

are_doors
Array of booleans (Are Doors)

An array of booleans that align with the origins and note whether each of the geometries represents a door (True) or a window (False). If None, it will be assumed that all geometries represent windows and they will be translated to Apertures in any resulting Honeybee model.

{
  • "type": "RectangularWindows",
  • "user_data": { },
  • "origins": [
    ],
  • "widths": [
    ],
  • "heights": [
    ],
  • "are_doors": [
    ]
}

RepeatingWindowRatio

type
string (Type) ^RepeatingWindowRatio$
Default: "RepeatingWindowRatio"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

window_ratio
required
number <double> (Window Ratio) ( 0 .. 0.95 )

A number between 0 and 1 for the ratio between the window area and the parent wall surface area.

window_height
required
number <double> (Window Height) > 0

A number for the target height of the windows. Note that, if the window ratio is too large for the height, the ratio will take precedence and the actual window_height will be larger than this value.

sill_height
required
number <double> (Sill Height) > 0

A number for the target height above the bottom edge of the wall to start the windows. Note that, if the ratio is too large for the height, the ratio will take precedence and the sill_height will be smaller than this value.

horizontal_separation
required
number <double> (Horizontal Separation) >= 0

A number for the target separation between individual window centerlines. If this number is larger than the parent rectangle base, only one window will be produced.

vertical_separation
number <double> (Vertical Separation) >= 0
Default: 0

An optional number to create a single vertical separation between top and bottom windows.

{
  • "type": "RepeatingWindowRatio",
  • "user_data": { },
  • "window_ratio": -1,
  • "window_height": 0,
  • "sill_height": 0,
  • "horizontal_separation": 0,
  • "vertical_separation": 0
}

Residential

type
string (Type) ^Residential$
Default: "Residential"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (ResidentialEquipmentType)
Default: "ResidentialAC_ElectricBaseboard"
Enum: "ResidentialAC_ElectricBaseboard" "ResidentialAC_BoilerBaseboard" "ResidentialAC_ASHPBaseboard" "ResidentialAC_DHWBaseboard" "ResidentialAC_ResidentialFurnace" "ResidentialAC" "ResidentialHP" "ResidentialHPNoCool" "ResidentialFurnace"

An enumeration.

{
  • "type": "Residential",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "ResidentialAC_ElectricBaseboard"
}

ResidentialEquipmentType

string (ResidentialEquipmentType)
Enum: "ResidentialAC_ElectricBaseboard" "ResidentialAC_BoilerBaseboard" "ResidentialAC_ASHPBaseboard" "ResidentialAC_DHWBaseboard" "ResidentialAC_ResidentialFurnace" "ResidentialAC" "ResidentialHP" "ResidentialHPNoCool" "ResidentialFurnace"

An enumeration.

"ResidentialAC_ElectricBaseboard"

RoofCeilingConstructionSet

type
string (Type) ^RoofCeilingConstructionSet$
Default: "RoofCeilingConstructionSet"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

exterior_construction
object (Exterior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ground_construction
object (Ground Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "RoofCeilingConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

RoofCeilingConstructionSetAbridged

type
string (Type) ^RoofCeilingConstructionSetAbridged$
Default: "RoofCeilingConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "RoofCeilingConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

RoofCeilingModifierSet

type
string (Type) ^RoofCeilingModifierSet$
Default: "RoofCeilingModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "RoofCeilingModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

RoofCeilingModifierSetAbridged

type
string (Type) ^RoofCeilingModifierSetAbridged$
Default: "RoofCeilingModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "RoofCeilingModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

RoofSpecification

type
string (Type) ^RoofSpecification$
Default: "RoofSpecification"

A base class to use when there is no baseclass available to fall on.

required
Array of objects (Geometry)

An array of Face3D objects representing the geometry of the Roof. None of these geometries should overlap in plan and, together, these Face3D should either completely cover or skip each Room2D of the Story to which the RoofSpecification is assigned.

{
  • "type": "RoofSpecification",
  • "geometry": [
    ]
}

Room2D

type
string (Type) ^Room2D$
Default: "Room2D"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

floor_boundary
required
Array of numbers (Floor Boundary) >= 3 items [ items <double > = 2 items [ items <double > ] ]

A list of 2D points representing the outer boundary vertices of the Room2D. The list should include at least 3 points and each point should be a list of 2 (x, y) values.

floor_height
required
number <double> (Floor Height)

A number to indicate the height of the floor plane in the Z axis.

floor_to_ceiling_height
required
number <double> (Floor To Ceiling Height)

A number for the distance between the floor and the ceiling.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

floor_holes
Array of numbers (Floor Holes) [ items >= 3 items [ items <double > = 2 items [ items <double > ] ] ]

Optional list of lists with one list for each hole in the floor plate. Each hole should be a list of at least 2 points and each point a list of 2 (x, y) values. If None, it will be assumed that there are no holes in the floor plate.

is_ground_contact
boolean (Is Ground Contact)
Default: false

A boolean noting whether this Room2D has its floor in contact with the ground.

is_top_exposed
boolean (Is Top Exposed)
Default: false

A boolean noting whether this Room2D has its ceiling exposed to the outdoors.

Array of Ground (object) or Outdoors (object) or Surface (object) or Adiabatic (object) or OtherSideTemperature (object) (Boundary Conditions)

A list of boundary conditions that match the number of segments in the input floor_geometry + floor_holes. These will be used to assign boundary conditions to each of the walls of the Room in the resulting model. Their order should align with the order of segments in the floor_boundary and then with each hole segment. If None, all boundary conditions will be Outdoors or Ground depending on whether ceiling height of the room is at or below 0 (the assumed ground plane).

Array of SingleWindow (object) or SimpleWindowArea (object) or SimpleWindowRatio (object) or RepeatingWindowRatio (object) or RectangularWindows (object) or DetailedWindows (object) (Window Parameters)

A list of WindowParameter objects that dictate how the window geometries will be generated for each of the walls. If None, no windows will exist over the entire Room2D.

Array of ExtrudedBorder (object) or Overhang (object) or LouversByDistance (object) or LouversByCount (object) (Shading Parameters)

A list of ShadingParameter objects that dictate how the shade geometries will be generated for each of the walls. If None, no shades will exist over the entire Room2D.

air_boundaries
Array of booleans (Air Boundaries)

A list of booleans for whether each wall has an air boundary type. False values indicate a standard opaque type while True values indicate an AirBoundary type. All walls will be False by default. Note that any walls with a True air boundary must have a Surface boundary condition without any windows.

GriddedSkylightArea (object) or GriddedSkylightRatio (object) or DetailedSkylights (object) (Skylight Parameters)

A SkylightParameter object describing how to generate skylights. If None, no skylights will exist on the Room2D.

{
  • "type": "Room2D",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "floor_boundary": [
    ],
  • "floor_height": 0,
  • "floor_to_ceiling_height": 0,
  • "properties": {
    },
  • "floor_holes": [
    ],
  • "is_ground_contact": false,
  • "is_top_exposed": false,
  • "boundary_conditions": [
    ],
  • "window_parameters": [
    ],
  • "shading_parameters": [
    ],
  • "air_boundaries": [
    ],
  • "skylight_parameters": {
    }
}

Room2DEnergyPropertiesAbridged

type
string (Type) ^Room2DEnergyPropertiesAbridged$
Default: "Room2DEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction_set
string (Construction Set) [ 1 .. 100 ] characters

Name of a ConstructionSet to specify all constructions for the Room2D. If None, the Room2D will use the Story or Building construction_set or the Model global_construction_set. Any ConstructionSet assigned here will override those assigned to these objects.

program_type
string (Program Type) [ 1 .. 100 ] characters

Name of a ProgramType to specify all schedules and loads for the Room2D. If None, the Room2D will have no loads or setpoints.

hvac
string (Hvac) [ 1 .. 100 ] characters

An optional identifier of a HVAC system (such as an IdealAirSystem) that specifies how the Room2D is conditioned. If None, it will be assumed that the Room2D is not conditioned.

shw
string (Shw) [ 1 .. 100 ] characters

An optional identifier of a Service Hot Water (SHW) system that specifies how the hot water load of the Room is met. If None, the hot water load will be met with a generic system that only measures thermal loadand does not account for system efficiencies.

window_vent_control
object (Window Vent Control) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

window_vent_opening
object (Window Vent Opening) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

Array of objects (Process Loads)

An optional list of Process objects for process loads within the room. These can represent wood burning fireplaces, kilns, manufacturing equipment, and various industrial processes. They can also be used to represent certain pieces of equipment to be separated from the other end uses, such as MRI machines, theatrical lighting, and elevators.

{
  • "type": "Room2DEnergyPropertiesAbridged",
  • "construction_set": "string",
  • "program_type": "string",
  • "hvac": "string",
  • "shw": "string",
  • "window_vent_control": {
    },
  • "window_vent_opening": {
    },
  • "process_loads": [
    ]
}

Room2DPropertiesAbridged

type
string (Type) ^Room2DPropertiesAbridged$
Default: "Room2DPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (Room2DEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (Room2DRadiancePropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "Room2DPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

Room2DRadiancePropertiesAbridged

type
string (Type) ^Room2DRadiancePropertiesAbridged$
Default: "Room2DRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier_set
string (Modifier Set)

Identifier of a ModifierSet to specify all modifiers for the Room2D. If None, the Room2D will use the Story or Building modifier_set or the Model global_modifier_set. Any ModifierSet assigned here will override those assigned to the parent objects.

Array of RoomGridParameter (object) or RoomRadialGridParameter (object) or ExteriorFaceGridParameter (object) or ExteriorApertureGridParameter (object) (Grid Parameters)

An optional list of GridParameter objects to describe how sensor grids should be generated for the Room2D.

{
  • "type": "Room2DRadiancePropertiesAbridged",
  • "modifier_set": "string",
  • "grid_parameters": [
    ]
}

Room

type
string (Type) ^Room$
Default: "Room"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Faces) >= 4 items

Faces that together form the closed volume of a room.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Array of objects (Indoor Shades)

Shades assigned to the interior side of this object (eg. partitions, tables).

Array of objects (Outdoor Shades)

Shades assigned to the exterior side of this object (eg. trees, landscaping).

multiplier
integer <int32> (Multiplier) >= 1
Default: 1

An integer noting how many times this Room is repeated. Multipliers are used to speed up the calculation when similar Rooms are repeated more than once. Essentially, a given simulation with the Room is run once and then the result is multiplied by the multiplier.

exclude_floor_area
boolean (Exclude Floor Area)
Default: false

A boolean for whether the Room floor area contributes to Models it is a part of. Note that this will not affect the floor_area property of this Room itself but it will ensure the Room floor area is excluded from any calculations when the Room is part of a Model, including EUI calculations.

story
string (Story)

Text string for the story identifier to which this Room belongs. Rooms sharing the same story identifier are considered part of the same story in a Model. Note that this property has no character restrictions.

{
  • "type": "Room",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "faces": [
    ],
  • "properties": {
    },
  • "indoor_shades": [
    ],
  • "outdoor_shades": [
    ],
  • "multiplier": 1,
  • "exclude_floor_area": false,
  • "story": "string"
}

RoomEnergyPropertiesAbridged

type
string (Type) ^RoomEnergyPropertiesAbridged$
Default: "RoomEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction_set
string (Construction Set) [ 1 .. 100 ] characters

Identifier of a ConstructionSet to specify all default constructions for the Faces, Apertures, and Doors of the Room. If None, the Room will use the Model global_construction_set.

program_type
string (Program Type) [ 1 .. 100 ] characters

Identifier of a ProgramType to specify all default schedules and loads for the Room. If None, the Room will have no loads or setpoints.

hvac
string (Hvac) [ 1 .. 100 ] characters

An optional identifier of a HVAC system (such as an IdealAirSystem) that specifies how the Room is conditioned. If None, it will be assumed that the Room is not conditioned.

shw
string (Shw) [ 1 .. 100 ] characters

An optional identifier of a Service Hot Water (SHW) system that specifies how the hot water load of the Room is met. If None, the hot water load will be met with a generic system that only measures thermal loadand does not account for system efficiencies.

people
object (People) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

lighting
object (Lighting) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

electric_equipment
object (Electric Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

gas_equipment
object (Gas Equipment) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

service_hot_water
object (Service Hot Water) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

infiltration
object (Infiltration) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ventilation
object (Ventilation) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

setpoint
object (Setpoint) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

daylighting_control
object (Daylighting Control) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

window_vent_control
object (Window Vent Control) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

Array of objects (Fans)

An optional list of VentilationFan objects for fans within the room. Note that these fans are not connected to the heating or cooling system and are meant to represent the intentional circulation of unconditioned outdoor air for the purposes of keeping a space cooler, drier or free of indoor pollutants (as in the case of kitchen or bathroom exhaust fans). For the specification of mechanical ventilation of conditioned outdoor air, the Room.ventilation property should be used and the Room should be given a HVAC that can meet this specification.

Array of objects (Internal Masses)

An optional list of of InternalMass objects for thermal mass exposed to Room air. Note that internal masses assigned this way cannot "see" solar radiation that may potentially hit them and, as such, caution should be taken when using this component with internal mass objects that are not always in shade. Masses are factored into the the thermal calculations of the Room by undergoing heat transfer with the indoor air.

Array of objects (Process Loads)

An optional list of of Process objects for process loads within the room. These can represent kilns, manufacturing equipment, and various industrial processes. They can also be used to represent wood burning fireplaces or certain pieces of equipment to be separated from the other end uses.

{
  • "type": "RoomEnergyPropertiesAbridged",
  • "construction_set": "string",
  • "program_type": "string",
  • "hvac": "string",
  • "shw": "string",
  • "people": {
    },
  • "lighting": {
    },
  • "electric_equipment": {
    },
  • "gas_equipment": {
    },
  • "service_hot_water": {
    },
  • "infiltration": {
    },
  • "ventilation": {
    },
  • "setpoint": {
    },
  • "daylighting_control": {
    },
  • "window_vent_control": {
    },
  • "fans": [
    ],
  • "internal_masses": [
    ],
  • "process_loads": [
    ]
}

RoomGridParameter

type
string (Type) ^RoomGridParameter$
Default: "RoomGridParameter"

A base class to use when there is no baseclass available to fall on.

dimension
required
number <double> (Dimension) > 0

The dimension of the grid cells as a number.

include_mesh
boolean (Include Mesh)
Default: true

A boolean to note whether the resulting SensorGrid should include the mesh.

offset
number <double> (Offset)
Default: 1

A number for how far to offset the grid from the Room2D floors. (Default: 1.0, suitable for Models in Meters).

wall_offset
number <double> (Wall Offset) > 0
Default: 0

A number for the distance at which sensors close to walls should be removed. Note that this option has no effect unless the value is more than half of the dimension.

{
  • "type": "RoomGridParameter",
  • "dimension": 0,
  • "include_mesh": true,
  • "offset": 1,
  • "wall_offset": 0
}

RoomPropertiesAbridged

type
string (Type) ^RoomPropertiesAbridged$
Default: "RoomPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (RoomEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (RoomRadiancePropertiesAbridged) Recursive

Abridged Radiance Properties for Honeybee Room.

{
  • "type": "RoomPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

RoomRadialGridParameter

type
string (Type) ^RoomRadialGridParameter$
Default: "RoomRadialGridParameter"

A base class to use when there is no baseclass available to fall on.

dimension
required
number <double> (Dimension) > 0

The dimension of the grid cells as a number.

include_mesh
boolean (Include Mesh)
Default: true

A boolean to note whether the resulting SensorGrid should include the mesh.

offset
number <double> (Offset)
Default: 1

A number for how far to offset the grid from the Room2D floors. (Default: 1.0, suitable for Models in Meters).

wall_offset
number <double> (Wall Offset) > 0
Default: 0

A number for the distance at which sensors close to walls should be removed. Note that this option has no effect unless the value is more than half of the dimension.

dir_count
integer <int32> (Dir Count) > 0
Default: 8

A positive integer for the number of radial directions to be generated around each position.

start_vector
Array of numbers <double> (Start Vector) = 3 items [ items <double > ]

A vector as 3 (x, y, z) values to set the start direction of the generated directions. This can be used to orient the resulting sensors to specific parts of the scene. It can also change the elevation of the resulting directions since this start vector will always be rotated in the XY plane to generate the resulting directions.

Autocalculate (object) or Mesh Radius (number) (Mesh Radius)
Default: {"type":"Autocalculate"}

An optional number to override the radius of the meshes generated around each sensor. If Autocalculate, it will be equal to 45 percent of the grid dimension.

{
  • "type": "RoomRadialGridParameter",
  • "dimension": 0,
  • "include_mesh": true,
  • "offset": 1,
  • "wall_offset": 0,
  • "dir_count": 8,
  • "start_vector": [
    ],
  • "mesh_radius": {
    }
}

RoomRadiancePropertiesAbridged

type
string (Type) ^RoomRadiancePropertiesAbridged$
Default: "RoomRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier_set
string (Modifier Set)

An identifier for a unique Room-Assigned ModifierSet (default: None).

{
  • "type": "RoomRadiancePropertiesAbridged",
  • "modifier_set": "string"
}

Roughness

string (Roughness)
Enum: "VeryRough" "Rough" "MediumRough" "MediumSmooth" "Smooth" "VerySmooth"

Relative roughness of a particular material layer.

"VeryRough"

ScheduleDay

type
string (Type) ^ScheduleDay$
Default: "ScheduleDay"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

values
required
Array of numbers <double> (Values) [ items <double > ]

A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.

times
Array of integers (Times) [ items <int32 > = 2 items [ items <int32 > ] ]
Default: [0,0]

A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the "time of beginning" is a different convention than EnergyPlus, which uses "time until".

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleDay",
  • "identifier": "string",
  • "display_name": "string",
  • "values": [
    ],
  • "times": [
    ],
  • "interpolate": false
}

ScheduleFixedInterval

type
string (Type) ^ScheduleFixedInterval$
Default: "ScheduleFixedInterval"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

values
required
Array of numbers <double> (Values) [ 24 .. 527040 ] items [ items <double > ]

A list of timeseries values occuring at each timestep over the course of the simulation.

schedule_type_limit
object (Schedule Type Limit) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

timestep
integer <int32> (Timestep)
Default: 1

An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items [ items <int32 > ]
Default: [1,1]

A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

placeholder_value
number <double> (Placeholder Value)
Default: 0

A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleFixedInterval",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "values": [
    ],
  • "schedule_type_limit": {
    },
  • "timestep": 1,
  • "start_date": [
    ],
  • "placeholder_value": 0,
  • "interpolate": false
}

ScheduleFixedIntervalAbridged

type
string (Type) ^ScheduleFixedIntervalAbridged$
Default: "ScheduleFixedIntervalAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

values
required
Array of numbers <double> (Values) [ 24 .. 527040 ] items [ items <double > ]

A list of timeseries values occuring at each timestep over the course of the simulation.

schedule_type_limit
string (Schedule Type Limit) [ 1 .. 100 ] characters

Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

timestep
integer <int32> (Timestep)
Default: 1

An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items [ items <int32 > ]
Default: [1,1]

A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

placeholder_value
number <double> (Placeholder Value)
Default: 0

A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.

interpolate
boolean (Interpolate)
Default: false

Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.

{
  • "type": "ScheduleFixedIntervalAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "values": [
    ],
  • "schedule_type_limit": "string",
  • "timestep": 1,
  • "start_date": [
    ],
  • "placeholder_value": 0,
  • "interpolate": false
}

ScheduleNumericType

string (ScheduleNumericType)
Enum: "Continuous" "Discrete"

Designates how the range values are validated.

"Continuous"

ScheduleRuleAbridged

type
string (Type) ^ScheduleRuleAbridged$
Default: "ScheduleRuleAbridged"

A base class to use when there is no baseclass available to fall on.

schedule_day
required
string (Schedule Day) [ 1 .. 100 ] characters

The identifier of a ScheduleDay object associated with this rule.

apply_sunday
boolean (Apply Sunday)
Default: false

Boolean noting whether to apply schedule_day on Sundays.

apply_monday
boolean (Apply Monday)
Default: false

Boolean noting whether to apply schedule_day on Mondays.

apply_tuesday
boolean (Apply Tuesday)
Default: false

Boolean noting whether to apply schedule_day on Tuesdays.

apply_wednesday
boolean (Apply Wednesday)
Default: false

Boolean noting whether to apply schedule_day on Wednesdays.

apply_thursday
boolean (Apply Thursday)
Default: false

Boolean noting whether to apply schedule_day on Thursdays.

apply_friday
boolean (Apply Friday)
Default: false

Boolean noting whether to apply schedule_day on Fridays.

apply_saturday
boolean (Apply Saturday)
Default: false

Boolean noting whether to apply schedule_day on Saturdays.

start_date
Array of integers <int32> (Start Date) [ 2 .. 3 ] items [ items <int32 > ]
Default: [1,1]

A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

end_date
Array of integers <int32> (End Date) [ 2 .. 3 ] items [ items <int32 > ]
Default: [12,31]

A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).

{
  • "type": "ScheduleRuleAbridged",
  • "schedule_day": "string",
  • "apply_sunday": false,
  • "apply_monday": false,
  • "apply_tuesday": false,
  • "apply_wednesday": false,
  • "apply_thursday": false,
  • "apply_friday": false,
  • "apply_saturday": false,
  • "start_date": [
    ],
  • "end_date": [
    ]
}

ScheduleRuleset

type
string (Type) ^ScheduleRuleset$
Default: "ScheduleRuleset"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Day Schedules)

A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.

default_day_schedule
required
string (Default Day Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.

Array of objects (Schedule Rules)

A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.

holiday_schedule
string (Holiday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.

summer_designday_schedule
string (Summer Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.

winter_designday_schedule
string (Winter Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.

schedule_type_limit
object (Schedule Type Limit) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "ScheduleRuleset",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "day_schedules": [
    ],
  • "default_day_schedule": "string",
  • "schedule_rules": [
    ],
  • "holiday_schedule": "string",
  • "summer_designday_schedule": "string",
  • "winter_designday_schedule": "string",
  • "schedule_type_limit": {
    }
}

ScheduleRulesetAbridged

type
string (Type) ^ScheduleRulesetAbridged$
Default: "ScheduleRulesetAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Day Schedules)

A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.

default_day_schedule
required
string (Default Day Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.

Array of objects (Schedule Rules)

A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.

holiday_schedule
string (Holiday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.

summer_designday_schedule
string (Summer Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.

winter_designday_schedule
string (Winter Designday Schedule) [ 1 .. 100 ] characters

An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.

schedule_type_limit
string (Schedule Type Limit) [ 1 .. 100 ] characters

Identifier of a ScheduleTypeLimit that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.

{
  • "type": "ScheduleRulesetAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "day_schedules": [
    ],
  • "default_day_schedule": "string",
  • "schedule_rules": [
    ],
  • "holiday_schedule": "string",
  • "summer_designday_schedule": "string",
  • "winter_designday_schedule": "string",
  • "schedule_type_limit": "string"
}

ScheduleTypeLimit

type
string (Type) ^ScheduleTypeLimit$
Default: "ScheduleTypeLimit"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

NoLimit (object) or Lower Limit (number) (Lower Limit)
Default: {"type":"NoLimit"}

Lower limit for the schedule type or NoLimit.

NoLimit (object) or Upper Limit (number) (Upper Limit)
Default: {"type":"NoLimit"}

Upper limit for the schedule type or NoLimit.

numeric_type
string (ScheduleNumericType)
Default: "Continuous"
Enum: "Continuous" "Discrete"

Designates how the range values are validated.

unit_type
string (ScheduleUnitType)
Default: "Dimensionless"
Enum: "Dimensionless" "Temperature" "DeltaTemperature" "PrecipitationRate" "Angle" "ConvectionCoefficient" "ActivityLevel" "Velocity" "Capacity" "Power" "Availability" "Percent" "Control" "Mode"

An enumeration.

{
  • "type": "ScheduleTypeLimit",
  • "identifier": "string",
  • "display_name": "string",
  • "lower_limit": {
    },
  • "upper_limit": {
    },
  • "numeric_type": "Continuous",
  • "unit_type": "Dimensionless"
}

ScheduleUnitType

string (ScheduleUnitType)
Enum: "Dimensionless" "Temperature" "DeltaTemperature" "PrecipitationRate" "Angle" "ConvectionCoefficient" "ActivityLevel" "Velocity" "Capacity" "Power" "Availability" "Percent" "Control" "Mode"

An enumeration.

"Dimensionless"

ServiceHotWater

type
string (Type) ^ServiceHotWater$
Default: "ServiceHotWater"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_area
required
number <double> (Flow Per Area) >= 0

Number for the total volume flow rate of water per unit area of floor [L/h-m2].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

The schedule for the use of hot water over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.

target_temperature
number <double> (Target Temperature) > 0
Default: 60

Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.

sensible_fraction
number <double> (Sensible Fraction) [ 0 .. 1 ]
Default: 0.2

A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0.05

A number between 0 and 1 for the fraction of the total hot water load that is latent.

{
  • "type": "ServiceHotWater",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_area": 0,
  • "schedule": {
    },
  • "target_temperature": 60,
  • "sensible_fraction": 0.2,
  • "latent_fraction": 0.05
}

ServiceHotWaterAbridged

type
string (Type) ^ServiceHotWaterAbridged$
Default: "ServiceHotWaterAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_area
required
number <double> (Flow Per Area) >= 0

Number for the total volume flow rate of water per unit area of floor [L/h-m2].

schedule
required
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the hot water use over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the flow_per_area to yield a complete water usage profile.

target_temperature
number <double> (Target Temperature) > 0
Default: 60

Number for the target temperature of water out of the tap (C). This the temperature after hot water has been mixed with cold water from the water mains. The default is 60C, which essentially assumes that the flow_per_area on this object is only for water straight out of the water heater.

sensible_fraction
number <double> (Sensible Fraction) [ 0 .. 1 ]
Default: 0.2

A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.

latent_fraction
number <double> (Latent Fraction) [ 0 .. 1 ]
Default: 0.05

A number between 0 and 1 for the fraction of the total hot water load that is latent.

{
  • "type": "ServiceHotWaterAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_area": 0,
  • "schedule": "string",
  • "target_temperature": 60,
  • "sensible_fraction": 0.2,
  • "latent_fraction": 0.05
}

Setpoint

type
string (Type) ^Setpoint$
Default: "Setpoint"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Cooling Schedule)

Schedule for the cooling setpoint. The values in this schedule should be temperature in [C].

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Heating Schedule)

Schedule for the heating setpoint. The values in this schedule should be temperature in [C].

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Humidifying Schedule)

Schedule for the humidification setpoint. The values in this schedule should be in [%].

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Dehumidifying Schedule)

Schedule for the dehumidification setpoint. The values in this schedule should be in [%].

setpoint_cutout_difference
number <double> (Setpoint Cutout Difference) >= 0
Default: 0

An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached.

{
  • "type": "Setpoint",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "cooling_schedule": {
    },
  • "heating_schedule": {
    },
  • "humidifying_schedule": {
    },
  • "dehumidifying_schedule": {
    },
  • "setpoint_cutout_difference": 0
}

SetpointAbridged

type
string (Type) ^SetpointAbridged$
Default: "SetpointAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

cooling_schedule
required
string (Cooling Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the cooling setpoint. The values in this schedule should be temperature in [C].

heating_schedule
required
string (Heating Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the heating setpoint. The values in this schedule should be temperature in [C].

humidifying_schedule
string (Humidifying Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the humidification setpoint. The values in this schedule should be in [%].

dehumidifying_schedule
string (Dehumidifying Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the dehumidification setpoint. The values in this schedule should be in [%].

setpoint_cutout_difference
number <double> (Setpoint Cutout Difference) >= 0
Default: 0

An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached.

{
  • "type": "SetpointAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "cooling_schedule": "string",
  • "heating_schedule": "string",
  • "humidifying_schedule": "string",
  • "dehumidifying_schedule": "string",
  • "setpoint_cutout_difference": 0
}

Shade

type
string (Type) ^Shade$
Default: "Shade"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

geometry
required
object (Geometry) Recursive

A single planar face in 3D space.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

is_detached
boolean (Is Detached)
Default: false

Boolean to note whether this shade is detached from any of the other geometry in the model. Cases where this should be True include shade representing surrounding buildings or context. Note that this should always be False for shades assigned to parent objects.

{
  • "type": "Shade",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "geometry": {
    },
  • "properties": {
    },
  • "is_detached": false
}

ShadeConstruction

type
string (Type) ^ShadeConstruction$
Default: "ShadeConstruction"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

solar_reflectance
number <double> (Solar Reflectance) [ 0 .. 1 ]
Default: 0.2

A number for the solar reflectance of the construction.

visible_reflectance
number <double> (Visible Reflectance) [ 0 .. 1 ]
Default: 0.2

A number for the visible reflectance of the construction.

is_specular
boolean (Is Specular)
Default: false

Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.

{
  • "type": "ShadeConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "solar_reflectance": 0.2,
  • "visible_reflectance": 0.2,
  • "is_specular": false
}

ShadeEnergyPropertiesAbridged

type
string (Type) ^ShadeEnergyPropertiesAbridged$
Default: "ShadeEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction
string (Construction) [ 1 .. 100 ] characters

Identifier of a ShadeConstruction to set the reflectance and specularity of the Shade. If None, the construction is set by theparent Room construction_set, the Model global_construction_set or (in the case fo an orphaned shade) the EnergyPlus default of 0.2 diffuse reflectance.

transmittance_schedule
string (Transmittance Schedule) [ 1 .. 100 ] characters

Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.

pv_properties
object (Pv Properties) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "ShadeEnergyPropertiesAbridged",
  • "construction": "string",
  • "transmittance_schedule": "string",
  • "pv_properties": {
    }
}

ShadeLocation

string (ShadeLocation)
Enum: "Interior" "Between" "Exterior"

Choices for where a shade material is located in a window assembly.

"Interior"

ShadeModifierSet

type
string (Type) ^ShadeModifierSet$
Default: "ShadeModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "ShadeModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

ShadeModifierSetAbridged

type
string (Type) ^ShadeModifierSetAbridged$
Default: "ShadeModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "ShadeModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

ShadePropertiesAbridged

type
string (Type) ^ShadePropertiesAbridged$
Default: "ShadePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (ShadeEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (ShadeRadiancePropertiesAbridged) Recursive

Base class of Abridged Radiance Properties.

{
  • "type": "ShadePropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

ShadeRadiancePropertiesAbridged

type
string (Type) ^ShadeRadiancePropertiesAbridged$
Default: "ShadeRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier (default: None).

modifier_blk
string (Modifier Blk)

A string for a Honeybee Radiance Modifier to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

dynamic_group_identifier
string (Dynamic Group Identifier)

An optional string to note the dynamic group ' 'to which the Shade is a part of. Shades sharing the same ' 'dynamic_group_identifier will have their states change in unison. ' 'If None, the Shade is assumed to be static. (default: None).

Array of objects (States)

An optional list of abridged states (default: None).

{
  • "type": "ShadeRadiancePropertiesAbridged",
  • "modifier": "string",
  • "modifier_blk": "string",
  • "dynamic_group_identifier": "string",
  • "states": [
    ]
}

SHWEquipmentType

string (SHWEquipmentType)
Enum: "Gas_WaterHeater" "Electric_WaterHeater" "HeatPump_WaterHeater" "Gas_TanklessHeater" "Electric_TanklessHeater"

An enumeration.

"Gas_WaterHeater"

SHWSystem

type
string (Type) ^SHWSystem$
Default: "SHWSystem"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

equipment_type
string (SHWEquipmentType)
Default: "Gas_WaterHeater"
Enum: "Gas_WaterHeater" "Electric_WaterHeater" "HeatPump_WaterHeater" "Gas_TanklessHeater" "Electric_TanklessHeater"

An enumeration.

Heater Efficiency (number) or Autocalculate (object) (Heater Efficiency)
Default: {"type":"Autocalculate"}

A number for the efficiency of the heater within the system. For Gas systems, this is the efficiency of the burner. For HeatPump systems, this is the rated COP of the system. For electric systems, this should usually be set to 1. If set to Autocalculate, this value will automatically be set based on the equipment_type. Gas_WaterHeater - 0.8, Electric_WaterHeater - 1.0, HeatPump_WaterHeater - 3.5, Gas_TanklessHeater - 0.8, Electric_TanklessHeater - 1.0.

Ambient Condition (number) or Ambient Condition (string) (Ambient Condition)
Default: 22

A number for the ambient temperature in which the hot water tank is located [C]. This can also be the identifier of a Room in which the tank is located.

ambient_loss_coefficient
number <double> (Ambient Loss Coefficient)
Default: 6

A number for the loss of heat from the water heater tank to the surrounding ambient conditions [W/K].

{
  • "type": "SHWSystem",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "equipment_type": "Gas_WaterHeater",
  • "heater_efficiency": {
    },
  • "ambient_condition": 22,
  • "ambient_loss_coefficient": 6
}

SimpleWindowArea

type
string (Type) ^SimpleWindowArea$
Default: "SimpleWindowArea"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

window_area
required
number <double> (Window Area) > 0

A number for the window area in current model units. If this area is larger than the area of the Wall that it is appliedto, the window will fill the parent Wall at a 99 percent ratio.

{
  • "type": "SimpleWindowArea",
  • "user_data": { },
  • "window_area": 0
}

SimpleWindowRatio

type
string (Type) ^SimpleWindowRatio$
Default: "SimpleWindowRatio"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

window_ratio
required
number <double> (Window Ratio) ( 0 .. 1 )

A number between 0 and 1 for the ratio between the window area and the parent wall surface area.

{
  • "type": "SimpleWindowRatio",
  • "user_data": { },
  • "window_ratio": 0
}

SingleWindow

type
string (Type) ^SingleWindow$
Default: "SingleWindow"

A base class to use when there is no baseclass available to fall on.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list). When a list is used, each item in the list will be assigned to the generated Honeybee apertures.

width
required
number <double> (Width) > 0

A number for the window width. Note that, if this width is applied to a wall that is too narrow for this width, the generated window will automatically be shortened when it is applied to the wall. In this way, setting the width to be float("inf") will create parameters that always generate a ribbon window.

height
required
number <double> (Height) > 0

A number for the window height. Note that, if this height is applied to a wall that is too short for this height, the generated window will automatically be shortened when it is applied to the wall.

sill_height
number <double> (Sill Height) > 0
Default: 1

A number for the window sill height.

{
  • "type": "SingleWindow",
  • "user_data": { },
  • "width": 0,
  • "height": 0,
  • "sill_height": 1
}

SlatOrientation

string (SlatOrientation)
Enum: "Horizontal" "Vertical"

An enumeration.

"Horizontal"

StateGeometryAbridged

type
string (Type) ^StateGeometryAbridged$
Default: "StateGeometryAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

geometry
required
object (Geometry) Recursive

A single planar face in 3D space.

modifier
string (Modifier)

A string for a Honeybee Radiance Modifier identifier (default: None).

modifier_direct
string (Modifier Direct)

A string for Honeybee Radiance Modifier identifiers to be used in direct solar simulations and in isolation studies (assessingthe contribution of individual objects) (default: None).

{
  • "type": "StateGeometryAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "geometry": {
    },
  • "modifier": "string",
  • "modifier_direct": "string"
}

Story

type
string (Type) ^Story$
Default: "Story"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[.A-Za-z0-9_-]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, rad). This identifier is also used to reference the object across a Model. It must be < 100 characters and not contain any spaces or special characters.

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Room 2Ds)

An array of dragonfly Room2D objects that together form an entire story of a building.

properties
required
object (Properties) Recursive

Extension properties for particular simulation engines (Radiance, EnergyPlus).

Autocalculate (object) or Floor To Floor Height (number) (Floor To Floor Height)
Default: {"type":"Autocalculate"}

A number for the distance from the floor plate of this story to the floor of the story above this one (if it exists). If Autocalculate, this value will be the maximum floor_to_ceiling_height of the input room_2ds.

Autocalculate (object) or Floor Height (number) (Floor Height)
Default: {"type":"Autocalculate"}

A number to indicate the height of the floor plane in the Z axis.If Autocalculate, this will be the minimum floor height of all the room_2ds, which is suitable for cases where there are no floor plenums.

multiplier
integer <int32> (Multiplier) >= 1
Default: 1

An integer that denotes the number of times that this Story is repeated over the height of the building.

roof
object (Roof) Recursive

Geometry for specifying sloped roofs over a Story.

{
  • "type": "Story",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "room_2ds": [
    ],
  • "properties": {
    },
  • "floor_to_floor_height": {
    },
  • "floor_height": {
    },
  • "multiplier": 1,
  • "roof": {
    }
}

StoryEnergyPropertiesAbridged

type
string (Type) ^StoryEnergyPropertiesAbridged$
Default: "StoryEnergyPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

construction_set
string (Construction Set) [ 1 .. 100 ] characters

Name of a ConstructionSet to specify all constructions for the Story. If None, the Story will use the Building construction_set or the Model global_construction_set. Any ConstructionSet assigned here will override those assigned to these objects.

{
  • "type": "StoryEnergyPropertiesAbridged",
  • "construction_set": "string"
}

StoryPropertiesAbridged

type
string (Type) ^StoryPropertiesAbridged$
Default: "StoryPropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

energy
object (StoryEnergyPropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

radiance
object (StoryRadiancePropertiesAbridged) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "StoryPropertiesAbridged",
  • "energy": {
    },
  • "radiance": {
    }
}

StoryRadiancePropertiesAbridged

type
string (Type) ^StoryRadiancePropertiesAbridged$
Default: "StoryRadiancePropertiesAbridged"

A base class to use when there is no baseclass available to fall on.

modifier_set
string (Modifier Set)

Name of a ModifierSet to specify all modifiers for the Story. If None, the Story will use the Building modifier_set or the Model global_modifier_set. Any ModifierSet assigned here will override those assigned to the parent objects.

{
  • "type": "StoryRadiancePropertiesAbridged",
  • "modifier_set": "string"
}

Surface

type
string (Type) ^Surface$
Default: "Surface"

A base class to use when there is no baseclass available to fall on.

boundary_condition_objects
required
Array of strings (Boundary Condition Objects) [ 2 .. 3 ] items

A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.

{
  • "type": "Surface",
  • "boundary_condition_objects": [
    ]
}

Trans

type
string (Type) ^Trans$
Default: "Trans"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) non-empty ^[.A-Za-z0-9_-]+$

Text string for a unique Radiance object. Must not contain spaces or special characters. This will be used to identify the object across a model and in the exported Radiance files.

display_name
string (Display Name)

Display name of the object with no character restrictions.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Modifier)
Default: {"type":"Void"}

Material modifier.

Array of Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Dependencies)

List of modifiers that this modifier depends on. This argument is only useful for defining advanced modifiers where the modifier is defined based on other modifiers.

r_reflectance
number <double> (R Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the red channel reflectance.

g_reflectance
number <double> (G Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the green channel reflectance.

b_reflectance
number <double> (B Reflectance) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the blue channel reflectance.

specularity
number <double> (Specularity) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials.

roughness
number <double> (Roughness) [ 0 .. 1 ]
Default: 0

A value between 0 and 1 for the roughness, specified as the RMS slope of surface facets. Roughness greater than 0.2 are not realistic.

transmitted_diff
number <double> (Transmitted Diff) [ 0 .. 1 ]
Default: 0

The fraction of transmitted light that is transmitted diffusely in a scattering fashion.

transmitted_spec
number <double> (Transmitted Spec) [ 0 .. 1 ]
Default: 0

The fraction of transmitted light that is not diffusely scattered.

{
  • "type": "Trans",
  • "identifier": "string",
  • "display_name": "string",
  • "modifier": {
    },
  • "dependencies": [
    ],
  • "r_reflectance": 0,
  • "g_reflectance": 0,
  • "b_reflectance": 0,
  • "specularity": 0,
  • "roughness": 0,
  • "transmitted_diff": 0,
  • "transmitted_spec": 0
}

Units

string (Units)
Enum: "Meters" "Millimeters" "Feet" "Inches" "Centimeters"

An enumeration.

"Meters"

VAV

type
string (Type) ^VAV$
Default: "VAV"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

economizer_type
string (AllAirEconomizerType)
Default: "NoEconomizer"
Enum: "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy" "DifferentialDryBulbAndEnthalpy" "FixedDryBulb" "FixedEnthalpy" "ElectronicEnthalpy"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

equipment_type
string (VAVEquipmentType)
Default: "VAV_Chiller_Boiler"
Enum: "VAV_Chiller_Boiler" "VAV_Chiller_ASHP" "VAV_Chiller_DHW" "VAV_Chiller_PFP" "VAV_Chiller_GasCoil" "VAV_ACChiller_Boiler" "VAV_ACChiller_ASHP" "VAV_ACChiller_DHW" "VAV_ACChiller_PFP" "VAV_ACChiller_GasCoil" "VAV_DCW_Boiler" "VAV_DCW_ASHP" "VAV_DCW_DHW" "VAV_DCW_PFP" "VAV_DCW_GasCoil"

An enumeration.

{
  • "type": "VAV",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "economizer_type": "NoEconomizer",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "equipment_type": "VAV_Chiller_Boiler"
}

VAVEquipmentType

string (VAVEquipmentType)
Enum: "VAV_Chiller_Boiler" "VAV_Chiller_ASHP" "VAV_Chiller_DHW" "VAV_Chiller_PFP" "VAV_Chiller_GasCoil" "VAV_ACChiller_Boiler" "VAV_ACChiller_ASHP" "VAV_ACChiller_DHW" "VAV_ACChiller_PFP" "VAV_ACChiller_GasCoil" "VAV_DCW_Boiler" "VAV_DCW_ASHP" "VAV_DCW_DHW" "VAV_DCW_PFP" "VAV_DCW_GasCoil"

An enumeration.

"VAV_Chiller_Boiler"

Ventilation

type
string (Type) ^Ventilation$
Default: "Ventilation"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_person
number <double> (Flow Per Person) >= 0
Default: 0

Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.

flow_per_area
number <double> (Flow Per Area) >= 0
Default: 0

Intensity of ventilation in [m3/s per m2 of floor area].

air_changes_per_hour
number <double> (Air Changes Per Hour) >= 0
Default: 0

Intensity of ventilation in air changes per hour (ACH) for the entire Room.

flow_per_zone
number <double> (Flow Per Zone) >= 0
Default: 0

Intensity of ventilation in m3/s for the entire Room.

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

Schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.

{
  • "type": "Ventilation",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_person": 0,
  • "flow_per_area": 0,
  • "air_changes_per_hour": 0,
  • "flow_per_zone": 0,
  • "schedule": {
    }
}

VentilationAbridged

type
string (Type) ^VentilationAbridged$
Default: "VentilationAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

flow_per_person
number <double> (Flow Per Person) >= 0
Default: 0

Intensity of ventilation in[] m3/s per person]. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the Room.

flow_per_area
number <double> (Flow Per Area) >= 0
Default: 0

Intensity of ventilation in [m3/s per m2 of floor area].

air_changes_per_hour
number <double> (Air Changes Per Hour) >= 0
Default: 0

Intensity of ventilation in air changes per hour (ACH) for the entire Room.

flow_per_zone
number <double> (Flow Per Zone) >= 0
Default: 0

Intensity of ventilation in m3/s for the entire Room.

schedule
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile.

{
  • "type": "VentilationAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "flow_per_person": 0,
  • "flow_per_area": 0,
  • "air_changes_per_hour": 0,
  • "flow_per_zone": 0,
  • "schedule": "string"
}

VentilationControlAbridged

type
string (Type) ^VentilationControlAbridged$
Default: "VentilationControlAbridged"

A base class to use when there is no baseclass available to fall on.

min_indoor_temperature
number <double> (Min Indoor Temperature) [ -100 .. 100 ]
Default: -100

A number for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation.

max_indoor_temperature
number <double> (Max Indoor Temperature) [ -100 .. 100 ]
Default: 100

A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a maximum temperature at which point ventilation is stopped and a cooling system is turned on.

min_outdoor_temperature
number <double> (Min Outdoor Temperature) [ -100 .. 100 ]
Default: -100

A number for the minimum outdoor temperature at which to ventilate in Celsius. This can be used to ensure ventilative cooling does not happen during the winter even if the Room is above the min_indoor_temperature.

max_outdoor_temperature
number <double> (Max Outdoor Temperature) [ -100 .. 100 ]
Default: 100

A number for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a limit for when it is considered too hot outside for ventilative cooling.

delta_temperature
number <double> (Delta Temperature) [ -100 .. 100 ]
Default: -100

A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a positive number so that ventilation only occurs when the outdoors is cooler than the indoors. Negative numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.

schedule
string (Schedule) [ 1 .. 100 ] characters

Identifier of the schedule for the ventilation over the course of the year. Note that this is applied on top of any setpoints. The type of this schedule should be On/Off and values should be either 0 (no possibility of ventilation) or 1 (ventilation possible).

{
  • "type": "VentilationControlAbridged",
  • "min_indoor_temperature": -100,
  • "max_indoor_temperature": 100,
  • "min_outdoor_temperature": -100,
  • "max_outdoor_temperature": 100,
  • "delta_temperature": -100,
  • "schedule": "string"
}

VentilationFan

type
string (Type) ^VentilationFan$
Default: "VentilationFan"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

flow_rate
required
number <double> (Flow Rate) > 0

A number for the flow rate of the fan in m3/s.

pressure_rise
required
number <double> (Pressure Rise) > 0

A number for the the pressure rise across the fan in Pascals (N/m2). This is often a function of the fan speed and the conditions in which the fan is operating since having the fan blow air through filters or narrow ducts will increase the pressure rise that is needed to deliver the input flow rate. The pressure rise plays an important role in determining the amount of energy consumed by the fan. Smaller fans like a 0.05 m3/s desk fan tend to have lower pressure rises around 60 Pa. Larger fans, such as a 6 m3/s fan used for ventilating a large room tend to have higher pressure rises around 400 Pa. The highest pressure rises are typically for large fans blowing air through ducts and filters, which can have pressure rises as high as 1000 Pa.

efficiency
required
number <double> (Efficiency) [ 0 .. 1 ]

A number between 0 and 1 for the overall efficiency of the fan. Specifically, this is the ratio of the power delivered to the fluid to the electrical input power. It is the product of the fan motor efficiency and the fan impeller efficiency. Fans that have a higher blade diameter and operate at lower speeds with smaller pressure rises for their size tend to have higher efficiencies. Because motor efficiencies are typically between 0.8 and 0.9, the best overall fan efficiencies tend to be around 0.7 with most typical fan efficiencies between 0.5 and 0.7. The lowest efficiencies often happen for small fans in situations with high pressure rises for their size, which can result in efficiencies as low as 0.15.

ventilation_type
string (VentilationType)
Default: "Balanced"
Enum: "Exhaust" "Intake" "Balanced"

An enumeration.

control
object (Control) Recursive

Base class for all objects that are not extensible with additional keys.

This effectively includes all objects except for the Properties classes that are assigned to geometry objects.

{
  • "type": "VentilationFan",
  • "identifier": "string",
  • "display_name": "string",
  • "flow_rate": 0,
  • "pressure_rise": 0,
  • "efficiency": 1,
  • "ventilation_type": "Balanced",
  • "control": {
    }
}

VentilationOpening

type
string (Type) ^VentilationOpening$
Default: "VentilationOpening"

A base class to use when there is no baseclass available to fall on.

fraction_area_operable
number <double> (Fraction Area Operable) [ 0 .. 1 ]
Default: 0.5

A number for the fraction of the window area that is operable.

fraction_height_operable
number <double> (Fraction Height Operable) [ 0 .. 1 ]
Default: 1

A number for the fraction of the distance from the bottom of the window to the top that is operable

discharge_coefficient
number <double> (Discharge Coefficient) [ 0 .. 1 ]
Default: 0.45

A number that will be multiplied by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.

wind_cross_vent
boolean (Wind Cross Vent)
Default: false

Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation.

flow_coefficient_closed
number <double> (Flow Coefficient Closed) >= 0
Default: 0

An optional number in kg/s-m, at 1 Pa per meter of crack length, used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. The DesignBuilder Cracks template defines the flow coefficient for a tight, low-leakage closed external window to be 0.00001, and the flow coefficient for a very poor, high-leakage closed external window to be 0.003.

flow_exponent_closed
number <double> (Flow Exponent Closed) [ 0.5 .. 1 ]
Default: 0.65

An optional dimensionless number between 0.5 and 1 used to calculate the mass flow rate when the opening is closed; required to run an AirflowNetwork simulation. This value represents the leak geometry impact on airflow, with 0.5 generally corresponding to turbulent orifice flow and 1 generally corresponding to laminar flow. The default of 0.65 is representative of many cases of wall and window leakage, used when the exponent cannot be measured.

two_way_threshold
number <double> (Two Way Threshold) > 0
Default: 0.0001

A number in kg/m3 indicating the minimum density difference above which two-way flow may occur due to stack effect, required to run an AirflowNetwork simulation. This value is required because the air density difference between two zones (which drives two-way air flow) will tend towards division by zero errors as the air density difference approaches zero. The default of 0.0001 is a typical default value used for AirflowNetwork openings.

{
  • "type": "VentilationOpening",
  • "fraction_area_operable": 0.5,
  • "fraction_height_operable": 1,
  • "discharge_coefficient": 0.45,
  • "wind_cross_vent": false,
  • "flow_coefficient_closed": 0,
  • "flow_exponent_closed": 0.65,
  • "two_way_threshold": 0.0001
}

VentilationType

string (VentilationType)
Enum: "Exhaust" "Intake" "Balanced"

An enumeration.

"Exhaust"

Vintages

string (Vintages)
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

"ASHRAE_2019"

Void

type
string (Type) ^Void$
Default: "Void"

A base class to use when there is no baseclass available to fall on.

{
  • "type": "Void"
}

VRF

type
string (Type) ^VRF$
Default: "VRF"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (VRFEquipmentType)
Default: "VRF"
Value: "VRF"

An enumeration.

{
  • "type": "VRF",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "VRF"
}

VRFEquipmentType

string (VRFEquipmentType)
Value: "VRF"

An enumeration.

"VRF"

VRFwithDOASAbridged

type
string (Type) ^VRFwithDOASAbridged$
Default: "VRFwithDOASAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

doas_availability_schedule
string (Doas Availability Schedule) [ 1 .. 100 ] characters

An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.

equipment_type
string (VRFwithDOASEquipmentType)
Default: "DOAS_VRF"
Value: "DOAS_VRF"

An enumeration.

{
  • "type": "VRFwithDOASAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "doas_availability_schedule": "string",
  • "equipment_type": "DOAS_VRF"
}

VRFwithDOASEquipmentType

string (VRFwithDOASEquipmentType)
Value: "DOAS_VRF"

An enumeration.

"DOAS_VRF"

WallConstructionSet

type
string (Type) ^WallConstructionSet$
Default: "WallConstructionSet"

A base class to use when there is no baseclass available to fall on.

interior_construction
object (Interior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

exterior_construction
object (Exterior Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

ground_construction
object (Ground Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "WallConstructionSet",
  • "interior_construction": {
    },
  • "exterior_construction": {
    },
  • "ground_construction": {
    }
}

WallConstructionSetAbridged

type
string (Type) ^WallConstructionSetAbridged$
Default: "WallConstructionSetAbridged"

A base class to use when there is no baseclass available to fall on.

interior_construction
string (Interior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.

exterior_construction
string (Exterior Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.

ground_construction
string (Ground Construction) [ 1 .. 100 ] characters

Identifier for an OpaqueConstruction for faces with a Ground boundary condition.

{
  • "type": "WallConstructionSetAbridged",
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string"
}

WallModifierSet

type
string (Type) ^WallModifierSet$
Default: "WallModifierSet"

A base class to use when there is no baseclass available to fall on.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Exterior Modifier)

A radiance modifier object for faces with an Outdoors boundary condition.

Plastic (object) or Glass (object) or BSDF (object) or Glow (object) or Light (object) or Trans (object) or Metal (object) or Void (object) or Mirror (object) (Interior Modifier)

A radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "WallModifierSet",
  • "exterior_modifier": {
    },
  • "interior_modifier": {
    }
}

WallModifierSetAbridged

type
string (Type) ^WallModifierSetAbridged$
Default: "WallModifierSetAbridged"

A base class to use when there is no baseclass available to fall on.

exterior_modifier
string (Exterior Modifier)

Identifier for a radiance modifier object for faces with an Outdoors boundary condition.

interior_modifier
string (Interior Modifier)

Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.

{
  • "type": "WallModifierSetAbridged",
  • "exterior_modifier": "string",
  • "interior_modifier": "string"
}

WindowAC

type
string (Type) ^WindowAC$
Default: "WindowAC"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (WindowACEquipmentType)
Default: "WindowAC_ElectricBaseboard"
Enum: "WindowAC_ElectricBaseboard" "WindowAC_BoilerBaseboard" "WindowAC_ASHPBaseboard" "WindowAC_DHWBaseboard" "WindowAC_Furnace" "WindowAC_GasHeaters" "WindowAC"

An enumeration.

{
  • "type": "WindowAC",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "WindowAC_ElectricBaseboard"
}

WindowACEquipmentType

string (WindowACEquipmentType)
Enum: "WindowAC_ElectricBaseboard" "WindowAC_BoilerBaseboard" "WindowAC_ASHPBaseboard" "WindowAC_DHWBaseboard" "WindowAC_Furnace" "WindowAC_GasHeaters" "WindowAC"

An enumeration.

"WindowAC_ElectricBaseboard"

WindowConstruction

type
string (Type) ^WindowConstruction$
Default: "WindowConstruction"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of EnergyWindowMaterialSimpleGlazSys (object) or EnergyWindowMaterialGlazing (object) or EnergyWindowMaterialGas (object) or EnergyWindowMaterialGasCustom (object) or EnergyWindowMaterialGasMixture (object) (Materials) [ 1 .. 8 ] items

List of glazing and gas material definitions. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.

frame
object (Frame) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

{
  • "type": "WindowConstruction",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "materials": [
    ],
  • "frame": {
    }
}

WindowConstructionAbridged

type
string (Type) ^WindowConstructionAbridged$
Default: "WindowConstructionAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

materials
required
Array of strings (Materials) [ 1 .. 8 ] items [ items [ 1 .. 100 ] characters ]

List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.

frame
string (Frame) [ 1 .. 100 ] characters

An optional identifier for a frame material that surrounds the window construction.

{
  • "type": "WindowConstructionAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "materials": [
    ],
  • "frame": "string"
}

WindowConstructionDynamic

type
string (Type) ^WindowConstructionDynamic$
Default: "WindowConstructionDynamic"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

required
Array of objects (Constructions)

A list of WindowConstruction objects that define the various states that the dynamic window can assume.

required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

A control schedule that dictates which constructions are active at given times throughout the simulation. The values of the schedule should be integers and range from 0 to one less then the number of constructions. Zero indicates that the first construction is active, one indicates that the second on is active, etc. The schedule type limits of this schedule should be "Control Level." If building custom schedule type limits that describe a particular range of states, the type limits should be "Discrete" and the unit type should be "Mode," "Control," or some other fractional unit.

{
  • "type": "WindowConstructionDynamic",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "constructions": [
    ],
  • "schedule": {
    }
}

WindowConstructionShade

type
string (Type) ^WindowConstructionShade$
Default: "WindowConstructionShade"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

window_construction
required
object (Window Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

required
EnergyWindowMaterialShade (object) or EnergyWindowMaterialBlind (object) or EnergyWindowMaterialGlazing (object) (Shade Material)

Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.

shade_location
string (ShadeLocation)
Default: "Interior"
Enum: "Interior" "Between" "Exterior"

Choices for where a shade material is located in a window assembly.

control_type
string (ControlType)
Default: "AlwaysOn"
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Choices for how the shading device is controlled.

setpoint
number <double> (Setpoint)

A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except "AlwaysOn."

ScheduleRuleset (object) or ScheduleFixedInterval (object) (Schedule)

An optional ScheduleRuleset or ScheduleFixedInterval to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.

{
  • "type": "WindowConstructionShade",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "window_construction": {
    },
  • "shade_material": {
    },
  • "shade_location": "Interior",
  • "control_type": "AlwaysOn",
  • "setpoint": 0,
  • "schedule": {
    }
}

WindowConstructionShadeAbridged

type
string (Type) ^WindowConstructionShadeAbridged$
Default: "WindowConstructionShadeAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

window_construction
required
object (Window Construction) Recursive

Base class for all objects requiring a valid EnergyPlus identifier.

shade_material
required
string (Shade Material) [ 1 .. 100 ] characters

Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.

shade_location
string (ShadeLocation)
Default: "Interior"
Enum: "Interior" "Between" "Exterior"

Choices for where a shade material is located in a window assembly.

control_type
string (ControlType)
Default: "AlwaysOn"
Enum: "AlwaysOn" "OnIfHighSolarOnWindow" "OnIfHighHorizontalSolar" "OnIfHighOutdoorAirTemperature" "OnIfHighZoneAirTemperature" "OnIfHighZoneCooling" "OnNightIfLowOutdoorTempAndOffDay" "OnNightIfLowInsideTempAndOffDay" "OnNightIfHeatingAndOffDay"

Choices for how the shading device is controlled.

setpoint
number <double> (Setpoint)

A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except "AlwaysOn."

schedule
string (Schedule) [ 1 .. 100 ] characters

An optional schedule identifier to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.

{
  • "type": "WindowConstructionShadeAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "window_construction": {
    },
  • "shade_material": "string",
  • "shade_location": "Interior",
  • "control_type": "AlwaysOn",
  • "setpoint": 0,
  • "schedule": "string"
}

WSHP

type
string (Type) ^WSHP$
Default: "WSHP"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

equipment_type
string (WSHPEquipmentType)
Default: "WSHP_FluidCooler_Boiler"
Enum: "WSHP_FluidCooler_Boiler" "WSHP_CoolingTower_Boiler" "WSHP_GSHP" "WSHP_DCW_DHW"

An enumeration.

{
  • "type": "WSHP",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "equipment_type": "WSHP_FluidCooler_Boiler"
}

WSHPEquipmentType

string (WSHPEquipmentType)
Enum: "WSHP_FluidCooler_Boiler" "WSHP_CoolingTower_Boiler" "WSHP_GSHP" "WSHP_DCW_DHW"

An enumeration.

"WSHP_FluidCooler_Boiler"

WSHPwithDOASAbridged

type
string (Type) ^WSHPwithDOASAbridged$
Default: "WSHPwithDOASAbridged"

A base class to use when there is no baseclass available to fall on.

identifier
required
string (Identifier) [ 1 .. 100 ] characters ^[^,;!\n\t]+$

Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \n \t).

display_name
string (Display Name)

Display name of the object with no character restrictions.

user_data
object (User Data)

Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).

vintage
string (Vintages)
Default: "ASHRAE_2019"
Enum: "ASHRAE_2019" "ASHRAE_2016" "ASHRAE_2013" "ASHRAE_2010" "ASHRAE_2007" "ASHRAE_2004" "DOE_Ref_1980_2004" "DOE_Ref_Pre_1980"

An enumeration.

sensible_heat_recovery
number <double> (Sensible Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.

latent_heat_recovery
number <double> (Latent Heat Recovery) [ 0 .. 1 ]
Default: 0

A number between 0 and 1 for the effectiveness of latent heat recovery within the system.

demand_controlled_ventilation
boolean (Demand Controlled Ventilation)
Default: false

Boolean to note whether demand controlled ventilation should be used on the system, which will vary the amount of ventilation air according to the occupancy schedule of the Rooms.

doas_availability_schedule
string (Doas Availability Schedule) [ 1 .. 100 ] characters

An optional On/Off discrete schedule to set when the dedicated outdoor air system (DOAS) shuts off. This will not only prevent any outdoor air from flowing thorough the system but will also shut off the fans, which can result in more energy savings when spaces served by the DOAS are completely unoccupied. If None, the DOAS will be always on.

equipment_type
string (WSHPwithDOASEquipmentType)
Default: "DOAS_WSHP_FluidCooler_Boiler"
Enum: "DOAS_WSHP_FluidCooler_Boiler" "DOAS_WSHP_CoolingTower_Boiler" "DOAS_WSHP_GSHP" "DOAS_WSHP_DCW_DHW"

An enumeration.

{
  • "type": "WSHPwithDOASAbridged",
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "vintage": "ASHRAE_2019",
  • "sensible_heat_recovery": 0,
  • "latent_heat_recovery": 0,
  • "demand_controlled_ventilation": false,
  • "doas_availability_schedule": "string",
  • "equipment_type": "DOAS_WSHP_FluidCooler_Boiler"
}

WSHPwithDOASEquipmentType

string (WSHPwithDOASEquipmentType)
Enum: "DOAS_WSHP_FluidCooler_Boiler" "DOAS_WSHP_CoolingTower_Boiler" "DOAS_WSHP_GSHP" "DOAS_WSHP_DCW_DHW"

An enumeration.

"DOAS_WSHP_FluidCooler_Boiler"