Honeybee Model Schema (1.38.3)

Download OpenAPI specification:Download

This is the documentation for Honeybee model schema.

_AllAirBase

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"
vintage
string (Vintages)
Enum: "90.1-2013" "90.1-2010" "90.1-2007" "90.1-2004" "DOE Ref 1980-2004" "DOE Ref Pre-1980"

An enumeration.

economizer_type
string (AllAirEconomizerType)
Enum: "Inferred" "NoEconomizer" "DifferentialDryBulb" "DifferentialEnthalpy"

An enumeration.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

{
  • "identifier": "string",
  • "display_name": "string",
  • "type": "_AllAirBase",
  • "vintage": "90.1-2013",
  • "economizer_type": "Inferred",
  • "sensible_heat_recovery":
    {
    },
  • "latent_heat_recovery":
    {
    }
}

_DOASBase

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"
vintage
string (Vintages)
Enum: "90.1-2013" "90.1-2010" "90.1-2007" "90.1-2004" "DOE Ref 1980-2004" "DOE Ref Pre-1980"

An enumeration.

Autosize (object) or number (Sensible Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of sensible heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

Autosize (object) or number (Latent Heat Recovery)
Default: {"type":"Autosize"}

A number between 0 and 1 for the effectiveness of latent heat recovery within the system. If None or Autosize, it will be whatever is recommended for the given vintage.

{
  • "identifier": "string",
  • "display_name": "string",
  • "type": "_DOASBase",
  • "vintage": "90.1-2013",
  • "sensible_heat_recovery":
    {
    },
  • "latent_heat_recovery":
    {
    }
}

_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.

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

_FaceSubSet

object (Interior Construction)

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

object (Exterior Construction)

An OpaqueConstruction for walls with an Outdoors boundary condition.

object (Ground Construction)

An OpaqueConstruction for walls with a Ground boundary condition.

type
string (Type) ^_FaceSubSet$
Default: "_FaceSubSet"
{
  • "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"
{
  • "interior_construction": "string",
  • "exterior_construction": "string"