dragonfly_uwg.properties.building module

Building UWG Properties.

class dragonfly_uwg.properties.building.BuildingUWGProperties(host, program='LargeOffice', vintage='New', fract_heat_to_canyon=0.5, shgc=Autocalculate, wall_albedo=Autocalculate, roof_albedo=Autocalculate, roof_veg_fraction=0)[source]

Bases: object

UWG Properties for Dragonfly Building.

Parameters:

  • host – A dragonfly_core Building object that hosts these properties.

  • program –

    Text for the name of the building program. Must be one of the options below. (Default: LargeOffice).

    • LargeOffice

    • MediumOffice

    • SmallOffice

    • MidriseApartment

    • Retail

    • StripMall

    • PrimarySchool

    • SecondarySchool

    • SmallHotel

    • LargeHotel

    • Hospital

    • Outpatient

    • Warehouse

    • SuperMarket

    • FullServiceRestaurant

    • QuickServiceRestaurant

  • vintage –

    Text for the vintage of the building. This will be used to set default constructions. Must be one of the options below. (Default: New).

    • New

    • 1980_Present

    • Pre1980

  • fract_heat_to_canyon – A number from 0 to 1 that represents the fraction of the building’s waste heat from air conditioning that gets rejected into the urban canyon. (Default: 0.5).

  • shgc – A number from 0 to 1 that represents the SHGC of the building’s windows. Used to evaluate the amount of solar heat reflected into the street canyon. If autocalculate, it will be set by the building vintage and the Model climate zone. (Default: autocalculate).

  • wall_albedo – A number from 0 to 1 that represents the exterior wall albedo of the building. If autocalculate, it will be set by the building program and the DoE commercial reference buildings. (Default: autocalculate).

  • roof_albedo – A number from 0 to 1 that represents the exterior roof albedo of the building. If autocalculate, it will be set by the vintage, meaning 0.7 for New and 0.2 for 1980_Present and Pre1980. (Default: autocalculate).

  • roof_veg_fraction – A number from 0 to 1 that represents the roof vegetation fraction of the building. (Default: 0).

Properties:

  • host

  • program

  • vintage

  • fract_heat_to_canyon

  • shgc

  • wall_albedo

  • roof_albedo

  • roof_veg_fraction

ToString()[source]
apply_properties_from_dict(abridged_data)[source]

Apply properties from a BuildingUWGPropertiesAbridged dictionary.

Parameters:

abridged_data – A BuildingUWGPropertiesAbridged dictionary (typically coming from a Model).

default_shgc(climate_zone)[source]

Get the default DoE Reference Building SHGC for this building.

This is used whenever the building’s shgc property is autocalculate.

Parameters:

climate_zone – Text for the ASHRAE climate zone, which must include the humidity letter (eg. “4A”) unless it is climate zone 7 or 8.

duplicate(new_host=None)[source]

Get a copy of this object.

new_host: A new Building object that hosts these properties.

If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]

Create BuildingUWGProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters:

  • data – A dictionary representation of BuildingUWGProperties.

  • host – A Building object that hosts these properties.

infer_program_from_energy_program()[source]

Attempt to infer the UWG building program from the honeybee-energy program.

The inferring will happen by first finding the most common energy ProgramType among the assigned Room2Ds. If the identifier of this most common program contains the name of an acceptable UWG building program, it will be assigned as this object’s building program. If no match is found or there’s no honeybee-energy extension installed, this object’s program will remain unchanged.

to_dict(abridged=False)[source]

Return Building UWG properties as a dictionary.

Parameters:

abridged – Boolean for whether the full dictionary of the Building should be written (False) or just the identifier of the the individual properties (True). Default: False.

PROGRAMS = ('LargeOffice', 'MediumOffice', 'SmallOffice', 'MidriseApartment', 'Retail', 'StripMall', 'PrimarySchool', 'SecondarySchool', 'SmallHotel', 'LargeHotel', 'Hospital', 'Outpatient', 'Warehouse', 'SuperMarket', 'FullServiceRestaurant', 'QuickServiceRestaurant')
VINTAGES = ('New', '1980_Present', 'Pre1980')
property fract_heat_to_canyon

Get or set the fraction of the bldg heat rejected to the urban canyon.

property host

Get the Building object hosting these properties.

property program

Get or set text for the name of the building program.

property program_uwg

Get text for the building program in a format that the UWG likes.

property roof_albedo

Get or set the exterior roof albedo of the building.

property roof_veg_fraction

Get or set the roof vegetation fraction of the building.

property shgc

Get or set the SHGC of the building.

property vintage

Get or set text for the vintage of the building.

property vintage_uwg

Get text for the building vintage in a format that the UWG likes.

property wall_albedo

Get or set the exterior wall albedo of the building.