Honeybee Model Schema (1.34.3)

Download OpenAPI specification:Download

This is the documentation for Honeybee model schema.

_EquipmentBase

identifier
required
string (Identifier) [ 1 .. 100 ] characters

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
string ^IDdEnergyBaseModel$
Default: "IDdEnergyBaseModel"
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 electric 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 electricequipment. 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.

Copy
Expand all Collapse all
{
  • "identifier": "string",
  • "display_name": "string",
  • "type": "_EquipmentBase",
  • "watts_per_area": 0,
  • "schedule": "string",
  • "radiant_fraction": 0,
  • "latent_fraction": 0,
  • "lost_fraction": 0
}

_FaceSubSet

interior_construction
object (Interior Construction)

An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.

exterior_construction
object (Exterior Construction)

An OpaqueConstruction for walls with an Outdoors boundary condition.

ground_construction
object (Ground Construction)

An OpaqueConstruction for walls with a Ground boundary condition.

type
string (Type) ^_FaceSubSet$
Default: "_FaceSubSet"
Copy
Expand all Collapse all
{
  • "interior_construction":
    {
    },
  • "exterior_construction":
    {
    },
  • "ground_construction":
    {
    },
  • "type": "_FaceSubSet"
}

_FaceSubSetAbridged

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
string (Type) ^_FaceSubSetAbridged$
Default: "_FaceSubSetAbridged"
Copy
Expand all Collapse all
{
  • "interior_construction": "string",
  • "exterior_construction": "string",
  • "ground_construction": "string",
  • "type": "_FaceSubSetAbridged"
}

_PropertiesBaseAbridged

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
string (Type) ^_PropertiesBaseAbridged$
Default: "_PropertiesBaseAbridged"
Copy
Expand all Collapse all
{
  • "modifier": "string",
  • "modifier_blk": "string",
  • "type": "_PropertiesBaseAbridged"
}

Adiabatic

type
string (Type) ^Adiabatic$
Default: "Adiabatic"
Copy
Expand all Collapse all
{
  • "type": "Adiabatic"
}

AirBoundaryConstruction

identifier
required
string (Identifier) [ 1 .. 100 ] characters

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
string ^IDdEnergyBaseModel$
Default: "IDdEnergyBaseModel"
air_mixing_schedule
required
ScheduleRuleset (object) or ScheduleFixedInterval (object) (Air Mixing Schedule)

A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.

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.

Copy
Expand all Collapse all
{
  • "identifier": "string",
  • "display_name": "string",
  • "type": "AirBoundaryConstruction",
  • "air_mixing_schedule":
    {
    },
  • "air_mixing_per_area": 0.1
}

AirBoundaryConstructionAbridged

identifier
required
string (Identifier) [ 1 .. 100 ] characters

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
string ^IDdEnergyBaseModel$
Default: "IDdEnergyBaseModel"
air_mixing_schedule
required
string (Air Mixing Schedule) [ 1 .. 100 ] characters

Identifier of a fractional schedule for the air mixing schedule across the construction.

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.

Copy
Expand all Collapse all
{
  • "identifier": "string",
  • "display_name": "string",
  • "type": "AirBoundaryConstructionAbridged",
  • "air_mixing_schedule": "string",
  • "air_mixing_per_area": 0.1
}

Aperture

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
string ^IDdBaseModel$
Default: "IDdBaseModel"
geometry
required
object (Geometry)

Planar Face3D for the geometry.

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

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.

indoor_shades
Array of objects (Indoor Shades)

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

outdoor_shades
Array of objects (Outdoor Shades)

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

Copy
Expand all Collapse all
{
  • "identifier": "string",
  • "display_name": "string",
  • "user_data": { },
  • "type": "Aperture",
  • "geometry":
    {