{
"openapi": "3.0.2",
"servers": [],
"info": {
"description": "This is the documentation for Honeybee model schema.",
"version": "1.36.0",
"title": "Honeybee Model Schema",
"contact": {
"name": "Ladybug Tools",
"email": "info@ladybug.tools",
"url": "https://github.com/ladybug-tools/honeybee-schema"
},
"x-logo": {
"url": "https://www.ladybug.tools/assets/img/honeybee-large.png",
"altText": "Honeybee logo"
},
"license": {
"name": "BSD",
"url": "https://github.com/ladybug-tools-in2/honeybee-schema/blob/master/LICENSE"
}
},
"externalDocs": {
"description": "OpenAPI Specification with Inheritance",
"url": "./model_inheritance.json"
},
"tags": [
{
"name": "adiabatic_model",
"x-displayName": "Adiabatic",
"description": "\n"
},
{
"name": "airboundaryconstruction_model",
"x-displayName": "AirBoundaryConstruction",
"description": "\n"
},
{
"name": "airboundaryconstructionabridged_model",
"x-displayName": "AirBoundaryConstructionAbridged",
"description": "\n"
},
{
"name": "allaireconomizertype_model",
"x-displayName": "AllAirEconomizerType",
"description": "\n"
},
{
"name": "aperture_model",
"x-displayName": "Aperture",
"description": "\n"
},
{
"name": "apertureconstructionset_model",
"x-displayName": "ApertureConstructionSet",
"description": "\n"
},
{
"name": "apertureconstructionsetabridged_model",
"x-displayName": "ApertureConstructionSetAbridged",
"description": "\n"
},
{
"name": "apertureenergypropertiesabridged_model",
"x-displayName": "ApertureEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "aperturemodifierset_model",
"x-displayName": "ApertureModifierSet",
"description": "\n"
},
{
"name": "aperturemodifiersetabridged_model",
"x-displayName": "ApertureModifierSetAbridged",
"description": "\n"
},
{
"name": "aperturepropertiesabridged_model",
"x-displayName": "AperturePropertiesAbridged",
"description": "\n"
},
{
"name": "apertureradiancepropertiesabridged_model",
"x-displayName": "ApertureRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "autocalculate_model",
"x-displayName": "Autocalculate",
"description": "\n"
},
{
"name": "autosize_model",
"x-displayName": "Autosize",
"description": "\n"
},
{
"name": "bsdf_model",
"x-displayName": "BSDF",
"description": "\n"
},
{
"name": "baseboard_model",
"x-displayName": "Baseboard",
"description": "\n"
},
{
"name": "baseboardequipmenttype_model",
"x-displayName": "BaseboardEquipmentType",
"description": "\n"
},
{
"name": "constructionset_model",
"x-displayName": "ConstructionSet",
"description": "\n"
},
{
"name": "constructionsetabridged_model",
"x-displayName": "ConstructionSetAbridged",
"description": "\n"
},
{
"name": "controltype_model",
"x-displayName": "ControlType",
"description": "\n"
},
{
"name": "door_model",
"x-displayName": "Door",
"description": "\n"
},
{
"name": "doorconstructionset_model",
"x-displayName": "DoorConstructionSet",
"description": "\n"
},
{
"name": "doorconstructionsetabridged_model",
"x-displayName": "DoorConstructionSetAbridged",
"description": "\n"
},
{
"name": "doorenergypropertiesabridged_model",
"x-displayName": "DoorEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "doormodifierset_model",
"x-displayName": "DoorModifierSet",
"description": "\n"
},
{
"name": "doormodifiersetabridged_model",
"x-displayName": "DoorModifierSetAbridged",
"description": "\n"
},
{
"name": "doorpropertiesabridged_model",
"x-displayName": "DoorPropertiesAbridged",
"description": "\n"
},
{
"name": "doorradiancepropertiesabridged_model",
"x-displayName": "DoorRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "economizertype_model",
"x-displayName": "EconomizerType",
"description": "\n"
},
{
"name": "electricequipment_model",
"x-displayName": "ElectricEquipment",
"description": "\n"
},
{
"name": "electricequipmentabridged_model",
"x-displayName": "ElectricEquipmentAbridged",
"description": "\n"
},
{
"name": "energymaterial_model",
"x-displayName": "EnergyMaterial",
"description": "\n"
},
{
"name": "energymaterialnomass_model",
"x-displayName": "EnergyMaterialNoMass",
"description": "\n"
},
{
"name": "energywindowmaterialblind_model",
"x-displayName": "EnergyWindowMaterialBlind",
"description": "\n"
},
{
"name": "energywindowmaterialgas_model",
"x-displayName": "EnergyWindowMaterialGas",
"description": "\n"
},
{
"name": "energywindowmaterialgascustom_model",
"x-displayName": "EnergyWindowMaterialGasCustom",
"description": "\n"
},
{
"name": "energywindowmaterialgasmixture_model",
"x-displayName": "EnergyWindowMaterialGasMixture",
"description": "\n"
},
{
"name": "energywindowmaterialglazing_model",
"x-displayName": "EnergyWindowMaterialGlazing",
"description": "\n"
},
{
"name": "energywindowmaterialshade_model",
"x-displayName": "EnergyWindowMaterialShade",
"description": "\n"
},
{
"name": "energywindowmaterialsimpleglazsys_model",
"x-displayName": "EnergyWindowMaterialSimpleGlazSys",
"description": "\n"
},
{
"name": "evaporativecooler_model",
"x-displayName": "EvaporativeCooler",
"description": "\n"
},
{
"name": "evaporativecoolerequipmenttype_model",
"x-displayName": "EvaporativeCoolerEquipmentType",
"description": "\n"
},
{
"name": "fcu_model",
"x-displayName": "FCU",
"description": "\n"
},
{
"name": "fcuequipmenttype_model",
"x-displayName": "FCUEquipmentType",
"description": "\n"
},
{
"name": "fcuwithdoas_model",
"x-displayName": "FCUwithDOAS",
"description": "\n"
},
{
"name": "fcuwithdoasequipmenttype_model",
"x-displayName": "FCUwithDOASEquipmentType",
"description": "\n"
},
{
"name": "face_model",
"x-displayName": "Face",
"description": "\n"
},
{
"name": "face3d_model",
"x-displayName": "Face3D",
"description": "\n"
},
{
"name": "faceenergypropertiesabridged_model",
"x-displayName": "FaceEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "facepropertiesabridged_model",
"x-displayName": "FacePropertiesAbridged",
"description": "\n"
},
{
"name": "faceradiancepropertiesabridged_model",
"x-displayName": "FaceRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "facetype_model",
"x-displayName": "FaceType",
"description": "\n"
},
{
"name": "floorconstructionset_model",
"x-displayName": "FloorConstructionSet",
"description": "\n"
},
{
"name": "floorconstructionsetabridged_model",
"x-displayName": "FloorConstructionSetAbridged",
"description": "\n"
},
{
"name": "floormodifierset_model",
"x-displayName": "FloorModifierSet",
"description": "\n"
},
{
"name": "floormodifiersetabridged_model",
"x-displayName": "FloorModifierSetAbridged",
"description": "\n"
},
{
"name": "forcedairfurnace_model",
"x-displayName": "ForcedAirFurnace",
"description": "\n"
},
{
"name": "furnaceequipmenttype_model",
"x-displayName": "FurnaceEquipmentType",
"description": "\n"
},
{
"name": "gasequipment_model",
"x-displayName": "GasEquipment",
"description": "\n"
},
{
"name": "gasequipmentabridged_model",
"x-displayName": "GasEquipmentAbridged",
"description": "\n"
},
{
"name": "gastype_model",
"x-displayName": "GasType",
"description": "\n"
},
{
"name": "gasunitheater_model",
"x-displayName": "GasUnitHeater",
"description": "\n"
},
{
"name": "gasunitheaterequipmenttype_model",
"x-displayName": "GasUnitHeaterEquipmentType",
"description": "\n"
},
{
"name": "glass_model",
"x-displayName": "Glass",
"description": "\n"
},
{
"name": "glow_model",
"x-displayName": "Glow",
"description": "\n"
},
{
"name": "ground_model",
"x-displayName": "Ground",
"description": "\n"
},
{
"name": "idealairsystemabridged_model",
"x-displayName": "IdealAirSystemAbridged",
"description": "\n"
},
{
"name": "infiltration_model",
"x-displayName": "Infiltration",
"description": "\n"
},
{
"name": "infiltrationabridged_model",
"x-displayName": "InfiltrationAbridged",
"description": "\n"
},
{
"name": "light_model",
"x-displayName": "Light",
"description": "\n"
},
{
"name": "lighting_model",
"x-displayName": "Lighting",
"description": "\n"
},
{
"name": "lightingabridged_model",
"x-displayName": "LightingAbridged",
"description": "\n"
},
{
"name": "metal_model",
"x-displayName": "Metal",
"description": "\n"
},
{
"name": "mirror_model",
"x-displayName": "Mirror",
"description": "\n"
},
{
"name": "model_model",
"x-displayName": "Model",
"description": "\n"
},
{
"name": "modelenergyproperties_model",
"x-displayName": "ModelEnergyProperties",
"description": "\n"
},
{
"name": "modelproperties_model",
"x-displayName": "ModelProperties",
"description": "\n"
},
{
"name": "modelradianceproperties_model",
"x-displayName": "ModelRadianceProperties",
"description": "\n"
},
{
"name": "modifierset_model",
"x-displayName": "ModifierSet",
"description": "\n"
},
{
"name": "modifiersetabridged_model",
"x-displayName": "ModifierSetAbridged",
"description": "\n"
},
{
"name": "nolimit_model",
"x-displayName": "NoLimit",
"description": "\n"
},
{
"name": "opaqueconstruction_model",
"x-displayName": "OpaqueConstruction",
"description": "\n"
},
{
"name": "opaqueconstructionabridged_model",
"x-displayName": "OpaqueConstructionAbridged",
"description": "\n"
},
{
"name": "outdoors_model",
"x-displayName": "Outdoors",
"description": "\n"
},
{
"name": "psz_model",
"x-displayName": "PSZ",
"description": "\n"
},
{
"name": "pszequipmenttype_model",
"x-displayName": "PSZEquipmentType",
"description": "\n"
},
{
"name": "ptac_model",
"x-displayName": "PTAC",
"description": "\n"
},
{
"name": "ptacequipmenttype_model",
"x-displayName": "PTACEquipmentType",
"description": "\n"
},
{
"name": "pvav_model",
"x-displayName": "PVAV",
"description": "\n"
},
{
"name": "pvavequipmenttype_model",
"x-displayName": "PVAVEquipmentType",
"description": "\n"
},
{
"name": "people_model",
"x-displayName": "People",
"description": "\n"
},
{
"name": "peopleabridged_model",
"x-displayName": "PeopleAbridged",
"description": "\n"
},
{
"name": "plane_model",
"x-displayName": "Plane",
"description": "\n"
},
{
"name": "plastic_model",
"x-displayName": "Plastic",
"description": "\n"
},
{
"name": "programtype_model",
"x-displayName": "ProgramType",
"description": "\n"
},
{
"name": "programtypeabridged_model",
"x-displayName": "ProgramTypeAbridged",
"description": "\n"
},
{
"name": "radianceshadestateabridged_model",
"x-displayName": "RadianceShadeStateAbridged",
"description": "\n"
},
{
"name": "radiancesubfacestateabridged_model",
"x-displayName": "RadianceSubFaceStateAbridged",
"description": "\n"
},
{
"name": "residential_model",
"x-displayName": "Residential",
"description": "\n"
},
{
"name": "residentialequipmenttype_model",
"x-displayName": "ResidentialEquipmentType",
"description": "\n"
},
{
"name": "roofceilingconstructionset_model",
"x-displayName": "RoofCeilingConstructionSet",
"description": "\n"
},
{
"name": "roofceilingconstructionsetabridged_model",
"x-displayName": "RoofCeilingConstructionSetAbridged",
"description": "\n"
},
{
"name": "roofceilingmodifierset_model",
"x-displayName": "RoofCeilingModifierSet",
"description": "\n"
},
{
"name": "roofceilingmodifiersetabridged_model",
"x-displayName": "RoofCeilingModifierSetAbridged",
"description": "\n"
},
{
"name": "room_model",
"x-displayName": "Room",
"description": "\n"
},
{
"name": "roomenergypropertiesabridged_model",
"x-displayName": "RoomEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "roompropertiesabridged_model",
"x-displayName": "RoomPropertiesAbridged",
"description": "\n"
},
{
"name": "roomradiancepropertiesabridged_model",
"x-displayName": "RoomRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "roughness_model",
"x-displayName": "Roughness",
"description": "\n"
},
{
"name": "scheduleday_model",
"x-displayName": "ScheduleDay",
"description": "\n"
},
{
"name": "schedulefixedinterval_model",
"x-displayName": "ScheduleFixedInterval",
"description": "\n"
},
{
"name": "schedulefixedintervalabridged_model",
"x-displayName": "ScheduleFixedIntervalAbridged",
"description": "\n"
},
{
"name": "schedulenumerictype_model",
"x-displayName": "ScheduleNumericType",
"description": "\n"
},
{
"name": "scheduleruleabridged_model",
"x-displayName": "ScheduleRuleAbridged",
"description": "\n"
},
{
"name": "scheduleruleset_model",
"x-displayName": "ScheduleRuleset",
"description": "\n"
},
{
"name": "schedulerulesetabridged_model",
"x-displayName": "ScheduleRulesetAbridged",
"description": "\n"
},
{
"name": "scheduletypelimit_model",
"x-displayName": "ScheduleTypeLimit",
"description": "\n"
},
{
"name": "scheduleunittype_model",
"x-displayName": "ScheduleUnitType",
"description": "\n"
},
{
"name": "setpoint_model",
"x-displayName": "Setpoint",
"description": "\n"
},
{
"name": "setpointabridged_model",
"x-displayName": "SetpointAbridged",
"description": "\n"
},
{
"name": "shade_model",
"x-displayName": "Shade",
"description": "\n"
},
{
"name": "shadeconstruction_model",
"x-displayName": "ShadeConstruction",
"description": "\n"
},
{
"name": "shadeenergypropertiesabridged_model",
"x-displayName": "ShadeEnergyPropertiesAbridged",
"description": "\n"
},
{
"name": "shadelocation_model",
"x-displayName": "ShadeLocation",
"description": "\n"
},
{
"name": "shademodifierset_model",
"x-displayName": "ShadeModifierSet",
"description": "\n"
},
{
"name": "shademodifiersetabridged_model",
"x-displayName": "ShadeModifierSetAbridged",
"description": "\n"
},
{
"name": "shadepropertiesabridged_model",
"x-displayName": "ShadePropertiesAbridged",
"description": "\n"
},
{
"name": "shaderadiancepropertiesabridged_model",
"x-displayName": "ShadeRadiancePropertiesAbridged",
"description": "\n"
},
{
"name": "slatorientation_model",
"x-displayName": "SlatOrientation",
"description": "\n"
},
{
"name": "stategeometryabridged_model",
"x-displayName": "StateGeometryAbridged",
"description": "\n"
},
{
"name": "surface_model",
"x-displayName": "Surface",
"description": "\n"
},
{
"name": "trans_model",
"x-displayName": "Trans",
"description": "\n"
},
{
"name": "units_model",
"x-displayName": "Units",
"description": "\n"
},
{
"name": "vav_model",
"x-displayName": "VAV",
"description": "\n"
},
{
"name": "vavequipmenttype_model",
"x-displayName": "VAVEquipmentType",
"description": "\n"
},
{
"name": "vrf_model",
"x-displayName": "VRF",
"description": "\n"
},
{
"name": "vrfequipmenttype_model",
"x-displayName": "VRFEquipmentType",
"description": "\n"
},
{
"name": "vrfwithdoas_model",
"x-displayName": "VRFwithDOAS",
"description": "\n"
},
{
"name": "vrfwithdoasequipmenttype_model",
"x-displayName": "VRFwithDOASEquipmentType",
"description": "\n"
},
{
"name": "ventilation_model",
"x-displayName": "Ventilation",
"description": "\n"
},
{
"name": "ventilationabridged_model",
"x-displayName": "VentilationAbridged",
"description": "\n"
},
{
"name": "ventilationcontrolabridged_model",
"x-displayName": "VentilationControlAbridged",
"description": "\n"
},
{
"name": "ventilationopening_model",
"x-displayName": "VentilationOpening",
"description": "\n"
},
{
"name": "vintages_model",
"x-displayName": "Vintages",
"description": "\n"
},
{
"name": "void_model",
"x-displayName": "Void",
"description": "\n"
},
{
"name": "wshp_model",
"x-displayName": "WSHP",
"description": "\n"
},
{
"name": "wshpequipmenttype_model",
"x-displayName": "WSHPEquipmentType",
"description": "\n"
},
{
"name": "wshpwithdoas_model",
"x-displayName": "WSHPwithDOAS",
"description": "\n"
},
{
"name": "wshpwithdoasequipmenttype_model",
"x-displayName": "WSHPwithDOASEquipmentType",
"description": "\n"
},
{
"name": "wallconstructionset_model",
"x-displayName": "WallConstructionSet",
"description": "\n"
},
{
"name": "wallconstructionsetabridged_model",
"x-displayName": "WallConstructionSetAbridged",
"description": "\n"
},
{
"name": "wallmodifierset_model",
"x-displayName": "WallModifierSet",
"description": "\n"
},
{
"name": "wallmodifiersetabridged_model",
"x-displayName": "WallModifierSetAbridged",
"description": "\n"
},
{
"name": "windowac_model",
"x-displayName": "WindowAC",
"description": "\n"
},
{
"name": "windowacequipmenttype_model",
"x-displayName": "WindowACEquipmentType",
"description": "\n"
},
{
"name": "windowconstruction_model",
"x-displayName": "WindowConstruction",
"description": "\n"
},
{
"name": "windowconstructionabridged_model",
"x-displayName": "WindowConstructionAbridged",
"description": "\n"
},
{
"name": "windowconstructionshade_model",
"x-displayName": "WindowConstructionShade",
"description": "\n"
},
{
"name": "windowconstructionshadeabridged_model",
"x-displayName": "WindowConstructionShadeAbridged",
"description": "\n"
}
],
"x-tagGroups": [
{
"name": "Models",
"tags": [
"adiabatic_model",
"airboundaryconstruction_model",
"airboundaryconstructionabridged_model",
"allaireconomizertype_model",
"aperture_model",
"apertureconstructionset_model",
"apertureconstructionsetabridged_model",
"apertureenergypropertiesabridged_model",
"aperturemodifierset_model",
"aperturemodifiersetabridged_model",
"aperturepropertiesabridged_model",
"apertureradiancepropertiesabridged_model",
"autocalculate_model",
"autosize_model",
"baseboard_model",
"baseboardequipmenttype_model",
"bsdf_model",
"constructionset_model",
"constructionsetabridged_model",
"controltype_model",
"door_model",
"doorconstructionset_model",
"doorconstructionsetabridged_model",
"doorenergypropertiesabridged_model",
"doormodifierset_model",
"doormodifiersetabridged_model",
"doorpropertiesabridged_model",
"doorradiancepropertiesabridged_model",
"economizertype_model",
"electricequipment_model",
"electricequipmentabridged_model",
"energymaterial_model",
"energymaterialnomass_model",
"energywindowmaterialblind_model",
"energywindowmaterialgas_model",
"energywindowmaterialgascustom_model",
"energywindowmaterialgasmixture_model",
"energywindowmaterialglazing_model",
"energywindowmaterialshade_model",
"energywindowmaterialsimpleglazsys_model",
"evaporativecooler_model",
"evaporativecoolerequipmenttype_model",
"face3d_model",
"face_model",
"faceenergypropertiesabridged_model",
"facepropertiesabridged_model",
"faceradiancepropertiesabridged_model",
"facetype_model",
"fcu_model",
"fcuequipmenttype_model",
"fcuwithdoas_model",
"fcuwithdoasequipmenttype_model",
"floorconstructionset_model",
"floorconstructionsetabridged_model",
"floormodifierset_model",
"floormodifiersetabridged_model",
"forcedairfurnace_model",
"furnaceequipmenttype_model",
"gasequipment_model",
"gasequipmentabridged_model",
"gastype_model",
"gasunitheater_model",
"gasunitheaterequipmenttype_model",
"glass_model",
"glow_model",
"ground_model",
"idealairsystemabridged_model",
"infiltration_model",
"infiltrationabridged_model",
"light_model",
"lighting_model",
"lightingabridged_model",
"metal_model",
"mirror_model",
"model_model",
"modelenergyproperties_model",
"modelproperties_model",
"modelradianceproperties_model",
"modifierset_model",
"modifiersetabridged_model",
"nolimit_model",
"opaqueconstruction_model",
"opaqueconstructionabridged_model",
"outdoors_model",
"people_model",
"peopleabridged_model",
"plane_model",
"plastic_model",
"programtype_model",
"programtypeabridged_model",
"psz_model",
"pszequipmenttype_model",
"ptac_model",
"ptacequipmenttype_model",
"pvav_model",
"pvavequipmenttype_model",
"radianceshadestateabridged_model",
"radiancesubfacestateabridged_model",
"residential_model",
"residentialequipmenttype_model",
"roofceilingconstructionset_model",
"roofceilingconstructionsetabridged_model",
"roofceilingmodifierset_model",
"roofceilingmodifiersetabridged_model",
"room_model",
"roomenergypropertiesabridged_model",
"roompropertiesabridged_model",
"roomradiancepropertiesabridged_model",
"roughness_model",
"scheduleday_model",
"schedulefixedinterval_model",
"schedulefixedintervalabridged_model",
"schedulenumerictype_model",
"scheduleruleabridged_model",
"scheduleruleset_model",
"schedulerulesetabridged_model",
"scheduletypelimit_model",
"scheduleunittype_model",
"setpoint_model",
"setpointabridged_model",
"shade_model",
"shadeconstruction_model",
"shadeenergypropertiesabridged_model",
"shadelocation_model",
"shademodifierset_model",
"shademodifiersetabridged_model",
"shadepropertiesabridged_model",
"shaderadiancepropertiesabridged_model",
"slatorientation_model",
"stategeometryabridged_model",
"surface_model",
"trans_model",
"units_model",
"vav_model",
"vavequipmenttype_model",
"ventilation_model",
"ventilationabridged_model",
"ventilationcontrolabridged_model",
"ventilationopening_model",
"vintages_model",
"void_model",
"vrf_model",
"vrfequipmenttype_model",
"vrfwithdoas_model",
"vrfwithdoasequipmenttype_model",
"wallconstructionset_model",
"wallconstructionsetabridged_model",
"wallmodifierset_model",
"wallmodifiersetabridged_model",
"windowac_model",
"windowacequipmenttype_model",
"windowconstruction_model",
"windowconstructionabridged_model",
"windowconstructionshade_model",
"windowconstructionshadeabridged_model",
"wshp_model",
"wshpequipmenttype_model",
"wshpwithdoas_model",
"wshpwithdoasequipmenttype_model"
]
}
],
"paths": {},
"components": {
"schemas": {
"Plane": {
"title": "Plane",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"n": {
"title": "N",
"description": "Plane normal as 3 (x, y, z) values.",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"o": {
"title": "O",
"description": "Plane origin as 3 (x, y, z) values",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"type": {
"title": "Type",
"default": "Plane",
"pattern": "^Plane$",
"type": "string",
"readOnly": true
},
"x": {
"title": "X",
"description": "Plane x-axis as 3 (x, y, z) values. If None, it is autocalculated.",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
}
},
"required": [
"n",
"o"
],
"additionalProperties": false
},
"Face3D": {
"title": "Face3D",
"description": "A single planar face in 3D space.",
"type": "object",
"properties": {
"boundary": {
"title": "Boundary",
"description": "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.",
"minItems": 3,
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"minItems": 3,
"maxItems": 3
}
},
"type": {
"title": "Type",
"default": "Face3D",
"pattern": "^Face3D$",
"type": "string",
"readOnly": true
},
"holes": {
"title": "Holes",
"description": "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.",
"type": "array",
"items": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "double"
},
"minItems": 3,
"maxItems": 3
},
"minItems": 3
}
},
"plane": {
"title": "Plane",
"description": "Optional Plane indicating the plane in which the face exists.If None, the plane will usually be derived from the boundary points.",
"allOf": [
{
"$ref": "#/components/schemas/Plane"
}
]
}
},
"required": [
"boundary"
],
"additionalProperties": false
},
"FaceType": {
"title": "FaceType",
"description": "An enumeration.",
"enum": [
"Wall",
"Floor",
"RoofCeiling",
"AirBoundary"
],
"type": "string"
},
"Ground": {
"title": "Ground",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Ground",
"pattern": "^Ground$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"Autocalculate": {
"title": "Autocalculate",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Autocalculate",
"pattern": "^Autocalculate$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"Outdoors": {
"title": "Outdoors",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Outdoors",
"pattern": "^Outdoors$",
"type": "string",
"readOnly": true
},
"sun_exposure": {
"title": "Sun Exposure",
"description": "A boolean noting whether the boundary is exposed to sun.",
"default": true,
"type": "boolean"
},
"wind_exposure": {
"title": "Wind Exposure",
"description": "A boolean noting whether the boundary is exposed to wind.",
"default": true,
"type": "boolean"
},
"view_factor": {
"title": "View Factor",
"description": "A number for the view factor to the ground. This can also be an Autocalculate object to have the view factor automatically calculated.",
"default": {
"type": "Autocalculate"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
}
},
"additionalProperties": false
},
"Adiabatic": {
"title": "Adiabatic",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Adiabatic",
"pattern": "^Adiabatic$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"Surface": {
"title": "Surface",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"boundary_condition_objects": {
"title": "Boundary Condition Objects",
"description": "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.",
"minItems": 2,
"maxItems": 3,
"type": "array",
"items": {
"type": "string"
}
},
"type": {
"title": "Type",
"default": "Surface",
"pattern": "^Surface$",
"type": "string",
"readOnly": true
}
},
"required": [
"boundary_condition_objects"
],
"additionalProperties": false
},
"ShadeEnergyPropertiesAbridged": {
"title": "ShadeEnergyPropertiesAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ShadeEnergyPropertiesAbridged",
"pattern": "^ShadeEnergyPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"construction": {
"title": "Construction",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"transmittance_schedule": {
"title": "Transmittance Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"StateGeometryAbridged": {
"title": "StateGeometryAbridged",
"description": "A single planar geometry that can be assigned to Radiance states.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"geometry": {
"title": "Geometry",
"description": "A ladybug_geometry Face3D.",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "StateGeometryAbridged",
"pattern": "^StateGeometryAbridged$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "A string for a Honeybee Radiance Modifier identifier (default: None).",
"type": "string"
},
"modifier_direct": {
"title": "Modifier Direct",
"description": "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": "string"
}
},
"required": [
"identifier",
"geometry"
],
"additionalProperties": false
},
"RadianceShadeStateAbridged": {
"title": "RadianceShadeStateAbridged",
"description": "RadianceShadeStateAbridged represents a single state for a dynamic Shade.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "RadianceShadeStateAbridged",
"pattern": "^RadianceShadeStateAbridged$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "A Radiance Modifier identifier (default: None).",
"type": "string"
},
"modifier_direct": {
"title": "Modifier Direct",
"description": "A Radiance Modifier identifier (default: None).",
"type": "string"
},
"shades": {
"title": "Shades",
"description": "A list of StateGeometryAbridged objects (default: None).",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateGeometryAbridged"
}
}
},
"additionalProperties": false
},
"ShadeRadiancePropertiesAbridged": {
"title": "ShadeRadiancePropertiesAbridged",
"description": "Radiance Properties for Honeybee Shade Abridged.",
"type": "object",
"properties": {
"modifier": {
"title": "Modifier",
"description": "A string for a Honeybee Radiance Modifier (default: None).",
"type": "string"
},
"modifier_blk": {
"title": "Modifier Blk",
"description": "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": {
"title": "Type",
"default": "ShadeRadiancePropertiesAbridged",
"pattern": "^ShadeRadiancePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"title": "Dynamic Group Identifier",
"description": "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).",
"type": "string"
},
"states": {
"title": "States",
"description": "An optional list of abridged states (default: None).",
"type": "array",
"items": {
"$ref": "#/components/schemas/RadianceShadeStateAbridged"
}
}
},
"additionalProperties": false
},
"ShadePropertiesAbridged": {
"title": "ShadePropertiesAbridged",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ShadePropertiesAbridged",
"pattern": "^ShadePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/ShadeEnergyPropertiesAbridged"
},
"radiance": {
"$ref": "#/components/schemas/ShadeRadiancePropertiesAbridged"
}
}
},
"Shade": {
"title": "Shade",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"geometry": {
"title": "Geometry",
"description": "Planar Face3D for the geometry.",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/ShadePropertiesAbridged"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Shade",
"pattern": "^Shade$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"geometry",
"properties"
],
"additionalProperties": false
},
"VentilationOpening": {
"title": "VentilationOpening",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "VentilationOpening",
"pattern": "^VentilationOpening$",
"type": "string",
"readOnly": true
},
"fraction_area_operable": {
"title": "Fraction Area Operable",
"description": "A number for the fraction of the window area that is operable.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"fraction_height_operable": {
"title": "Fraction Height Operable",
"description": "A number for the fraction of the distance from the bottom of the window to the top that is operable.",
"default": 1.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"discharge_coefficient": {
"title": "Discharge Coefficient",
"description": "A number that will be multipled 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.17, for unobstructed windows with insect screens and 0.25 for unobstructed windows without insect screens. This value should be lowered if windows are of an awning or casement type and not allowed to fully open.",
"default": 0.17,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"wind_cross_vent": {
"title": "Wind Cross Vent",
"description": "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.",
"default": false,
"type": "boolean"
}
},
"additionalProperties": false
},
"ApertureEnergyPropertiesAbridged": {
"title": "ApertureEnergyPropertiesAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ApertureEnergyPropertiesAbridged",
"pattern": "^ApertureEnergyPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"construction": {
"title": "Construction",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"vent_opening": {
"title": "Vent Opening",
"description": "An optional VentilationOpening to specify the operable portion of the Aperture.",
"allOf": [
{
"$ref": "#/components/schemas/VentilationOpening"
}
]
}
},
"additionalProperties": false
},
"RadianceSubFaceStateAbridged": {
"title": "RadianceSubFaceStateAbridged",
"description": "RadianceSubFaceStateAbridged is an abridged state for a dynamic Aperture or Door.\n ",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "RadianceSubFaceStateAbridged",
"pattern": "^RadianceSubFaceStateAbridged$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "A Radiance Modifier identifier (default: None).",
"type": "string"
},
"modifier_direct": {
"title": "Modifier Direct",
"description": "A Radiance Modifier identifier (default: None).",
"type": "string"
},
"shades": {
"title": "Shades",
"description": "A list of StateGeometryAbridged objects (default: None).",
"type": "array",
"items": {
"$ref": "#/components/schemas/StateGeometryAbridged"
}
},
"vmtx_geometry": {
"title": "Vmtx Geometry",
"description": "A Face3D for the view matrix geometry (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"dmtx_geometry": {
"title": "Dmtx Geometry",
"description": "A Face3D for the daylight matrix geometry (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
}
},
"additionalProperties": false
},
"ApertureRadiancePropertiesAbridged": {
"title": "ApertureRadiancePropertiesAbridged",
"description": "Radiance Properties for Honeybee Aperture Abridged.",
"type": "object",
"properties": {
"modifier": {
"title": "Modifier",
"description": "A string for a Honeybee Radiance Modifier (default: None).",
"type": "string"
},
"modifier_blk": {
"title": "Modifier Blk",
"description": "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": {
"title": "Type",
"default": "ApertureRadiancePropertiesAbridged",
"pattern": "^ApertureRadiancePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"title": "Dynamic Group Identifier",
"description": "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).",
"type": "string"
},
"states": {
"title": "States",
"description": "An optional list of abridged states (default: None).",
"type": "array",
"items": {
"$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
}
}
},
"additionalProperties": false
},
"AperturePropertiesAbridged": {
"title": "AperturePropertiesAbridged",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "AperturePropertiesAbridged",
"pattern": "^AperturePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/ApertureEnergyPropertiesAbridged"
},
"radiance": {
"$ref": "#/components/schemas/ApertureRadiancePropertiesAbridged"
}
}
},
"Aperture": {
"title": "Aperture",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"geometry": {
"title": "Geometry",
"description": "Planar Face3D for the geometry.",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"boundary_condition": {
"title": "Boundary Condition",
"anyOf": [
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Surface"
}
]
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/AperturePropertiesAbridged"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Aperture",
"pattern": "^Aperture$",
"type": "string",
"readOnly": true
},
"is_operable": {
"title": "Is Operable",
"description": "Boolean to note whether the Aperture can be opened for ventilation.",
"default": false,
"type": "boolean"
},
"indoor_shades": {
"title": "Indoor Shades",
"description": "Shades assigned to the interior side of this object (eg. window sill, light shelf).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"outdoor_shades": {
"title": "Outdoor Shades",
"description": "Shades assigned to the exterior side of this object (eg. mullions, louvers).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
}
},
"required": [
"identifier",
"geometry",
"boundary_condition",
"properties"
],
"additionalProperties": false
},
"DoorEnergyPropertiesAbridged": {
"title": "DoorEnergyPropertiesAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "DoorEnergyPropertiesAbridged",
"pattern": "^DoorEnergyPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"construction": {
"title": "Construction",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"vent_opening": {
"title": "Vent Opening",
"description": "An optional VentilationOpening to specify the operable portion of the Door.",
"allOf": [
{
"$ref": "#/components/schemas/VentilationOpening"
}
]
}
},
"additionalProperties": false
},
"DoorRadiancePropertiesAbridged": {
"title": "DoorRadiancePropertiesAbridged",
"description": "Radiance Properties for Honeybee Door Abridged.",
"type": "object",
"properties": {
"modifier": {
"title": "Modifier",
"description": "A string for a Honeybee Radiance Modifier (default: None).",
"type": "string"
},
"modifier_blk": {
"title": "Modifier Blk",
"description": "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": {
"title": "Type",
"default": "DoorRadiancePropertiesAbridged",
"pattern": "^DoorRadiancePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"dynamic_group_identifier": {
"title": "Dynamic Group Identifier",
"description": "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).",
"type": "string"
},
"states": {
"title": "States",
"description": "An optional list of abridged states (default: None).",
"type": "array",
"items": {
"$ref": "#/components/schemas/RadianceSubFaceStateAbridged"
}
}
},
"additionalProperties": false
},
"DoorPropertiesAbridged": {
"title": "DoorPropertiesAbridged",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "DoorPropertiesAbridged",
"pattern": "^DoorPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/DoorEnergyPropertiesAbridged"
},
"radiance": {
"$ref": "#/components/schemas/DoorRadiancePropertiesAbridged"
}
}
},
"Door": {
"title": "Door",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"geometry": {
"title": "Geometry",
"description": "Planar Face3D for the geometry.",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"boundary_condition": {
"title": "Boundary Condition",
"anyOf": [
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Surface"
}
]
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/DoorPropertiesAbridged"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Door",
"pattern": "^Door$",
"type": "string",
"readOnly": true
},
"is_glass": {
"title": "Is Glass",
"description": "Boolean to note whether this object is a glass door as opposed to an opaque door.",
"default": false,
"type": "boolean"
},
"indoor_shades": {
"title": "Indoor Shades",
"description": "Shades assigned to the interior side of this object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"outdoor_shades": {
"title": "Outdoor Shades",
"description": "Shades assigned to the exterior side of this object (eg. entryway awning).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
}
},
"required": [
"identifier",
"geometry",
"boundary_condition",
"properties"
],
"additionalProperties": false
},
"FaceEnergyPropertiesAbridged": {
"title": "FaceEnergyPropertiesAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "FaceEnergyPropertiesAbridged",
"pattern": "^FaceEnergyPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"construction": {
"title": "Construction",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"FaceRadiancePropertiesAbridged": {
"title": "FaceRadiancePropertiesAbridged",
"description": "Radiance Properties for Honeybee Face Abridged.",
"type": "object",
"properties": {
"modifier": {
"title": "Modifier",
"description": "A string for a Honeybee Radiance Modifier (default: None).",
"type": "string"
},
"modifier_blk": {
"title": "Modifier Blk",
"description": "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": {
"title": "Type",
"default": "FaceRadiancePropertiesAbridged",
"pattern": "^FaceRadiancePropertiesAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"FacePropertiesAbridged": {
"title": "FacePropertiesAbridged",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "FacePropertiesAbridged",
"pattern": "^FacePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/FaceEnergyPropertiesAbridged"
},
"radiance": {
"$ref": "#/components/schemas/FaceRadiancePropertiesAbridged"
}
}
},
"Face": {
"title": "Face",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"geometry": {
"title": "Geometry",
"description": "Planar Face3D for the geometry.",
"allOf": [
{
"$ref": "#/components/schemas/Face3D"
}
]
},
"face_type": {
"title": "Face Type",
"allOf": [
{
"$ref": "#/components/schemas/FaceType"
}
]
},
"boundary_condition": {
"title": "Boundary Condition",
"anyOf": [
{
"$ref": "#/components/schemas/Ground"
},
{
"$ref": "#/components/schemas/Outdoors"
},
{
"$ref": "#/components/schemas/Adiabatic"
},
{
"$ref": "#/components/schemas/Surface"
}
]
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/FacePropertiesAbridged"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Face",
"pattern": "^Face$",
"type": "string",
"readOnly": true
},
"apertures": {
"title": "Apertures",
"description": "Apertures assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Aperture"
}
},
"doors": {
"title": "Doors",
"description": "Doors assigned to this Face. Should be coplanar with this Face and completely within the boundary of the Face to be valid.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Door"
}
},
"indoor_shades": {
"title": "Indoor Shades",
"description": "Shades assigned to the interior side of this object.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"outdoor_shades": {
"title": "Outdoor Shades",
"description": "Shades assigned to the exterior side of this object (eg. balcony, overhang).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
}
},
"required": [
"identifier",
"geometry",
"face_type",
"boundary_condition",
"properties"
],
"additionalProperties": false
},
"PeopleAbridged": {
"title": "PeopleAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"people_per_area": {
"title": "People Per Area",
"description": "People per floor area expressed as [people/m2]",
"minimum": 0,
"type": "number",
"format": "double"
},
"occupancy_schedule": {
"title": "Occupancy Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"activity_schedule": {
"title": "Activity Schedule",
"description": "Identifier of a schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "PeopleAbridged",
"pattern": "^PeopleAbridged$",
"type": "string",
"readOnly": true
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.",
"default": 0.3,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
"default": {
"type": "Autocalculate"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
}
},
"required": [
"identifier",
"people_per_area",
"occupancy_schedule",
"activity_schedule"
],
"additionalProperties": false
},
"LightingAbridged": {
"title": "LightingAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Lighting per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "LightingAbridged",
"pattern": "^LightingAbridged$",
"type": "string",
"readOnly": true
},
"visible_fraction": {
"title": "Visible Fraction",
"description": "The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. The default value is `0.25`.",
"default": 0.25,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "The fraction of heat from lights that is long-wave radiation. Default value is `0.32`.",
"default": 0.32,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"return_air_fraction": {
"title": "Return Air Fraction",
"description": "The fraction of the heat from lights that goes into the zone return air. Default value is `0`.",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"ElectricEquipmentAbridged": {
"title": "ElectricEquipmentAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"lost_fraction": {
"title": "Lost Fraction",
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"type": {
"title": "Type",
"default": "ElectricEquipmentAbridged",
"pattern": "^ElectricEquipmentAbridged$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"GasEquipmentAbridged": {
"title": "GasEquipmentAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"lost_fraction": {
"title": "Lost Fraction",
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"type": {
"title": "Type",
"default": "GasEquipmentAbridged",
"pattern": "^GasEquipmentAbridged$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"InfiltrationAbridged": {
"title": "InfiltrationAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"flow_per_exterior_area": {
"title": "Flow Per Exterior Area",
"description": "Number for the infiltration per exterior surface area in m3/s-m2.",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "InfiltrationAbridged",
"pattern": "^InfiltrationAbridged$",
"type": "string",
"readOnly": true
},
"constant_coefficient": {
"title": "Constant Coefficient",
"default": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"temperature_coefficient": {
"title": "Temperature Coefficient",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"velocity_coefficient": {
"title": "Velocity Coefficient",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"flow_per_exterior_area",
"schedule"
],
"additionalProperties": false
},
"VentilationAbridged": {
"title": "VentilationAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "VentilationAbridged",
"pattern": "^VentilationAbridged$",
"type": "string",
"readOnly": true
},
"flow_per_person": {
"title": "Flow Per Person",
"description": "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.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"flow_per_area": {
"title": "Flow Per Area",
"description": "Intensity of ventilation in [m3/s per m2 of floor area].",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"air_changes_per_hour": {
"title": "Air Changes Per Hour",
"description": "Intensity of ventilation in air changes per hour (ACH) for the entire Room.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"flow_per_zone": {
"title": "Flow Per Zone",
"description": "Intensity of ventilation in m3/s for the entire Room.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"SetpointAbridged": {
"title": "SetpointAbridged",
"description": "Used to specify information about the setpoint schedule.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"cooling_schedule": {
"title": "Cooling Schedule",
"description": "Identifier of the schedule for the cooling setpoint. The values in this schedule should be temperature in [C].",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"heating_schedule": {
"title": "Heating Schedule",
"description": "Identifier of the schedule for the heating setpoint. The values in this schedule should be temperature in [C].",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "SetpointAbridged",
"pattern": "^SetpointAbridged$",
"type": "string",
"readOnly": true
},
"humidifying_schedule": {
"title": "Humidifying Schedule",
"description": "Identifier of the schedule for the humidification setpoint. The values in this schedule should be in [%].",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"dehumidifying_schedule": {
"title": "Dehumidifying Schedule",
"description": "Identifier of the schedule for the dehumidification setpoint. The values in this schedule should be in [%].",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier",
"cooling_schedule",
"heating_schedule"
],
"additionalProperties": false
},
"VentilationControlAbridged": {
"title": "VentilationControlAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "VentilationControlAbridged",
"pattern": "^VentilationControlAbridged$",
"type": "string",
"readOnly": true
},
"min_indoor_temperature": {
"title": "Min Indoor Temperature",
"description": "A number for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation.",
"default": -100,
"minimum": -100,
"maximum": 100,
"type": "number",
"format": "double"
},
"max_indoor_temperature": {
"title": "Max Indoor Temperature",
"description": "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.",
"default": 100,
"minimum": -100,
"maximum": 100,
"type": "number",
"format": "double"
},
"min_outdoor_temperature": {
"title": "Min Outdoor Temperature",
"description": "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.",
"default": -100,
"minimum": -100,
"maximum": 100,
"type": "number",
"format": "double"
},
"max_outdoor_temperature": {
"title": "Max Outdoor Temperature",
"description": "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.",
"default": 100,
"minimum": -100,
"maximum": 100,
"type": "number",
"format": "double"
},
"delta_temperature": {
"title": "Delta Temperature",
"description": "A number for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a negative number so that ventilation only occurs when the outdoors is cooler than the indoors. Positive numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped.",
"default": -100,
"minimum": -100,
"maximum": 100,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"RoomEnergyPropertiesAbridged": {
"title": "RoomEnergyPropertiesAbridged",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "RoomEnergyPropertiesAbridged",
"pattern": "^RoomEnergyPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"construction_set": {
"title": "Construction Set",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"program_type": {
"title": "Program Type",
"description": "Identifier of a ProgramType to specify all default schedules and loads for the Room. If None, the Room will have no loads or setpoints.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"hvac": {
"title": "Hvac",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"people": {
"title": "People",
"description": "People object to describe the occupancy of the Room.",
"allOf": [
{
"$ref": "#/components/schemas/PeopleAbridged"
}
]
},
"lighting": {
"title": "Lighting",
"description": "Lighting object to describe the lighting usage of the Room.",
"allOf": [
{
"$ref": "#/components/schemas/LightingAbridged"
}
]
},
"electric_equipment": {
"title": "Electric Equipment",
"description": "ElectricEquipment object to describe the electric equipment usage.",
"allOf": [
{
"$ref": "#/components/schemas/ElectricEquipmentAbridged"
}
]
},
"gas_equipment": {
"title": "Gas Equipment",
"description": "GasEquipment object to describe the gas equipment usage.",
"allOf": [
{
"$ref": "#/components/schemas/GasEquipmentAbridged"
}
]
},
"infiltration": {
"title": "Infiltration",
"description": "Infiltration object to to describe the outdoor air leakage.",
"allOf": [
{
"$ref": "#/components/schemas/InfiltrationAbridged"
}
]
},
"ventilation": {
"title": "Ventilation",
"description": "Ventilation object for the minimum outdoor air requirement.",
"allOf": [
{
"$ref": "#/components/schemas/VentilationAbridged"
}
]
},
"setpoint": {
"title": "Setpoint",
"description": "Setpoint object for the temperature setpoints of the Room.",
"allOf": [
{
"$ref": "#/components/schemas/SetpointAbridged"
}
]
},
"window_vent_control": {
"title": "Window Vent Control",
"description": "An optional VentilationControl object to dictate the opening of windows. If None, the windows will never open.",
"allOf": [
{
"$ref": "#/components/schemas/VentilationControlAbridged"
}
]
}
},
"additionalProperties": false
},
"RoomRadiancePropertiesAbridged": {
"title": "RoomRadiancePropertiesAbridged",
"description": "Abridged Radiance Properties for Honeybee Room.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "RoomRadiancePropertiesAbridged",
"pattern": "^RoomRadiancePropertiesAbridged$",
"type": "string",
"readOnly": true
},
"modifier_set": {
"title": "Modifier Set",
"description": "An identifier for a unique Room-Assigned ModifierSet (default: None).",
"type": "string"
}
},
"additionalProperties": false
},
"RoomPropertiesAbridged": {
"title": "RoomPropertiesAbridged",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "RoomPropertiesAbridged",
"pattern": "^RoomPropertiesAbridged$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/RoomEnergyPropertiesAbridged"
},
"radiance": {
"$ref": "#/components/schemas/RoomRadiancePropertiesAbridged"
}
}
},
"Room": {
"title": "Room",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"faces": {
"title": "Faces",
"description": "Faces that together form the closed volume of a room.",
"minItems": 4,
"type": "array",
"items": {
"$ref": "#/components/schemas/Face"
}
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/RoomPropertiesAbridged"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Room",
"pattern": "^Room$",
"type": "string",
"readOnly": true
},
"indoor_shades": {
"title": "Indoor Shades",
"description": "Shades assigned to the interior side of this object (eg. partitions, tables).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"outdoor_shades": {
"title": "Outdoor Shades",
"description": "Shades assigned to the exterior side of this object (eg. trees, landscaping).",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"multiplier": {
"title": "Multiplier",
"description": "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 mutliplied by the multiplier.",
"default": 1,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"story": {
"title": "Story",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
}
},
"required": [
"identifier",
"faces",
"properties"
],
"additionalProperties": false
},
"Units": {
"title": "Units",
"description": "An enumeration.",
"enum": [
"Meters",
"Millimeters",
"Feet",
"Inches",
"Centimeters"
],
"type": "string"
},
"WallConstructionSetAbridged": {
"title": "WallConstructionSetAbridged",
"description": "A set of constructions for wall assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ground_construction": {
"title": "Ground Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Ground boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"type": {
"title": "Type",
"default": "WallConstructionSetAbridged",
"pattern": "^WallConstructionSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"FloorConstructionSetAbridged": {
"title": "FloorConstructionSetAbridged",
"description": "A set of constructions for floor assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ground_construction": {
"title": "Ground Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Ground boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"type": {
"title": "Type",
"default": "FloorConstructionSetAbridged",
"pattern": "^FloorConstructionSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"RoofCeilingConstructionSetAbridged": {
"title": "RoofCeilingConstructionSetAbridged",
"description": "A set of constructions for roof and ceiling assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Surface or Adiabatic boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "Identifier for an OpaqueConstruction for faces with an Outdoors boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"ground_construction": {
"title": "Ground Construction",
"description": "Identifier for an OpaqueConstruction for faces with a Ground boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"type": {
"title": "Type",
"default": "RoofCeilingConstructionSetAbridged",
"pattern": "^RoofCeilingConstructionSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ApertureConstructionSetAbridged": {
"title": "ApertureConstructionSetAbridged",
"description": "A set of constructions for aperture assemblies.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ApertureConstructionSetAbridged",
"pattern": "^ApertureConstructionSetAbridged$",
"type": "string",
"readOnly": true
},
"interior_construction": {
"title": "Interior Construction",
"description": "Identifier for a WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"window_construction": {
"title": "Window Construction",
"description": "Identifier for a WindowConstruction for all apertures with a Surface boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"skylight_construction": {
"title": "Skylight Construction",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"operable_construction": {
"title": "Operable Construction",
"description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"DoorConstructionSetAbridged": {
"title": "DoorConstructionSetAbridged",
"description": "A set of constructions for door assemblies.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "DoorConstructionSetAbridged",
"pattern": "^DoorConstructionSetAbridged$",
"type": "string",
"readOnly": true
},
"interior_construction": {
"title": "Interior Construction",
"description": "Identifier for an OpaqueConstruction for all opaque doors with a Surface boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"overhead_construction": {
"title": "Overhead Construction",
"description": "Identifier for an OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"exterior_glass_construction": {
"title": "Exterior Glass Construction",
"description": "Identifier for a WindowConstruction for all glass doors with an Outdoors boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"interior_glass_construction": {
"title": "Interior Glass Construction",
"description": "Identifier for a WindowConstruction for all glass doors with a Surface boundary condition.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"additionalProperties": false
},
"ConstructionSetAbridged": {
"title": "ConstructionSetAbridged",
"description": "A set of constructions for different surface types and boundary conditions.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ConstructionSetAbridged",
"pattern": "^ConstructionSetAbridged$",
"type": "string",
"readOnly": true
},
"wall_set": {
"title": "Wall Set",
"description": "A WallConstructionSetAbridged object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/WallConstructionSetAbridged"
}
]
},
"floor_set": {
"title": "Floor Set",
"description": "A FloorConstructionSetAbridged object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/FloorConstructionSetAbridged"
}
]
},
"roof_ceiling_set": {
"title": "Roof Ceiling Set",
"description": "A RoofCeilingConstructionSetAbridged object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/RoofCeilingConstructionSetAbridged"
}
]
},
"aperture_set": {
"title": "Aperture Set",
"description": "A ApertureConstructionSetAbridged object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/ApertureConstructionSetAbridged"
}
]
},
"door_set": {
"title": "Door Set",
"description": "A DoorConstructionSetAbridged object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/DoorConstructionSetAbridged"
}
]
},
"shade_construction": {
"title": "Shade Construction",
"description": "The identifier of a ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"air_boundary_construction": {
"title": "Air Boundary Construction",
"description": "The identifier of an AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Roughness": {
"title": "Roughness",
"description": "Relative roughness of a particular material layer.",
"enum": [
"VeryRough",
"Rough",
"MediumRough",
"MediumSmooth",
"Smooth",
"VerySmooth"
],
"type": "string"
},
"EnergyMaterial": {
"title": "EnergyMaterial",
"description": "Opaque material representing a layer within an opaque construction.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"thickness": {
"title": "Thickness",
"description": "Thickness of the material layer in meters.",
"exclusiveMinimum": 0,
"maximum": 3,
"type": "number",
"format": "double"
},
"conductivity": {
"title": "Conductivity",
"description": "Thermal conductivity of the material layer in W/(m-K).",
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"density": {
"title": "Density",
"description": "Density of the material layer in kg/m3.",
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"specific_heat": {
"title": "Specific Heat",
"description": "Specific heat of the material layer in J/(kg-K).",
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyMaterial",
"pattern": "^EnergyMaterial$",
"type": "string",
"readOnly": true
},
"roughness": {
"title": "Roughness",
"default": "MediumRough",
"allOf": [
{
"$ref": "#/components/schemas/Roughness"
}
]
},
"thermal_absorptance": {
"title": "Thermal Absorptance",
"description": "Fraction of incident long wavelength radiation that is absorbed by the material. Default value is 0.9.",
"default": 0.9,
"exclusiveMinimum": 0,
"maximum": 0.99999,
"type": "number",
"format": "double"
},
"solar_absorptance": {
"title": "Solar Absorptance",
"description": "Fraction of incident solar radiation absorbed by the material. Default value is 0.7.",
"default": 0.7,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"visible_absorptance": {
"title": "Visible Absorptance",
"description": "Fraction of incident visible wavelength radiation absorbed by the material. Default value is 0.7.",
"default": 0.7,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"thickness",
"conductivity",
"density",
"specific_heat"
],
"additionalProperties": false
},
"EnergyMaterialNoMass": {
"title": "EnergyMaterialNoMass",
"description": "No mass opaque material representing a layer within an opaque construction.\n\nUsed when only the thermal resistance (R value) of the material is known.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"r_value": {
"title": "R Value",
"description": "The thermal resistance (R-value) of the material layer [m2-K/W].",
"minimum": 0.001,
"type": "number",
"format": "double"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyMaterialNoMass",
"pattern": "^EnergyMaterialNoMass$",
"type": "string",
"readOnly": true
},
"roughness": {
"title": "Roughness",
"default": "MediumRough",
"allOf": [
{
"$ref": "#/components/schemas/Roughness"
}
]
},
"thermal_absorptance": {
"title": "Thermal Absorptance",
"description": "Fraction of incident long wavelength radiation that is absorbed by the material. Default value is 0.9.",
"default": 0.9,
"exclusiveMinimum": 0,
"maximum": 0.99999,
"type": "number",
"format": "double"
},
"solar_absorptance": {
"title": "Solar Absorptance",
"description": "Fraction of incident solar radiation absorbed by the material. Default value is 0.7.",
"default": 0.7,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"visible_absorptance": {
"title": "Visible Absorptance",
"description": "Fraction of incident visible wavelength radiation absorbed by the material. Default value is 0.7.",
"default": 0.7,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"r_value"
],
"additionalProperties": false
},
"OpaqueConstruction": {
"title": "OpaqueConstruction",
"description": "Construction for opaque objects (Face, Shade, Door).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"layers": {
"title": "Layers",
"description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"materials": {
"title": "Materials",
"description": "List of opaque materials. The order of the materials is from outside to inside.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyMaterial"
},
{
"$ref": "#/components/schemas/EnergyMaterialNoMass"
}
]
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "OpaqueConstruction",
"pattern": "^OpaqueConstruction$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"layers",
"materials"
],
"additionalProperties": false
},
"WallConstructionSet": {
"title": "WallConstructionSet",
"description": "A set of constructions for wall assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "An OpaqueConstruction for walls with an Outdoors boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"ground_construction": {
"title": "Ground Construction",
"description": "An OpaqueConstruction for walls with a Ground boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"type": {
"title": "Type",
"default": "WallConstructionSet",
"pattern": "^WallConstructionSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"FloorConstructionSet": {
"title": "FloorConstructionSet",
"description": "A set of constructions for floor assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "An OpaqueConstruction for walls with an Outdoors boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"ground_construction": {
"title": "Ground Construction",
"description": "An OpaqueConstruction for walls with a Ground boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"type": {
"title": "Type",
"default": "FloorConstructionSet",
"pattern": "^FloorConstructionSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"RoofCeilingConstructionSet": {
"title": "RoofCeilingConstructionSet",
"description": "A set of constructions for roof and ceiling assemblies.",
"type": "object",
"properties": {
"interior_construction": {
"title": "Interior Construction",
"description": "An OpaqueConstruction for walls with a Surface or Adiabatic boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "An OpaqueConstruction for walls with an Outdoors boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"ground_construction": {
"title": "Ground Construction",
"description": "An OpaqueConstruction for walls with a Ground boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"type": {
"title": "Type",
"default": "RoofCeilingConstructionSet",
"pattern": "^RoofCeilingConstructionSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"EnergyWindowMaterialSimpleGlazSys": {
"title": "EnergyWindowMaterialSimpleGlazSys",
"description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"u_factor": {
"title": "U Factor",
"description": "Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).",
"exclusiveMinimum": 0,
"maximum": 5.8,
"type": "number",
"format": "double"
},
"shgc": {
"title": "Shgc",
"description": "Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.",
"exclusiveMinimum": 0,
"exclusiveMaximum": 1,
"type": "number",
"format": "double"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialSimpleGlazSys",
"pattern": "^EnergyWindowMaterialSimpleGlazSys$",
"type": "string",
"readOnly": true
},
"vt": {
"title": "Vt",
"description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
"default": 0.54,
"exclusiveMinimum": 0,
"exclusiveMaximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"u_factor",
"shgc"
],
"additionalProperties": false
},
"EnergyWindowMaterialGlazing": {
"title": "EnergyWindowMaterialGlazing",
"description": "Describe a single glass pane corresponding to a layer in a window construction.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialGlazing",
"pattern": "^EnergyWindowMaterialGlazing$",
"type": "string",
"readOnly": true
},
"thickness": {
"title": "Thickness",
"description": "The surface-to-surface of the glass in meters. Default value is 0.003.",
"default": 0.003,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"solar_transmittance": {
"title": "Solar Transmittance",
"description": "Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.",
"default": 0.85,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"solar_reflectance": {
"title": "Solar Reflectance",
"description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.",
"default": 0.075,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"solar_reflectance_back": {
"title": "Solar Reflectance Back",
"description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
"type": "number",
"format": "double"
},
"visible_transmittance": {
"title": "Visible Transmittance",
"description": "Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.",
"default": 0.9,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"visible_reflectance": {
"title": "Visible Reflectance",
"description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.",
"default": 0.075,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"visible_reflectance_back": {
"title": "Visible Reflectance Back",
"description": "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.",
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"infrared_transmittance": {
"title": "Infrared Transmittance",
"description": "Long-wave transmittance at normal incidence.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"emissivity": {
"title": "Emissivity",
"description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
"default": 0.84,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"emissivity_back": {
"title": "Emissivity Back",
"description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
"default": 0.84,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"conductivity": {
"title": "Conductivity",
"description": "Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.",
"default": 0.9,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"dirt_correction": {
"title": "Dirt Correction",
"description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
"default": 1,
"type": "number",
"format": "double"
},
"solar_diffusing": {
"title": "Solar Diffusing",
"description": "Takes values True and 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.",
"default": false,
"type": "boolean"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"GasType": {
"title": "GasType",
"description": "An enumeration.",
"enum": [
"Air",
"Argon",
"Krypton",
"Xenon"
],
"type": "string"
},
"EnergyWindowMaterialGas": {
"title": "EnergyWindowMaterialGas",
"description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialGas",
"pattern": "^EnergyWindowMaterialGas$",
"type": "string",
"readOnly": true
},
"thickness": {
"title": "Thickness",
"description": "Thickness of the gas layer in meters. Default value is 0.0125.",
"default": 0.0125,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"gas_type": {
"title": "Gas Type",
"default": "Air",
"allOf": [
{
"$ref": "#/components/schemas/GasType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"EnergyWindowMaterialGasCustom": {
"title": "EnergyWindowMaterialGasCustom",
"description": "Create single layer of custom gas.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"conductivity_coeff_a": {
"title": "Conductivity Coeff A",
"description": "The A coefficient for gas conductivity in W/(m-K).",
"type": "number",
"format": "double"
},
"viscosity_coeff_a": {
"title": "Viscosity Coeff A",
"description": "The A coefficient for gas viscosity in kg/(m-s).",
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"specific_heat_coeff_a": {
"title": "Specific Heat Coeff A",
"description": "The A coefficient for gas specific heat in J/(kg-K).",
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"specific_heat_ratio": {
"title": "Specific Heat Ratio",
"description": "The specific heat ratio for gas.",
"exclusiveMinimum": 1,
"type": "number",
"format": "double"
},
"molecular_weight": {
"title": "Molecular Weight",
"description": "The molecular weight for gas in g/mol.",
"minimum": 20,
"maximum": 200,
"type": "number",
"format": "double"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialGasCustom",
"pattern": "^EnergyWindowMaterialGasCustom$",
"type": "string",
"readOnly": true
},
"thickness": {
"title": "Thickness",
"description": "Thickness of the gas layer in meters. Default value is 0.0125.",
"default": 0.0125,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"conductivity_coeff_b": {
"title": "Conductivity Coeff B",
"description": "The B coefficient for gas conductivity in W/(m-K2).",
"default": 0,
"type": "number",
"format": "double"
},
"conductivity_coeff_c": {
"title": "Conductivity Coeff C",
"description": "The C coefficient for gas conductivity in W/(m-K3).",
"default": 0,
"type": "number",
"format": "double"
},
"viscosity_coeff_b": {
"title": "Viscosity Coeff B",
"description": "The B coefficient for gas viscosity in kg/(m-s-K).",
"default": 0,
"type": "number",
"format": "double"
},
"viscosity_coeff_c": {
"title": "Viscosity Coeff C",
"description": "The C coefficient for gas viscosity in kg/(m-s-K2).",
"default": 0,
"type": "number",
"format": "double"
},
"specific_heat_coeff_b": {
"title": "Specific Heat Coeff B",
"description": "The B coefficient for gas specific heat in J/(kg-K2).",
"default": 0,
"type": "number",
"format": "double"
},
"specific_heat_coeff_c": {
"title": "Specific Heat Coeff C",
"description": "The C coefficient for gas specific heat in J/(kg-K3).",
"default": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"conductivity_coeff_a",
"viscosity_coeff_a",
"specific_heat_coeff_a",
"specific_heat_ratio",
"molecular_weight"
],
"additionalProperties": false
},
"EnergyWindowMaterialGasMixture": {
"title": "EnergyWindowMaterialGasMixture",
"description": "Create a mixture of two to four different gases to fill the panes of multiple\npane windows.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"gas_types": {
"title": "Gas Types",
"description": "List of gases in the gas mixture.",
"type": "array",
"items": {
"title": " Gas Types",
"allOf": [
{
"$ref": "#/components/schemas/GasType"
}
]
},
"minItems": 2,
"maxItems": 4
},
"gas_fractions": {
"title": "Gas Fractions",
"description": "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.",
"minItems": 2,
"maxItems": 4,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialGasMixture",
"pattern": "^EnergyWindowMaterialGasMixture$",
"type": "string",
"readOnly": true
},
"thickness": {
"title": "Thickness",
"description": "The thickness of the gas mixture layer in meters.",
"default": 0.0125,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"gas_types",
"gas_fractions"
],
"additionalProperties": false
},
"WindowConstruction": {
"title": "WindowConstruction",
"description": "Construction for window objects (Aperture, Door).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"layers": {
"title": "Layers",
"description": "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.",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"materials": {
"title": "Materials",
"description": "List of glazing and gas materials. The order of the materials is from outside to inside. 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.",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGas"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
}
]
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "WindowConstruction",
"pattern": "^WindowConstruction$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"layers",
"materials"
],
"additionalProperties": false
},
"ApertureConstructionSet": {
"title": "ApertureConstructionSet",
"description": "A set of constructions for aperture assemblies.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ApertureConstructionSet",
"pattern": "^ApertureConstructionSet$",
"type": "string",
"readOnly": true
},
"interior_construction": {
"title": "Interior Construction",
"description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
},
"window_construction": {
"title": "Window Construction",
"description": "A WindowConstruction for all apertures with a Surface boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
},
"skylight_construction": {
"title": "Skylight Construction",
"description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
},
"operable_construction": {
"title": "Operable Construction",
"description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
}
},
"additionalProperties": false
},
"DoorConstructionSet": {
"title": "DoorConstructionSet",
"description": "A set of constructions for door assemblies.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "DoorConstructionSet",
"pattern": "^DoorConstructionSet$",
"type": "string",
"readOnly": true
},
"interior_construction": {
"title": "Interior Construction",
"description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"exterior_construction": {
"title": "Exterior Construction",
"description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"overhead_construction": {
"title": "Overhead Construction",
"description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
"allOf": [
{
"$ref": "#/components/schemas/OpaqueConstruction"
}
]
},
"exterior_glass_construction": {
"title": "Exterior Glass Construction",
"description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
},
"interior_glass_construction": {
"title": "Interior Glass Construction",
"description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
}
},
"additionalProperties": false
},
"ShadeConstruction": {
"title": "ShadeConstruction",
"description": "Construction for Shade objects.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ShadeConstruction",
"pattern": "^ShadeConstruction$",
"type": "string",
"readOnly": true
},
"solar_reflectance": {
"title": "Solar Reflectance",
"description": "A number for the solar reflectance of the construction.",
"default": 0.2,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"visible_reflectance": {
"title": "Visible Reflectance",
"description": "A number for the visible reflectance of the construction.",
"default": 0.2,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"is_specular": {
"title": "Is Specular",
"description": "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.",
"default": false,
"type": "boolean"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ScheduleDay": {
"title": "ScheduleDay",
"description": "Used to describe the daily schedule for a single simulation day.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"values": {
"title": "Values",
"description": "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.",
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleDay",
"pattern": "^ScheduleDay$",
"type": "string",
"readOnly": true
},
"times": {
"title": "Times",
"description": "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\".",
"default": [
0,
0
],
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"minItems": 2,
"maxItems": 2
}
},
"interpolate": {
"title": "Interpolate",
"description": "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.",
"default": false,
"type": "boolean"
}
},
"required": [
"identifier",
"values"
],
"additionalProperties": false
},
"ScheduleRuleAbridged": {
"title": "ScheduleRuleAbridged",
"description": "Schedule rule including a ScheduleDay and when it should be applied..",
"type": "object",
"properties": {
"schedule_day": {
"title": "Schedule Day",
"description": "The identifier of a ScheduleDay object associated with this rule.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleRuleAbridged",
"pattern": "^ScheduleRuleAbridged$",
"type": "string",
"readOnly": true
},
"apply_sunday": {
"title": "Apply Sunday",
"description": "Boolean noting whether to apply schedule_day on Sundays.",
"default": false,
"type": "boolean"
},
"apply_monday": {
"title": "Apply Monday",
"description": "Boolean noting whether to apply schedule_day on Mondays.",
"default": false,
"type": "boolean"
},
"apply_tuesday": {
"title": "Apply Tuesday",
"description": "Boolean noting whether to apply schedule_day on Tuesdays.",
"default": false,
"type": "boolean"
},
"apply_wednesday": {
"title": "Apply Wednesday",
"description": "Boolean noting whether to apply schedule_day on Wednesdays.",
"default": false,
"type": "boolean"
},
"apply_thursday": {
"title": "Apply Thursday",
"description": "Boolean noting whether to apply schedule_day on Thursdays.",
"default": false,
"type": "boolean"
},
"apply_friday": {
"title": "Apply Friday",
"description": "Boolean noting whether to apply schedule_day on Fridays.",
"default": false,
"type": "boolean"
},
"apply_saturday": {
"title": "Apply Saturday",
"description": "Boolean noting whether to apply schedule_day on Saturdays.",
"default": false,
"type": "boolean"
},
"start_date": {
"title": "Start Date",
"description": "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).",
"default": [
1,
1
],
"minItems": 2,
"maxItems": 3,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"end_date": {
"title": "End Date",
"description": "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).",
"default": [
12,
31
],
"minItems": 2,
"maxItems": 3,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
"required": [
"schedule_day"
],
"additionalProperties": false
},
"NoLimit": {
"title": "NoLimit",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "NoLimit",
"pattern": "^NoLimit$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ScheduleNumericType": {
"title": "ScheduleNumericType",
"description": "Designates how the range values are validated.",
"enum": [
"Continuous",
"Discrete"
],
"type": "string"
},
"ScheduleUnitType": {
"title": "ScheduleUnitType",
"description": "An enumeration.",
"enum": [
"Dimensionless",
"Temperature",
"DeltaTemperature",
"PrecipitationRate",
"Angle",
"ConvectionCoefficient",
"ActivityLevel",
"Velocity",
"Capacity",
"Power",
"Availability",
"Percent",
"Control",
"Mode"
],
"type": "string"
},
"ScheduleTypeLimit": {
"title": "ScheduleTypeLimit",
"description": "Specifies the data types and limits for values contained in schedules.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleTypeLimit",
"pattern": "^ScheduleTypeLimit$",
"type": "string",
"readOnly": true
},
"lower_limit": {
"title": "Lower Limit",
"description": "Lower limit for the schedule type or NoLimit.",
"default": {
"type": "NoLimit"
},
"anyOf": [
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number",
"format": "double"
}
]
},
"upper_limit": {
"title": "Upper Limit",
"description": "Upper limit for the schedule type or NoLimit.",
"default": {
"type": "NoLimit"
},
"anyOf": [
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number",
"format": "double"
}
]
},
"numeric_type": {
"title": "Numeric Type",
"default": "Continuous",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleNumericType"
}
]
},
"unit_type": {
"title": "Unit Type",
"default": "Dimensionless",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleUnitType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ScheduleRuleset": {
"title": "ScheduleRuleset",
"description": "Used to define a schedule for a default day, further described by ScheduleRule.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"day_schedules": {
"title": "Day Schedules",
"description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleDay"
}
},
"default_day_schedule": {
"title": "Default Day Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleRuleset",
"pattern": "^ScheduleRuleset$",
"type": "string",
"readOnly": true
},
"schedule_rules": {
"title": "Schedule Rules",
"description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleRuleAbridged"
}
},
"holiday_schedule": {
"title": "Holiday Schedule",
"description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"summer_designday_schedule": {
"title": "Summer Designday Schedule",
"description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"winter_designday_schedule": {
"title": "Winter Designday Schedule",
"description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"schedule_type_limit": {
"title": "Schedule Type Limit",
"description": "ScheduleTypeLimit object 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.",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleTypeLimit"
}
]
}
},
"required": [
"identifier",
"day_schedules",
"default_day_schedule"
],
"additionalProperties": false
},
"ScheduleFixedInterval": {
"title": "ScheduleFixedInterval",
"description": "Used to specify a start date and a list of values for a period of analysis.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"values": {
"title": "Values",
"description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
"minItems": 24,
"maxItems": 527040,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleFixedInterval",
"pattern": "^ScheduleFixedInterval$",
"type": "string",
"readOnly": true
},
"schedule_type_limit": {
"title": "Schedule Type Limit",
"description": "ScheduleTypeLimit object 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.",
"allOf": [
{
"$ref": "#/components/schemas/ScheduleTypeLimit"
}
]
},
"timestep": {
"title": "Timestep",
"description": "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.",
"default": 1,
"type": "integer",
"format": "int32"
},
"start_date": {
"title": "Start Date",
"description": "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).",
"default": [
1,
1
],
"minItems": 2,
"maxItems": 3,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"placeholder_value": {
"title": "Placeholder Value",
"description": " 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.",
"default": 0,
"type": "number",
"format": "double"
},
"interpolate": {
"title": "Interpolate",
"description": "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.",
"default": false,
"type": "boolean"
}
},
"required": [
"identifier",
"values"
],
"additionalProperties": false
},
"AirBoundaryConstruction": {
"title": "AirBoundaryConstruction",
"description": "Construction for Air Boundary objects.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"air_mixing_schedule": {
"title": "Air Mixing Schedule",
"description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "AirBoundaryConstruction",
"pattern": "^AirBoundaryConstruction$",
"type": "string",
"readOnly": true
},
"air_mixing_per_area": {
"title": "Air Mixing Per Area",
"description": "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.",
"default": 0.1,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"air_mixing_schedule"
],
"additionalProperties": false
},
"ConstructionSet": {
"title": "ConstructionSet",
"description": "A set of constructions for different surface types and boundary conditions.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ConstructionSet",
"pattern": "^ConstructionSet$",
"type": "string",
"readOnly": true
},
"wall_set": {
"title": "Wall Set",
"description": "A WallConstructionSet object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/WallConstructionSet"
}
]
},
"floor_set": {
"title": "Floor Set",
"description": "A FloorConstructionSet object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/FloorConstructionSet"
}
]
},
"roof_ceiling_set": {
"title": "Roof Ceiling Set",
"description": "A RoofCeilingConstructionSet object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/RoofCeilingConstructionSet"
}
]
},
"aperture_set": {
"title": "Aperture Set",
"description": "A ApertureConstructionSet object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/ApertureConstructionSet"
}
]
},
"door_set": {
"title": "Door Set",
"description": "A DoorConstructionSet object for this ConstructionSet.",
"allOf": [
{
"$ref": "#/components/schemas/DoorConstructionSet"
}
]
},
"shade_construction": {
"title": "Shade Construction",
"description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
"allOf": [
{
"$ref": "#/components/schemas/ShadeConstruction"
}
]
},
"air_boundary_construction": {
"title": "Air Boundary Construction",
"description": "An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
"allOf": [
{
"$ref": "#/components/schemas/AirBoundaryConstruction"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"OpaqueConstructionAbridged": {
"title": "OpaqueConstructionAbridged",
"description": "Construction for opaque objects (Face, Shade, Door).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"layers": {
"title": "Layers",
"description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "OpaqueConstructionAbridged",
"pattern": "^OpaqueConstructionAbridged$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"layers"
],
"additionalProperties": false
},
"WindowConstructionAbridged": {
"title": "WindowConstructionAbridged",
"description": "Construction for window objects (Aperture, Door).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"layers": {
"title": "Layers",
"description": "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.",
"minItems": 1,
"maxItems": 8,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "WindowConstructionAbridged",
"pattern": "^WindowConstructionAbridged$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"layers"
],
"additionalProperties": false
},
"ShadeLocation": {
"title": "ShadeLocation",
"description": "Choices for where a shade material is located in a window assembly.",
"enum": [
"Interior",
"Between",
"Exterior"
],
"type": "string"
},
"ControlType": {
"title": "ControlType",
"description": "Choices for how the shading device is controlled.",
"enum": [
"AlwaysOn",
"OnIfHighSolarOnWindow",
"OnIfHighHorizontalSolar",
"OnIfHighOutdoorAirTemperature",
"OnIfHighZoneAirTemperature",
"OnIfHighZoneCooling",
"OnNightIfLowOutdoorTempAndOffDay",
"OnNightIfLowInsideTempAndOffDay",
"OnNightIfHeatingAndOffDay"
],
"type": "string"
},
"WindowConstructionShadeAbridged": {
"title": "WindowConstructionShadeAbridged",
"description": "Construction for window objects with an included shade layer.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"window_construction": {
"title": "Window Construction",
"description": "A WindowConstructionAbridged object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstructionAbridged"
}
]
},
"shade_material": {
"title": "Shade Material",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "WindowConstructionShadeAbridged",
"pattern": "^WindowConstructionShadeAbridged$",
"type": "string",
"readOnly": true
},
"shade_location": {
"title": "Shade Location",
"description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
"default": "Interior",
"allOf": [
{
"$ref": "#/components/schemas/ShadeLocation"
}
]
},
"control_type": {
"title": "Control Type",
"description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
"default": "AlwaysOn",
"allOf": [
{
"$ref": "#/components/schemas/ControlType"
}
]
},
"setpoint": {
"title": "Setpoint",
"description": "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.\"",
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier",
"window_construction",
"shade_material"
],
"additionalProperties": false
},
"AirBoundaryConstructionAbridged": {
"title": "AirBoundaryConstructionAbridged",
"description": "Construction for Air Boundary objects.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"air_mixing_schedule": {
"title": "Air Mixing Schedule",
"description": "Identifier of a fractional schedule for the air mixing schedule across the construction.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "AirBoundaryConstructionAbridged",
"pattern": "^AirBoundaryConstructionAbridged$",
"type": "string",
"readOnly": true
},
"air_mixing_per_area": {
"title": "Air Mixing Per Area",
"description": "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.",
"default": 0.1,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"air_mixing_schedule"
],
"additionalProperties": false
},
"EnergyWindowMaterialShade": {
"title": "EnergyWindowMaterialShade",
"description": "This object specifies the properties of window shade materials.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialShade",
"pattern": "^EnergyWindowMaterialShade$",
"type": "string",
"readOnly": true
},
"solar_transmittance": {
"title": "Solar Transmittance",
"description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.",
"default": 0.4,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"solar_reflectance": {
"title": "Solar Reflectance",
"description": "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",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"visible_transmittance": {
"title": "Visible Transmittance",
"description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.",
"default": 0.4,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"visible_reflectance": {
"title": "Visible Reflectance",
"description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4",
"default": 0.4,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"emissivity": {
"title": "Emissivity",
"description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.",
"default": 0.9,
"exclusiveMinimum": 0,
"exclusiveMaximum": 1,
"type": "number",
"format": "double"
},
"infrared_transmittance": {
"title": "Infrared Transmittance",
"description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"thickness": {
"title": "Thickness",
"description": "The thickness of the shade material in meters. Default value is 0.005.",
"default": 0.005,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"conductivity": {
"title": "Conductivity",
"description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
"default": 0.1,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"distance_to_glass": {
"title": "Distance To Glass",
"description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
"default": 0.05,
"minimum": 0.001,
"maximum": 1,
"type": "number",
"format": "double"
},
"top_opening_multiplier": {
"title": "Top Opening Multiplier",
"description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"bottom_opening_multiplier": {
"title": "Bottom Opening Multiplier",
"description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"left_opening_multiplier": {
"title": "Left Opening Multiplier",
"description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"right_opening_multiplier": {
"title": "Right Opening Multiplier",
"description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"airflow_permeability": {
"title": "Airflow Permeability",
"description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 0.8,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"SlatOrientation": {
"title": "SlatOrientation",
"description": "An enumeration.",
"enum": [
"Horizontal",
"Vertical"
],
"type": "string"
},
"EnergyWindowMaterialBlind": {
"title": "EnergyWindowMaterialBlind",
"description": "Window blind material consisting of flat, equally-spaced slats.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "EnergyWindowMaterialBlind",
"pattern": "^EnergyWindowMaterialBlind$",
"type": "string",
"readOnly": true
},
"slat_orientation": {
"title": "Slat Orientation",
"default": "Horizontal",
"allOf": [
{
"$ref": "#/components/schemas/SlatOrientation"
}
]
},
"slat_width": {
"title": "Slat Width",
"description": "The width of slat measured from edge to edge in meters.",
"default": 0.025,
"exclusiveMinimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"slat_separation": {
"title": "Slat Separation",
"description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
"default": 0.01875,
"exclusiveMinimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"slat_thickness": {
"title": "Slat Thickness",
"description": "The distance between the faces of a slat in meters. The default value is 0.001.",
"default": 0.001,
"exclusiveMinimum": 0,
"maximum": 0.1,
"type": "number",
"format": "double"
},
"slat_angle": {
"title": "Slat Angle",
"description": "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.",
"default": 45,
"minimum": 0,
"maximum": 180,
"type": "number",
"format": "double"
},
"slat_conductivity": {
"title": "Slat Conductivity",
"description": "The thermal conductivity of the slat in W/(m-K). Default value is 221.",
"default": 221,
"exclusiveMinimum": 0,
"type": "number",
"format": "double"
},
"beam_solar_transmittance": {
"title": "Beam Solar Transmittance",
"description": "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.",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"beam_solar_reflectance": {
"title": "Beam Solar Reflectance",
"description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"beam_solar_reflectance_back": {
"title": "Beam Solar Reflectance Back",
"description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_solar_transmittance": {
"title": "Diffuse Solar Transmittance",
"description": "The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_solar_reflectance": {
"title": "Diffuse Solar Reflectance",
"description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_solar_reflectance_back": {
"title": "Diffuse Solar Reflectance Back",
"description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"beam_visible_transmittance": {
"title": "Beam Visible Transmittance",
"description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"beam_visible_reflectance": {
"title": "Beam Visible Reflectance",
"description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"beam_visible_reflectance_back": {
"title": "Beam Visible Reflectance Back",
"description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_visible_transmittance": {
"title": "Diffuse Visible Transmittance",
"description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_visible_reflectance": {
"title": "Diffuse Visible Reflectance",
"description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default value is 0.5.",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"diffuse_visible_reflectance_back": {
"title": "Diffuse Visible Reflectance Back",
"description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default value is 0.5.\u201d",
"default": 0.5,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"infrared_transmittance": {
"title": "Infrared Transmittance",
"description": "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.",
"default": 0,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"emissivity": {
"title": "Emissivity",
"description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
"default": 0.9,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"emissivity_back": {
"title": "Emissivity Back",
"description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
"default": 0.9,
"exclusiveMaximum": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"distance_to_glass": {
"title": "Distance To Glass",
"description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
"default": 0.05,
"minimum": 0.01,
"maximum": 1,
"type": "number",
"format": "double"
},
"top_opening_multiplier": {
"title": "Top Opening Multiplier",
"description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"bottom_opening_multiplier": {
"title": "Bottom Opening Multiplier",
"description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"left_opening_multiplier": {
"title": "Left Opening Multiplier",
"description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"right_opening_multiplier": {
"title": "Right Opening Multiplier",
"description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
"default": 0.5,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WindowConstructionShade": {
"title": "WindowConstructionShade",
"description": "Construction for window objects (Aperture, Door).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"window_construction": {
"title": "Window Construction",
"description": "A WindowConstruction object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
"allOf": [
{
"$ref": "#/components/schemas/WindowConstruction"
}
]
},
"shade_material": {
"title": "Shade Material",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/EnergyWindowMaterialShade"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialBlind"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "WindowConstructionShade",
"pattern": "^WindowConstructionShade$",
"type": "string",
"readOnly": true
},
"shade_location": {
"title": "Shade Location",
"description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
"default": "Interior",
"allOf": [
{
"$ref": "#/components/schemas/ShadeLocation"
}
]
},
"control_type": {
"title": "Control Type",
"description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
"default": "AlwaysOn",
"allOf": [
{
"$ref": "#/components/schemas/ControlType"
}
]
},
"setpoint": {
"title": "Setpoint",
"description": "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.\"",
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
}
},
"required": [
"identifier",
"window_construction",
"shade_material"
],
"additionalProperties": false
},
"EconomizerType": {
"title": "EconomizerType",
"description": "An enumeration.",
"enum": [
"NoEconomizer",
"DifferentialDryBulb",
"DifferentialEnthalpy"
],
"type": "string"
},
"Autosize": {
"title": "Autosize",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "Autosize",
"pattern": "^Autosize$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"IdealAirSystemAbridged": {
"title": "IdealAirSystemAbridged",
"description": "Provides a model for an ideal HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "IdealAirSystemAbridged",
"pattern": "^IdealAirSystemAbridged$",
"type": "string",
"readOnly": true
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the ideal air system. Economizers will mix in a greater amount of outdoor air to cool the zone (rather than running the cooling system) when the zone needs cooling and the outdoor air is cooler than the zone.",
"default": "DifferentialDryBulb",
"allOf": [
{
"$ref": "#/components/schemas/EconomizerType"
}
]
},
"demand_controlled_ventilation": {
"title": "Demand Controlled Ventilation",
"description": "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.",
"default": false,
"type": "boolean"
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "A number between 0 and 1 for the effectiveness of sensible heat recovery within the system.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "A number between 0 and 1 for the effectiveness of latent heat recovery within the system.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"heating_air_temperature": {
"title": "Heating Air Temperature",
"description": "A number for the maximum heating supply air temperature [C].",
"default": 50,
"exclusiveMinimum": 0,
"exclusiveMaximum": 100,
"type": "number",
"format": "double"
},
"cooling_air_temperature": {
"title": "Cooling Air Temperature",
"description": "A number for the minimum cooling supply air temperature [C].",
"default": 13,
"exclusiveMinimum": -100,
"exclusiveMaximum": 50,
"type": "number",
"format": "double"
},
"heating_limit": {
"title": "Heating Limit",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number",
"minimum": 0,
"format": "double"
}
]
},
"cooling_limit": {
"title": "Cooling Limit",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"$ref": "#/components/schemas/NoLimit"
},
{
"type": "number",
"minimum": 0,
"format": "double"
}
]
},
"heating_availability": {
"title": "Heating Availability",
"description": "An optional identifier of a schedule to set the availability of heating over the course of the simulation.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"cooling_availability": {
"title": "Cooling Availability",
"description": "An optional identifier of a schedule to set the availability of cooling over the course of the simulation.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Vintages": {
"title": "Vintages",
"description": "An enumeration.",
"enum": [
"90.1-2013",
"90.1-2010",
"90.1-2007",
"90.1-2004",
"DOE Ref 1980-2004",
"DOE Ref Pre-1980"
],
"type": "string"
},
"AllAirEconomizerType": {
"title": "AllAirEconomizerType",
"description": "An enumeration.",
"enum": [
"Inferred",
"NoEconomizer",
"DifferentialDryBulb",
"DifferentialEnthalpy"
],
"type": "string"
},
"VAVEquipmentType": {
"title": "VAVEquipmentType",
"description": "An enumeration.",
"enum": [
"VAV chiller with gas boiler reheat",
"VAV chiller with central air source heat pump reheat",
"VAV chiller with district hot water reheat",
"VAV chiller with PFP boxes",
"VAV chiller with gas coil reheat",
"VAV chiller with no reheat with baseboard electric",
"VAV chiller with no reheat with gas unit heaters",
"VAV chiller with no reheat with zone heat pump",
"VAV air-cooled chiller with gas boiler reheat",
"VAV air-cooled chiller with central air source heat pump reheat",
"VAV air-cooled chiller with district hot water reheat",
"VAV air-cooled chiller with PFP boxes",
"VAV air-cooled chiller with gas coil reheat",
"VAV air-cooled chiller with no reheat with baseboard electric",
"VAV air-cooled chiller with no reheat with gas unit heaters",
"VAV air-cooled chiller with no reheat with zone heat pump",
"VAV district chilled water with gas boiler reheat",
"VAV district chilled water with central air source heat pump reheat",
"VAV district chilled water with district hot water reheat",
"VAV district chilled water with PFP boxes",
"VAV district chilled water with gas coil reheat",
"VAV district chilled water with no reheat with baseboard electric",
"VAV district chilled water with no reheat with gas unit heaters",
"VAV district chilled water with no reheat with zone heat pump"
],
"type": "string"
},
"VAV": {
"title": "VAV",
"description": "Variable Air Volume (VAV) HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
"default": "Inferred",
"allOf": [
{
"$ref": "#/components/schemas/AllAirEconomizerType"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "VAV",
"pattern": "^VAV$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
"default": "VAV chiller with gas boiler reheat",
"allOf": [
{
"$ref": "#/components/schemas/VAVEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"PVAVEquipmentType": {
"title": "PVAVEquipmentType",
"description": "An enumeration.",
"enum": [
"PVAV with gas boiler reheat",
"PVAV with central air source heat pump reheat",
"PVAV with district hot water reheat",
"PVAV with PFP boxes",
"PVAV with gas heat with electric reheat"
],
"type": "string"
},
"PVAV": {
"title": "PVAV",
"description": "Packaged Variable Air Volume (PVAV) HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
"default": "Inferred",
"allOf": [
{
"$ref": "#/components/schemas/AllAirEconomizerType"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "PVAV",
"pattern": "^PVAV$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the VAVEquipmentType enumeration.",
"default": "PVAV with gas boiler reheat",
"allOf": [
{
"$ref": "#/components/schemas/PVAVEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"PSZEquipmentType": {
"title": "PSZEquipmentType",
"description": "An enumeration.",
"enum": [
"PSZ-AC with baseboard electric",
"PSZ-AC with baseboard gas boiler",
"PSZ-AC with baseboard district hot water",
"PSZ-AC with gas unit heaters",
"PSZ-AC with electric coil",
"PSZ-AC with gas coil",
"PSZ-AC with gas boiler",
"PSZ-AC with central air source heat pump",
"PSZ-AC with district hot water",
"PSZ-AC with no heat",
"PSZ-AC district chilled water with baseboard electric",
"PSZ-AC district chilled water with baseboard gas boiler",
"PSZ-AC district chilled water with baseboard district hot water",
"PSZ-AC district chilled water with gas unit heaters",
"PSZ-AC district chilled water with electric coil",
"PSZ-AC district chilled water with gas coil",
"PSZ-AC district chilled water with gas boiler",
"PSZ-AC district chilled water with central air source heat pump",
"PSZ-AC district chilled water with district hot water",
"PSZ-AC district chilled water with no heat",
"PSZ-HP"
],
"type": "string"
},
"PSZ": {
"title": "PSZ",
"description": "Packaged Single-Zone (PSZ) HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
"default": "Inferred",
"allOf": [
{
"$ref": "#/components/schemas/AllAirEconomizerType"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "PSZ",
"pattern": "^PSZ$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the PVAVEquipmentType enumeration.",
"default": "PSZ-AC with baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/PSZEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"PTACEquipmentType": {
"title": "PTACEquipmentType",
"description": "An enumeration.",
"enum": [
"PTAC with baseboard electric",
"PTAC with baseboard gas boiler",
"PTAC with baseboard district hot water",
"PTAC with gas unit heaters",
"PTAC with electric coil",
"PTAC with gas coil",
"PTAC with gas boiler",
"PTAC with central air source heat pump",
"PTAC with district hot water",
"PTAC with no heat",
"PTHP"
],
"type": "string"
},
"PTAC": {
"title": "PTAC",
"description": "Packaged Terminal Air Conditioning (PTAC) or Heat Pump (PTHP) HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
"default": "Inferred",
"allOf": [
{
"$ref": "#/components/schemas/AllAirEconomizerType"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "PTAC",
"pattern": "^PTAC$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the PTACEquipmentType enumeration.",
"default": "PTAC with baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/PTACEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"FurnaceEquipmentType": {
"title": "FurnaceEquipmentType",
"description": "An enumeration.",
"enum": [
"Forced air furnace"
],
"type": "string"
},
"ForcedAirFurnace": {
"title": "ForcedAirFurnace",
"description": "Forced Air Furnace HVAC system. Intended for spaces only requiring heating.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"economizer_type": {
"title": "Economizer Type",
"description": "Text to indicate the type of air-side economizer used on the system (from the AllAirEconomizerType enumeration). If Inferred, the economizer will be set to whatever is recommended for the given vintage.",
"default": "Inferred",
"allOf": [
{
"$ref": "#/components/schemas/AllAirEconomizerType"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "ForcedAirFurnace",
"pattern": "^ForcedAirFurnace$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the FurnaceEquipmentType enumeration.",
"default": "Forced air furnace",
"allOf": [
{
"$ref": "#/components/schemas/FurnaceEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"FCUwithDOASEquipmentType": {
"title": "FCUwithDOASEquipmentType",
"description": "An enumeration.",
"enum": [
"DOAS with fan coil chiller with boiler",
"DOAS with fan coil chiller with central air source heat pump",
"DOAS with fan coil chiller with district hot water",
"DOAS with fan coil chiller with baseboard electric",
"DOAS with fan coil chiller with gas unit heaters",
"DOAS with fan coil chiller with no heat",
"DOAS with fan coil air-cooled chiller with boiler",
"DOAS with fan coil air-cooled chiller with central air source heat pump",
"DOAS with fan coil air-cooled chiller with district hot water",
"DOAS with fan coil air-cooled chiller with baseboard electric",
"DOAS with fan coil air-cooled chiller with gas unit heaters",
"DOAS with fan coil air-cooled chiller with no heat",
"DOAS with fan coil district chilled water with boiler",
"DOAS with fan coil district chilled water with central air source heat pump",
"DOAS with fan coil district chilled water with district hot water",
"DOAS with fan coil district chilled water with baseboard electric",
"DOAS with fan coil district chilled water with gas unit heaters",
"DOAS with fan coil district chilled water with no heat"
],
"type": "string"
},
"FCUwithDOAS": {
"title": "FCUwithDOAS",
"description": "Fan Coil Unit (FCU) with DOAS HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "FCUwithDOAS",
"pattern": "^FCUwithDOAS$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the FCUwithDOASEquipmentType enumeration.",
"default": "DOAS with fan coil chiller with boiler",
"allOf": [
{
"$ref": "#/components/schemas/FCUwithDOASEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WSHPwithDOASEquipmentType": {
"title": "WSHPwithDOASEquipmentType",
"description": "An enumeration.",
"enum": [
"DOAS with water source heat pumps fluid cooler with boiler",
"DOAS with water source heat pumps cooling tower with boiler",
"DOAS with water source heat pumps with ground source heat pump",
"DOAS with water source heat pumps district chilled water with district hot water"
],
"type": "string"
},
"WSHPwithDOAS": {
"title": "WSHPwithDOAS",
"description": "Water Source Heat Pump (WSHP) with DOAS HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "WSHPwithDOAS",
"pattern": "^WSHPwithDOAS$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the WSHPwithDOASEquipmentType enumeration.",
"default": "DOAS with water source heat pumps fluid cooler with boiler",
"allOf": [
{
"$ref": "#/components/schemas/WSHPwithDOASEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"VRFwithDOASEquipmentType": {
"title": "VRFwithDOASEquipmentType",
"description": "An enumeration.",
"enum": [
"DOAS with VRF"
],
"type": "string"
},
"VRFwithDOAS": {
"title": "VRFwithDOAS",
"description": "Variable Refrigerant Flow (VRF) with DOAS HVAC system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"sensible_heat_recovery": {
"title": "Sensible Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"latent_heat_recovery": {
"title": "Latent Heat Recovery",
"description": "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.",
"default": {
"type": "Autosize"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autosize"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
},
"type": {
"title": "Type",
"default": "VRFwithDOAS",
"pattern": "^VRFwithDOAS$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the VRFwithDOASEquipmentType enumeration.",
"default": "DOAS with VRF",
"allOf": [
{
"$ref": "#/components/schemas/VRFwithDOASEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"FCUEquipmentType": {
"title": "FCUEquipmentType",
"description": "An enumeration.",
"enum": [
"Fan coil chiller with boiler",
"Fan coil chiller with central air source heat pump",
"Fan coil chiller with district hot water",
"Fan coil chiller with baseboard electric",
"Fan coil chiller with gas unit heaters",
"Fan coil chiller with no heat",
"Fan coil air-cooled chiller with boiler",
"Fan coil air-cooled chiller with central air source heat pump",
"Fan coil air-cooled chiller with district hot water",
"Fan coil air-cooled chiller with baseboard electric",
"Fan coil air-cooled chiller with gas unit heaters",
"Fan coil air-cooled chiller with no heat",
"Fan coil district chilled water with boiler",
"Fan coil district chilled water with central air source heat pump",
"Fan coil district chilled water with district hot water",
"Fan coil district chilled water with baseboard electric",
"Fan coil district chilled water with gas unit heaters",
"Fan coil district chilled water with no heat"
],
"type": "string"
},
"FCU": {
"title": "FCU",
"description": "Fan Coil Unit (FCU) heating/cooling system (with no ventilation).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "FCU",
"pattern": "^FCU$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the FCUEquipmentType enumeration.",
"default": "Fan coil chiller with boiler",
"allOf": [
{
"$ref": "#/components/schemas/FCUEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WSHPEquipmentType": {
"title": "WSHPEquipmentType",
"description": "An enumeration.",
"enum": [
"Water source heat pumps fluid cooler with boiler",
"Water source heat pumps cooling tower with boiler",
"Water source heat pumps with ground source heat pump",
"Water source heat pumps district chilled water with district hot water"
],
"type": "string"
},
"WSHP": {
"title": "WSHP",
"description": "Direct evaporative cooling systems (with optional heating).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "WSHP",
"pattern": "^WSHP$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the WSHPEquipmentType enumeration.",
"default": "Water source heat pumps fluid cooler with boiler",
"allOf": [
{
"$ref": "#/components/schemas/WSHPEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"VRFEquipmentType": {
"title": "VRFEquipmentType",
"description": "An enumeration.",
"enum": [
"VRF"
],
"type": "string"
},
"VRF": {
"title": "VRF",
"description": "Variable Refrigerant Flow (VRF) heating/cooling system (with no ventilation).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "VRF",
"pattern": "^VRF$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the VRFEquipmentType enumeration.",
"default": "VRF",
"allOf": [
{
"$ref": "#/components/schemas/VRFEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"BaseboardEquipmentType": {
"title": "BaseboardEquipmentType",
"description": "An enumeration.",
"enum": [
"Baseboard electric",
"Baseboard gas boiler",
"Baseboard central air source heat pump",
"Baseboard district hot water"
],
"type": "string"
},
"Baseboard": {
"title": "Baseboard",
"description": "Baseboard heating system. Intended for spaces only requiring heating.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "Baseboard",
"pattern": "^Baseboard$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the BaseboardEquipmentType enumeration.",
"default": "Baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/BaseboardEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"EvaporativeCoolerEquipmentType": {
"title": "EvaporativeCoolerEquipmentType",
"description": "An enumeration.",
"enum": [
"Direct evap coolers with baseboard electric",
"Direct evap coolers with baseboard gas boiler",
"Direct evap coolers with baseboard central air source heat pump",
"Direct evap coolers with baseboard district hot water",
"Direct evap coolers with forced air furnace",
"Direct evap coolers with gas unit heaters",
"Direct evap coolers with no heat"
],
"type": "string"
},
"EvaporativeCooler": {
"title": "EvaporativeCooler",
"description": "Direct evaporative cooling systems (with optional heating).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "EvaporativeCooler",
"pattern": "^EvaporativeCooler$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the EvaporativeCoolerEquipmentType enumeration.",
"default": "Direct evap coolers with baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/EvaporativeCoolerEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ResidentialEquipmentType": {
"title": "ResidentialEquipmentType",
"description": "An enumeration.",
"enum": [
"Residential AC with baseboard electric",
"Residential AC with baseboard gas boiler",
"Residential AC with baseboard central air source heat pump",
"Residential AC with baseboard district hot water",
"Residential AC with residential forced air furnace",
"Residential AC with no heat",
"Residential heat pump",
"Residential heat pump with no cooling",
"Residential forced air furnace"
],
"type": "string"
},
"Residential": {
"title": "Residential",
"description": "Residential Air Conditioning, Heat Pump or Furnace system.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "Residential",
"pattern": "^Residential$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the ResidentialEquipmentType enumeration.",
"default": "Residential AC with baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/ResidentialEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WindowACEquipmentType": {
"title": "WindowACEquipmentType",
"description": "An enumeration.",
"enum": [
"Window AC with baseboard electric",
"Window AC with baseboard gas boiler",
"Window AC with baseboard central air source heat pump",
"Window AC with baseboard district hot water",
"Window AC with forced air furnace",
"Window AC with unit heaters",
"Window AC with no heat"
],
"type": "string"
},
"WindowAC": {
"title": "WindowAC",
"description": "Window Air Conditioning cooling system (with optional heating).",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "WindowAC",
"pattern": "^WindowAC$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the WindowACEquipmentType enumeration.",
"default": "Window AC with baseboard electric",
"allOf": [
{
"$ref": "#/components/schemas/WindowACEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"GasUnitHeaterEquipmentType": {
"title": "GasUnitHeaterEquipmentType",
"description": "An enumeration.",
"enum": [
"Gas unit heaters"
],
"type": "string"
},
"GasUnitHeater": {
"title": "GasUnitHeater",
"description": "Gas unit heating system. Intended for spaces only requiring heating.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"vintage": {
"title": "Vintage",
"description": "Text for the vintage of the template system. This will be used to set efficiencies for various pieces of equipment within the system. Further information about these defaults can be found in the version of ASHRAE 90.1 corresponding to the selected vintage. Read-only versions of the standard can be found at: https://www.ashrae.org/technical-resources/standards-and-guidelines/read-only-versions-of-ashrae-standards",
"default": "90.1-2013",
"allOf": [
{
"$ref": "#/components/schemas/Vintages"
}
]
},
"type": {
"title": "Type",
"default": "GasUnitHeater",
"pattern": "^GasUnitHeater$",
"type": "string",
"readOnly": true
},
"equipment_type": {
"title": "Equipment Type",
"description": "Text for the specific type of system equipment from the GasUnitHeaterEquipmentType enumeration.",
"default": "Gas unit heaters",
"allOf": [
{
"$ref": "#/components/schemas/GasUnitHeaterEquipmentType"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ProgramTypeAbridged": {
"title": "ProgramTypeAbridged",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ProgramTypeAbridged",
"pattern": "^ProgramTypeAbridged$",
"type": "string",
"readOnly": true
},
"people": {
"title": "People",
"description": "People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/PeopleAbridged"
}
]
},
"lighting": {
"title": "Lighting",
"description": "Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/LightingAbridged"
}
]
},
"electric_equipment": {
"title": "Electric Equipment",
"description": "ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/ElectricEquipmentAbridged"
}
]
},
"gas_equipment": {
"title": "Gas Equipment",
"description": "GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/GasEquipmentAbridged"
}
]
},
"infiltration": {
"title": "Infiltration",
"description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/InfiltrationAbridged"
}
]
},
"ventilation": {
"title": "Ventilation",
"description": "Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/VentilationAbridged"
}
]
},
"setpoint": {
"title": "Setpoint",
"description": "Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.",
"allOf": [
{
"$ref": "#/components/schemas/SetpointAbridged"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"People": {
"title": "People",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"people_per_area": {
"title": "People Per Area",
"description": "People per floor area expressed as [people/m2]",
"minimum": 0,
"type": "number",
"format": "double"
},
"occupancy_schedule": {
"title": "Occupancy Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"activity_schedule": {
"title": "Activity Schedule",
"description": "A schedule for the activity of the occupants over the course of the year. The type of this schedule should be Power and the values of the schedule equal to the number of Watts given off by an individual person in the room.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "People",
"pattern": "^People$",
"type": "string",
"readOnly": true
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "The radiant fraction of sensible heat released by people. The defaultvalue is 0.30.",
"default": 0.3,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the latent fraction of heat gain due to people or an Autocalculate object.",
"default": {
"type": "Autocalculate"
},
"anyOf": [
{
"$ref": "#/components/schemas/Autocalculate"
},
{
"type": "number",
"minimum": 0,
"maximum": 1,
"format": "double"
}
]
}
},
"required": [
"identifier",
"people_per_area",
"occupancy_schedule",
"activity_schedule"
],
"additionalProperties": false
},
"Lighting": {
"title": "Lighting",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Lighting per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "Lighting",
"pattern": "^Lighting$",
"type": "string",
"readOnly": true
},
"visible_fraction": {
"title": "Visible Fraction",
"description": "The fraction of heat from lights that goes into the zone as visible (short-wave) radiation. The default value is `0.25`.",
"default": 0.25,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "The fraction of heat from lights that is long-wave radiation. Default value is `0.32`.",
"default": 0.32,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"return_air_fraction": {
"title": "Return Air Fraction",
"description": "The fraction of the heat from lights that goes into the zone return air. Default value is `0`.",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"ElectricEquipment": {
"title": "ElectricEquipment",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"lost_fraction": {
"title": "Lost Fraction",
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"type": {
"title": "Type",
"default": "ElectricEquipment",
"pattern": "^ElectricEquipment$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"GasEquipment": {
"title": "GasEquipment",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"watts_per_area": {
"title": "Watts Per Area",
"description": "Equipment level per floor area as [W/m2].",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"radiant_fraction": {
"title": "Radiant Fraction",
"description": "Number for the amount of long-wave radiation heat given off by electric equipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"latent_fraction": {
"title": "Latent Fraction",
"description": "Number for the amount of latent heat given off by electricequipment. Default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"lost_fraction": {
"title": "Lost Fraction",
"description": "Number for the amount of \u201clost\u201d heat being given off by equipment. The default value is 0.",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"type": {
"title": "Type",
"default": "GasEquipment",
"pattern": "^GasEquipment$",
"type": "string",
"readOnly": true
}
},
"required": [
"identifier",
"watts_per_area",
"schedule"
],
"additionalProperties": false
},
"Infiltration": {
"title": "Infiltration",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"flow_per_exterior_area": {
"title": "Flow Per Exterior Area",
"description": "Number for the infiltration per exterior surface area in m3/s-m2.",
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "Infiltration",
"pattern": "^Infiltration$",
"type": "string",
"readOnly": true
},
"constant_coefficient": {
"title": "Constant Coefficient",
"default": 1,
"minimum": 0,
"type": "number",
"format": "double"
},
"temperature_coefficient": {
"title": "Temperature Coefficient",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"velocity_coefficient": {
"title": "Velocity Coefficient",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"flow_per_exterior_area",
"schedule"
],
"additionalProperties": false
},
"Ventilation": {
"title": "Ventilation",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "Ventilation",
"pattern": "^Ventilation$",
"type": "string",
"readOnly": true
},
"flow_per_person": {
"title": "Flow Per Person",
"description": "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.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"flow_per_area": {
"title": "Flow Per Area",
"description": "Intensity of ventilation in [m3/s per m2 of floor area].",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"air_changes_per_hour": {
"title": "Air Changes Per Hour",
"description": "Intensity of ventilation in air changes per hour (ACH) for the entire Room.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"flow_per_zone": {
"title": "Flow Per Zone",
"description": "Intensity of ventilation in m3/s for the entire Room.",
"default": 0,
"minimum": 0,
"type": "number",
"format": "double"
},
"schedule": {
"title": "Schedule",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Setpoint": {
"title": "Setpoint",
"description": "Used to specify information about the setpoint schedule.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"cooling_schedule": {
"title": "Cooling Schedule",
"description": "Schedule for the cooling setpoint. The values in this schedule should be temperature in [C].",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"heating_schedule": {
"title": "Heating Schedule",
"description": "Schedule for the heating setpoint. The values in this schedule should be temperature in [C].",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "Setpoint",
"pattern": "^Setpoint$",
"type": "string",
"readOnly": true
},
"humidifying_schedule": {
"title": "Humidifying Schedule",
"description": "Schedule for the humidification setpoint. The values in this schedule should be in [%].",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
},
"dehumidifying_schedule": {
"title": "Dehumidifying Schedule",
"description": "Schedule for the dehumidification setpoint. The values in this schedule should be in [%].",
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
}
},
"required": [
"identifier",
"cooling_schedule",
"heating_schedule"
],
"additionalProperties": false
},
"ProgramType": {
"title": "ProgramType",
"description": "Base class for all objects requiring a valid EnergyPlus identifier.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ProgramType",
"pattern": "^ProgramType$",
"type": "string",
"readOnly": true
},
"people": {
"title": "People",
"description": "People to describe the occupancy of the program. If None, no occupancy will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/People"
}
]
},
"lighting": {
"title": "Lighting",
"description": "Lighting to describe the lighting usage of the program. If None, no lighting will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/Lighting"
}
]
},
"electric_equipment": {
"title": "Electric Equipment",
"description": "ElectricEquipment to describe the usage of electric equipment within the program. If None, no electric equipment will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/ElectricEquipment"
}
]
},
"gas_equipment": {
"title": "Gas Equipment",
"description": "GasEquipment to describe the usage of gas equipment within the program. If None, no gas equipment will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/GasEquipment"
}
]
},
"infiltration": {
"title": "Infiltration",
"description": "Infiltration to describe the outdoor air leakage of the program. If None, no infiltration will be assumed for the program.",
"allOf": [
{
"$ref": "#/components/schemas/Infiltration"
}
]
},
"ventilation": {
"title": "Ventilation",
"description": "Ventilation to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement will be assumed.",
"allOf": [
{
"$ref": "#/components/schemas/Ventilation"
}
]
},
"setpoint": {
"title": "Setpoint",
"description": "Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.",
"allOf": [
{
"$ref": "#/components/schemas/Setpoint"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ScheduleRulesetAbridged": {
"title": "ScheduleRulesetAbridged",
"description": "Used to define a schedule for a default day, further described by ScheduleRule.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"day_schedules": {
"title": "Day Schedules",
"description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleDay"
}
},
"default_day_schedule": {
"title": "Default Day Schedule",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleRulesetAbridged",
"pattern": "^ScheduleRulesetAbridged$",
"type": "string",
"readOnly": true
},
"schedule_rules": {
"title": "Schedule Rules",
"description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleRuleAbridged"
}
},
"holiday_schedule": {
"title": "Holiday Schedule",
"description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"summer_designday_schedule": {
"title": "Summer Designday Schedule",
"description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"winter_designday_schedule": {
"title": "Winter Designday Schedule",
"description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"schedule_type_limit": {
"title": "Schedule Type Limit",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
}
},
"required": [
"identifier",
"day_schedules",
"default_day_schedule"
],
"additionalProperties": false
},
"ScheduleFixedIntervalAbridged": {
"title": "ScheduleFixedIntervalAbridged",
"description": "Used to specify a start date and a list of values for a period of analysis.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"values": {
"title": "Values",
"description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
"minItems": 24,
"maxItems": 527040,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ScheduleFixedIntervalAbridged",
"pattern": "^ScheduleFixedIntervalAbridged$",
"type": "string",
"readOnly": true
},
"schedule_type_limit": {
"title": "Schedule Type Limit",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"timestep": {
"title": "Timestep",
"description": "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.",
"default": 1,
"type": "integer",
"format": "int32"
},
"start_date": {
"title": "Start Date",
"description": "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).",
"default": [
1,
1
],
"minItems": 2,
"maxItems": 3,
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"placeholder_value": {
"title": "Placeholder Value",
"description": " 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.",
"default": 0,
"type": "number",
"format": "double"
},
"interpolate": {
"title": "Interpolate",
"description": "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.",
"default": false,
"type": "boolean"
}
},
"required": [
"identifier",
"values"
],
"additionalProperties": false
},
"ModelEnergyProperties": {
"title": "ModelEnergyProperties",
"description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ModelEnergyProperties",
"pattern": "^ModelEnergyProperties$",
"type": "string",
"readOnly": true
},
"construction_sets": {
"title": "Construction Sets",
"description": "List of all unique ConstructionSets in the Model.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ConstructionSetAbridged"
},
{
"$ref": "#/components/schemas/ConstructionSet"
}
]
}
},
"constructions": {
"title": "Constructions",
"description": "A list of all unique constructions in the model. This includes constructions across all Faces, Apertures, Doors, Shades, Room ConstructionSets, and the global_construction_set.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/OpaqueConstructionAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionAbridged"
},
{
"$ref": "#/components/schemas/WindowConstructionShadeAbridged"
},
{
"$ref": "#/components/schemas/AirBoundaryConstructionAbridged"
},
{
"$ref": "#/components/schemas/OpaqueConstruction"
},
{
"$ref": "#/components/schemas/WindowConstruction"
},
{
"$ref": "#/components/schemas/WindowConstructionShade"
},
{
"$ref": "#/components/schemas/AirBoundaryConstruction"
},
{
"$ref": "#/components/schemas/ShadeConstruction"
}
]
}
},
"materials": {
"title": "Materials",
"description": "A list of all unique materials in the model. This includes materials needed to make the Model constructions.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EnergyMaterial"
},
{
"$ref": "#/components/schemas/EnergyMaterialNoMass"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGas"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialBlind"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
},
{
"$ref": "#/components/schemas/EnergyWindowMaterialShade"
}
]
}
},
"hvacs": {
"title": "Hvacs",
"description": "List of all unique HVAC systems in the Model.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/IdealAirSystemAbridged"
},
{
"$ref": "#/components/schemas/VAV"
},
{
"$ref": "#/components/schemas/PVAV"
},
{
"$ref": "#/components/schemas/PSZ"
},
{
"$ref": "#/components/schemas/PTAC"
},
{
"$ref": "#/components/schemas/ForcedAirFurnace"
},
{
"$ref": "#/components/schemas/FCUwithDOAS"
},
{
"$ref": "#/components/schemas/WSHPwithDOAS"
},
{
"$ref": "#/components/schemas/VRFwithDOAS"
},
{
"$ref": "#/components/schemas/FCU"
},
{
"$ref": "#/components/schemas/WSHP"
},
{
"$ref": "#/components/schemas/VRF"
},
{
"$ref": "#/components/schemas/Baseboard"
},
{
"$ref": "#/components/schemas/EvaporativeCooler"
},
{
"$ref": "#/components/schemas/Residential"
},
{
"$ref": "#/components/schemas/WindowAC"
},
{
"$ref": "#/components/schemas/GasUnitHeater"
}
]
}
},
"program_types": {
"title": "Program Types",
"description": "List of all unique ProgramTypes in the Model.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ProgramTypeAbridged"
},
{
"$ref": "#/components/schemas/ProgramType"
}
]
}
},
"schedules": {
"title": "Schedules",
"description": "A list of all unique schedules in the model. This includes schedules across all HVAC systems, ProgramTypes, Rooms, and Shades.",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ScheduleRulesetAbridged"
},
{
"$ref": "#/components/schemas/ScheduleFixedIntervalAbridged"
},
{
"$ref": "#/components/schemas/ScheduleRuleset"
},
{
"$ref": "#/components/schemas/ScheduleFixedInterval"
}
]
}
},
"schedule_type_limits": {
"title": "Schedule Type Limits",
"description": "A list of all unique ScheduleTypeLimits in the model. This all ScheduleTypeLimits needed to make the Model schedules.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleTypeLimit"
}
}
},
"additionalProperties": false
},
"Void": {
"title": "Void",
"description": "Void modifier",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "void",
"pattern": "^void$",
"type": "string",
"readOnly": true
}
}
},
"Mirror": {
"title": "Mirror",
"description": "Radiance mirror material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "mirror",
"pattern": "^mirror$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_reflectance": {
"title": "R Reflectance",
"description": "A value between 0 and 1 for the red channel reflectance (default: 1).",
"default": 1,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_reflectance": {
"title": "G Reflectance",
"description": "A value between 0 and 1 for the green channel reflectance (default: 1).",
"default": 1,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_reflectance": {
"title": "B Reflectance",
"description": "A value between 0 and 1 for the blue channel reflectance (default: 1).",
"default": 1,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"alternate_material": {
"title": "Alternate Material",
"description": "An optional material that may be used like the illum type 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 (default: None).",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Metal": {
"title": "Metal",
"description": "Radiance metal material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "metal",
"pattern": "^metal$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_reflectance": {
"title": "R Reflectance",
"description": "A value between 0 and 1 for the red channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_reflectance": {
"title": "G Reflectance",
"description": "A value between 0 and 1 for the green channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_reflectance": {
"title": "B Reflectance",
"description": "A value between 0 and 1 for the blue channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"specularity": {
"title": "Specularity",
"description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions lower than 0.9 are not realistic for metallic materials. (default: 0.9).",
"default": 0.9,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"roughness": {
"title": "Roughness",
"description": "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 (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Trans": {
"title": "Trans",
"description": "Radiance Translucent material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "trans",
"pattern": "^trans$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_reflectance": {
"title": "R Reflectance",
"description": "A value between 0 and 1 for the red channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_reflectance": {
"title": "G Reflectance",
"description": "A value between 0 and 1 for the green channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_reflectance": {
"title": "B Reflectance",
"description": "A value between 0 and 1 for the blue channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"specularity": {
"title": "Specularity",
"description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"roughness": {
"title": "Roughness",
"description": "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 (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"transmitted_diff": {
"title": "Transmitted Diff",
"description": "The fraction of transmitted light that is transmitted diffusely in a scattering fashion (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"transmitted_spec": {
"title": "Transmitted Spec",
"description": "The fraction of transmitted light that is not diffusely scattered (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Light": {
"title": "Light",
"description": "Radiance Light material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "light",
"pattern": "^light$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_emittance": {
"title": "R Emittance",
"description": "A value between 0 and 1 for the red channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_emittance": {
"title": "G Emittance",
"description": "A value between 0 and 1 for the green channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_emittance": {
"title": "B Emittance",
"description": "A value between 0 and 1 for the blue channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Glow": {
"title": "Glow",
"description": "Radiance Glow material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "glow",
"pattern": "^glow$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_emittance": {
"title": "R Emittance",
"description": "A value between 0 and 1 for the red channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_emittance": {
"title": "G Emittance",
"description": "A value between 0 and 1 for the green channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_emittance": {
"title": "B Emittance",
"description": "A value between 0 and 1 for the blue channel of the modifier (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"max_radius": {
"title": "Max Radius",
"description": "Maximum radius for shadow testing (default: 0). Surfaces with zero will never be tested for zero, although it may participate in interreflection calculation. Negative values will never contribute to scene illumination.",
"default": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"BSDF": {
"title": "BSDF",
"description": "Radiance BSDF (Bidirectional Scattering Distribution Function) material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"bsdf_data": {
"title": "Bsdf Data",
"description": "A string with the contents of the BSDF XML file.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "BSDF",
"pattern": "^BSDF$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"up_orientation": {
"title": "Up Orientation",
"description": "Vector as sequence that sets the hemisphere that the BSDF material faces. (default: (0.01, 0.01, 1.00).",
"default": [
0.01,
0.01,
1.0
],
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"thickness": {
"title": "Thickness",
"description": "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)(default: 0).",
"default": 0,
"type": "number",
"format": "double"
},
"function_file": {
"title": "Function File",
"description": "Optional input for function file (default: \".\").",
"default": ".",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"transform": {
"title": "Transform",
"description": "Optional transform input to scale the thickness and reorient the up vector (default: None).",
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"front_diffuse_reflectance": {
"title": "Front Diffuse Reflectance",
"description": "Optional additional front diffuse reflectance as sequence of numbers (default: None).",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"back_diffuse_reflectance": {
"title": "Back Diffuse Reflectance",
"description": "Optional additional back diffuse reflectance as sequence of numbers (default: None).",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
},
"diffuse_transmittance": {
"title": "Diffuse Transmittance",
"description": "Optional additional diffuse transmittance as sequence of numbers (default: None).",
"minItems": 3,
"maxItems": 3,
"type": "array",
"items": {
"type": "number",
"format": "double"
}
}
},
"required": [
"identifier",
"bsdf_data"
],
"additionalProperties": false
},
"Glass": {
"title": "Glass",
"description": "Radiance glass material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "glass",
"pattern": "^glass$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_transmissivity": {
"title": "R Transmissivity",
"description": "A value between 0 and 1 for the red channel transmissivity (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_transmissivity": {
"title": "G Transmissivity",
"description": "A value between 0 and 1 for the green channel transmissivity (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_transmissivity": {
"title": "B Transmissivity",
"description": "A value between 0 and 1 for the blue channel transmissivity (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"refraction_index": {
"title": "Refraction Index",
"description": "A value between 0 and 1 for the index of refraction (default: 1.52).",
"default": 1.52,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"Plastic": {
"title": "Plastic",
"description": "Radiance plastic material.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "plastic",
"pattern": "^plastic$",
"type": "string",
"readOnly": true
},
"modifier": {
"title": "Modifier",
"description": "Material modifier (default: Void).",
"default": {
"type": "void"
},
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"dependencies": {
"title": "Dependencies",
"description": "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 (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"r_reflectance": {
"title": "R Reflectance",
"description": "A value between 0 and 1 for the red channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"g_reflectance": {
"title": "G Reflectance",
"description": "A value between 0 and 1 for the green channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"b_reflectance": {
"title": "B Reflectance",
"description": "A value between 0 and 1 for the blue channel reflectance (default: 0).",
"default": 0.0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"specularity": {
"title": "Specularity",
"description": "A value between 0 and 1 for the fraction of specularity. Specularity fractions greater than 0.1 are not realistic for non-metallic materials. (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
},
"roughness": {
"title": "Roughness",
"description": "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 (default: 0).",
"default": 0,
"minimum": 0,
"maximum": 1,
"type": "number",
"format": "double"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WallModifierSet": {
"title": "WallModifierSet",
"description": "Set containing radiance modifiers needed for a model's Walls.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": {
"title": "Type",
"default": "WallModifierSet",
"pattern": "^WallModifierSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"FloorModifierSet": {
"title": "FloorModifierSet",
"description": "Set containing radiance modifiers needed for a model's Floors.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": {
"title": "Type",
"default": "FloorModifierSet",
"pattern": "^FloorModifierSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"RoofCeilingModifierSet": {
"title": "RoofCeilingModifierSet",
"description": "Set containing radiance modifiers needed for a model's roofs.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": {
"title": "Type",
"default": "RoofCeilingModifierSet",
"pattern": "^RoofCeilingModifierSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ApertureModifierSet": {
"title": "ApertureModifierSet",
"description": "Set containing radiance modifiers needed for a model's Apertures.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ApertureModifierSet",
"pattern": "^ApertureModifierSet$",
"type": "string",
"readOnly": true
},
"window_modifier": {
"title": "Window Modifier",
"description": "A modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A modifier object for apertures with a Surface boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"skylight_modifier": {
"title": "Skylight Modifier",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"operable_modifier": {
"title": "Operable Modifier",
"description": "A modifier object for apertures with an Outdoors boundary condition and a True is_operable property.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"additionalProperties": false
},
"DoorModifierSet": {
"title": "DoorModifierSet",
"description": "Set containing radiance modifiers needed for a model's Doors.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": {
"title": "Type",
"default": "DoorModifierSet",
"pattern": "^DoorModifierSet$",
"type": "string",
"readOnly": true
},
"interior_glass_modifier": {
"title": "Interior Glass Modifier",
"description": "A modifier object for glass with a Surface boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"exterior_glass_modifier": {
"title": "Exterior Glass Modifier",
"description": "A modifier object for glass with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"overhead_modifier": {
"title": "Overhead Modifier",
"description": "A window modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"additionalProperties": false
},
"ShadeModifierSet": {
"title": "ShadeModifierSet",
"description": "Set containing radiance modifiers needed for a model's Shade.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "A radiance modifier object for faces with an Outdoors boundary condition.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "A radiance modifier object for faces with a boundary condition other than Outdoors.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
},
"type": {
"title": "Type",
"default": "ShadeModifierSet",
"pattern": "^ShadeModifierSet$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ModifierSet": {
"title": "ModifierSet",
"description": "Set containing all radiance modifiers needed to create a radiance model.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ModifierSet",
"pattern": "^ModifierSet$",
"type": "string",
"readOnly": true
},
"wall_set": {
"title": "Wall Set",
"description": "An optional WallModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/WallModifierSet"
}
]
},
"floor_set": {
"title": "Floor Set",
"description": "An optional FloorModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/FloorModifierSet"
}
]
},
"roof_ceiling_set": {
"title": "Roof Ceiling Set",
"description": "An optional RoofCeilingModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/RoofCeilingModifierSet"
}
]
},
"aperture_set": {
"title": "Aperture Set",
"description": "An optional ApertureModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/ApertureModifierSet"
}
]
},
"door_set": {
"title": "Door Set",
"description": "An optional DoorModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/DoorModifierSet"
}
]
},
"shade_set": {
"title": "Shade Set",
"description": "An optional ShadeModifierSet object for this ModifierSet. (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/ShadeModifierSet"
}
]
},
"air_boundary_modifier": {
"title": "Air Boundary Modifier",
"description": "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.",
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"WallModifierSetAbridged": {
"title": "WallModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Walls.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"type": "string"
},
"type": {
"title": "Type",
"default": "WallModifierSetAbridged",
"pattern": "^WallModifierSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"FloorModifierSetAbridged": {
"title": "FloorModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Floors.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"type": "string"
},
"type": {
"title": "Type",
"default": "FloorModifierSetAbridged",
"pattern": "^FloorModifierSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"RoofCeilingModifierSetAbridged": {
"title": "RoofCeilingModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Roofs.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"type": "string"
},
"type": {
"title": "Type",
"default": "RoofCeilingModifierSetAbridged",
"pattern": "^RoofCeilingModifierSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ApertureModifierSetAbridged": {
"title": "ApertureModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Apertures.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ApertureModifierSetAbridged",
"pattern": "^ApertureModifierSetAbridged$",
"type": "string",
"readOnly": true
},
"window_modifier": {
"title": "Window Modifier",
"description": "Identifier of modifier object for apertures with an Outdoors boundary condition, False is_operable property, and Wall parent Face.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier of modifier object for apertures with a Surface boundary condition.",
"type": "string"
},
"skylight_modifier": {
"title": "Skylight Modifier",
"description": "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.",
"type": "string"
},
"operable_modifier": {
"title": "Operable Modifier",
"description": "Identifier of modifier object for apertures with an Outdoors boundary condition and a True is_operable property.",
"type": "string"
}
},
"additionalProperties": false
},
"DoorModifierSetAbridged": {
"title": "DoorModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Doors.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"type": "string"
},
"type": {
"title": "Type",
"default": "DoorModifierSetAbridged",
"pattern": "^DoorModifierSetAbridged$",
"type": "string",
"readOnly": true
},
"interior_glass_modifier": {
"title": "Interior Glass Modifier",
"description": "Identifier of modifier object for glass with a Surface boundary condition.",
"type": "string"
},
"exterior_glass_modifier": {
"title": "Exterior Glass Modifier",
"description": "Identifier of modifier object for glass with an Outdoors boundary condition.",
"type": "string"
},
"overhead_modifier": {
"title": "Overhead Modifier",
"description": "Identifier of a modifier object for doors with an Outdoors boundary condition and a RoofCeiling or Floor face type for their parent face.",
"type": "string"
}
},
"additionalProperties": false
},
"ShadeModifierSetAbridged": {
"title": "ShadeModifierSetAbridged",
"description": "Abridged set containing radiance modifiers needed for a model's Shade.",
"type": "object",
"properties": {
"exterior_modifier": {
"title": "Exterior Modifier",
"description": "Identifier for a radiance modifier object for faces with an Outdoors boundary condition.",
"type": "string"
},
"interior_modifier": {
"title": "Interior Modifier",
"description": "Identifier for a radiance modifier object for faces with a boundary condition other than Outdoors.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ShadeModifierSetAbridged",
"pattern": "^ShadeModifierSetAbridged$",
"type": "string",
"readOnly": true
}
},
"additionalProperties": false
},
"ModifierSetAbridged": {
"title": "ModifierSetAbridged",
"description": "Abridged set containing all modifiers needed to create a radiance model.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"type": "string"
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"type": {
"title": "Type",
"default": "ModifierSetAbridged",
"pattern": "^ModifierSetAbridged$",
"type": "string",
"readOnly": true
},
"wall_set": {
"title": "Wall Set",
"description": "Optional WallModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/WallModifierSetAbridged"
}
]
},
"floor_set": {
"title": "Floor Set",
"description": "Optional FloorModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/FloorModifierSetAbridged"
}
]
},
"roof_ceiling_set": {
"title": "Roof Ceiling Set",
"description": "Optional RoofCeilingModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/RoofCeilingModifierSetAbridged"
}
]
},
"aperture_set": {
"title": "Aperture Set",
"description": "Optional ApertureModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/ApertureModifierSetAbridged"
}
]
},
"door_set": {
"title": "Door Set",
"description": "Optional DoorModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/DoorModifierSetAbridged"
}
]
},
"shade_set": {
"title": "Shade Set",
"description": "Optional ShadeModifierSet object for this ModifierSet (default: None).",
"allOf": [
{
"$ref": "#/components/schemas/ShadeModifierSetAbridged"
}
]
},
"air_boundary_modifier": {
"title": "Air Boundary Modifier",
"description": "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": "string"
}
},
"required": [
"identifier"
],
"additionalProperties": false
},
"ModelRadianceProperties": {
"title": "ModelRadianceProperties",
"description": "Radiance Properties for Honeybee Model.",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ModelRadianceProperties",
"pattern": "^ModelRadianceProperties$",
"type": "string",
"readOnly": true
},
"modifiers": {
"title": "Modifiers",
"description": "A list of all unique modifiers in the model. This includes modifiers across all Faces, Apertures, Doors, Shades, Room ModifierSets, and the global_modifier_set (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Plastic"
},
{
"$ref": "#/components/schemas/Glass"
},
{
"$ref": "#/components/schemas/BSDF"
},
{
"$ref": "#/components/schemas/Glow"
},
{
"$ref": "#/components/schemas/Light"
},
{
"$ref": "#/components/schemas/Trans"
},
{
"$ref": "#/components/schemas/Metal"
},
{
"$ref": "#/components/schemas/Void"
},
{
"$ref": "#/components/schemas/Mirror"
}
]
}
},
"modifier_sets": {
"title": "Modifier Sets",
"description": "A list of all unique Room-Assigned ModifierSets in the Model (default: None).",
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ModifierSet"
},
{
"$ref": "#/components/schemas/ModifierSetAbridged"
}
]
}
}
},
"additionalProperties": false
},
"ModelProperties": {
"title": "ModelProperties",
"type": "object",
"properties": {
"type": {
"title": "Type",
"default": "ModelProperties",
"pattern": "^ModelProperties$",
"type": "string",
"readOnly": true
},
"energy": {
"$ref": "#/components/schemas/ModelEnergyProperties"
},
"radiance": {
"$ref": "#/components/schemas/ModelRadianceProperties"
}
}
},
"Model": {
"title": "Model",
"description": "Base class for all objects requiring a identifiers acceptable for all engines.",
"type": "object",
"properties": {
"identifier": {
"title": "Identifier",
"description": "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.",
"maxLength": 100,
"minLength": 1,
"pattern": "[A-Za-z0-9_-]",
"type": "string"
},
"properties": {
"title": "Properties",
"description": "Extension properties for particular simulation engines (Radiance, EnergyPlus).",
"allOf": [
{
"$ref": "#/components/schemas/ModelProperties"
}
]
},
"display_name": {
"title": "Display Name",
"description": "Display name of the object with no character restrictions.",
"type": "string"
},
"user_data": {
"title": "User Data",
"description": "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": "object"
},
"type": {
"title": "Type",
"default": "Model",
"pattern": "^Model$",
"type": "string",
"readOnly": true
},
"version": {
"title": "Version",
"description": "Text string for the current version of the schema.",
"default": "1.36.0",
"pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
"type": "string"
},
"rooms": {
"title": "Rooms",
"description": "A list of Rooms in the model.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Room"
}
},
"orphaned_faces": {
"title": "Orphaned Faces",
"description": "A list of Faces in the model that lack a parent Room. Note that orphaned Faces are not acceptable for Models that are to be exported for energy simulation.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Face"
}
},
"orphaned_shades": {
"title": "Orphaned Shades",
"description": "A list of Shades in the model that lack a parent.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Shade"
}
},
"orphaned_apertures": {
"title": "Orphaned Apertures",
"description": "A list of Apertures in the model that lack a parent Face. Note that orphaned Apertures are not acceptable for Models that are to be exported for energy simulation.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Aperture"
}
},
"orphaned_doors": {
"title": "Orphaned Doors",
"description": "A list of Doors in the model that lack a parent Face. Note that orphaned Doors are not acceptable for Models that are to be exported for energy simulation.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Door"
}
},
"units": {
"title": "Units",
"description": "Text indicating the units in which the model geometry exists. This is used to scale the geometry to the correct units for simulation engines like EnergyPlus, which requires all geometry be in meters.",
"default": "Meters",
"allOf": [
{
"$ref": "#/components/schemas/Units"
}
]
},
"tolerance": {
"title": "Tolerance",
"description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.",
"default": 0.01,
"minimum": 0,
"type": "number",
"format": "double"
},
"angle_tolerance": {
"title": "Angle Tolerance",
"description": "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, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a given Model.",
"default": 1.0,
"minimum": 0,
"type": "number",
"format": "double"
}
},
"required": [
"identifier",
"properties"
],
"additionalProperties": false
}
}
}
}