m_osman/city_retrofit
1
0
Fork 0
forked from s_ranjbar/city_retrofit
Code Pull Requests Activity

Add code comment to the classes

Browse Source
This commit is contained in:
Guille Gutierrez 2020-06-10 13:08:51 -04:00
parent e0224c229c
commit de16e01677
9 changed files with 603 additions and 582 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
city_model_structure/plying_with_geometry.py
View File

@ -1,22 +0,0 @@
import trimesh
from helpers.geometry import Geometry as Geo
import stl
import numpy as np
# example triangle
vertices = [[0, 0, 0], [0, 0, 1], [0, 1, 0], [0, 1, 1], [1, 0, 0], [1, 0, 1], [1, 1, 0], [1, 1, 1]]
#faces = [[0, 1, 2], [1, 3, 2], [1, 5, 3], [5, 7, 3], [0, 4, 1], [4, 5, 1], [4, 6, 5], [5, 6, 7], [0, 2, 4], [2, 6, 4],
# [3, 7, 6], [2, 3, 6]]
# example rectangle
faces = [[0, 1, 3, 2], [1, 5, 7, 3], [0, 4, 5, 1], [4, 6, 7, 5], [0, 2, 6, 4], [3, 7, 6, 2]]
mesh = trimesh.Trimesh(vertices=vertices, faces=faces)
normal_plane = [0, 0, 1]
point_plane = [0, 0, 2]
mesh_result = Geo.divide_mesh_by_plane(mesh, normal_plane, point_plane)
for mesh in mesh_result:
print(len(mesh.vertices), len(mesh.faces))

30
city_model_structure/polyhedron.py
View File

@ -9,8 +9,11 @@ from helpers.geometry import Geometry
class Polyhedron: class Polyhedron:
"""
Polyhedron class
"""
def __init__(self, surfaces): def __init__(self, surfaces):
self._surfaces = [s for s in surfaces] self._surfaces = list(surfaces)
self._polygons = [s.polygon for s in surfaces] self._polygons = [s.polygon for s in surfaces]
self._polyhedron = None self._polyhedron = None
self._volume = None self._volume = None
@ -27,7 +30,11 @@ class Polyhedron:
return -1 return -1
@property @property
def vertices(self): def vertices(self) -> np.ndarray:
"""
Polyhedron vertices
:return: np.ndarray(int)
"""
if self._vertices is None: if self._vertices is None:
vertices, self._vertices = [], [] vertices, self._vertices = [], []
[vertices.extend(s.points) for s in self._surfaces] [vertices.extend(s.points) for s in self._surfaces]
@ -44,7 +51,11 @@ class Polyhedron:
return self._vertices return self._vertices
@property @property
def faces(self): def faces(self) -> np.ndarray:
"""
Polyhedron faces
:return: np.ndarray([int])
"""
if self._faces is None: if self._faces is None:
self._faces = [] self._faces = []
for s in self._surfaces: for s in self._surfaces:
@ -67,13 +78,26 @@ class Polyhedron:
@property @property
def volume(self): def volume(self):
"""
Polyhedron volume in cubic meters
:return: float
"""
if self._volume is None: if self._volume is None:
self._volume, cog, inertia = self._polyhedron_mesh.get_mass_properties() self._volume, cog, inertia = self._polyhedron_mesh.get_mass_properties()
return self._volume return self._volume
@property @property
def max_z(self): def max_z(self):
"""
Polyhedron maximal z value
:return: float
"""
return self._polyhedron_mesh.z.max() return self._polyhedron_mesh.z.max()
def save(self, full_path): def save(self, full_path):
"""
Export the polyhedron to stl given file
:param full_path: str
:return: None
"""
self._polyhedron_mesh.save(full_path) self._polyhedron_mesh.save(full_path)

92
city_model_structure/thermal_zone.py
View File

@ -3,13 +3,18 @@ ThermalZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
""" """
from __future__ import annotations from typing import List, TypeVar
from typing import List
from city_model_structure.usage_zone import UsageZone from city_model_structure.usage_zone import UsageZone
from city_model_structure.surface import Surface
from helpers.configuration import Configuration from helpers.configuration import Configuration
ThermalBoundary = TypeVar('ThermalBoundary')
class ThermalZone: class ThermalZone:
"""
ThermalZone class
"""
def __init__(self, surfaces): def __init__(self, surfaces):
self._surfaces = surfaces self._surfaces = surfaces
self._floor_area = None self._floor_area = None
@ -25,14 +30,26 @@ class ThermalZone:
@property @property
def heated(self): def heated(self):
"""
Get thermal zone heated flag
:return: Boolean
"""
return self._heated return self._heated
@property @property
def cooled(self): def cooled(self):
"""
Get thermal zone cooled flag
:return: Boolean
"""
return self._cooled return self._cooled
@property @property
def floor_area(self): def floor_area(self):
"""
Get thermal zone floor area in m2
:return: float
"""
if self._floor_area is None: if self._floor_area is None:
self._floor_area = 0 self._floor_area = 0
for s in self._surfaces: for s in self._surfaces:
@ -41,61 +58,128 @@ class ThermalZone:
return self._floor_area return self._floor_area
@property @property
def bounded(self) -> List['ThermalBoundary']: def bounded(self) -> List[ThermalBoundary]:
"""
Get thermal boundaries bounding with the thermal zone
:return: [ThermalBoundary]
"""
return self._bounded return self._bounded
@bounded.setter @bounded.setter
def bounded(self, value): def bounded(self, value):
"""
Set thermal boundaries bounding with the thermal zone
:param value: [ThermalBoundary]
:return: None
"""
self._bounded = value self._bounded = value
@property @property
def surfaces(self): def surfaces(self) -> List[Surface]:
"""
Get thermal zone surfaces
:return: [Surface]
"""
return self._surfaces return self._surfaces
@property @property
def additional_thermal_bridge_u_value(self): def additional_thermal_bridge_u_value(self):
"""
Get thermal zone additional thermal bridge u value
:return: float
"""
return self._additional_thermal_bridge_u_value return self._additional_thermal_bridge_u_value
@additional_thermal_bridge_u_value.setter @additional_thermal_bridge_u_value.setter
def additional_thermal_bridge_u_value(self, value): def additional_thermal_bridge_u_value(self, value):
"""
Set thermal zone additional thermal bridge u value
:param value: float
:return: None
"""
self._additional_thermal_bridge_u_value = value self._additional_thermal_bridge_u_value = value
@property @property
def effective_thermal_capacity(self): def effective_thermal_capacity(self):
"""
Get thermal zone effective thermal capacity
:return: float
"""
return self._effective_thermal_capacity return self._effective_thermal_capacity
@effective_thermal_capacity.setter @effective_thermal_capacity.setter
def effective_thermal_capacity(self, value): def effective_thermal_capacity(self, value):
"""
Set thermal zone effective thermal capacity
:param value: float
:return: None
"""
self._effective_thermal_capacity = value self._effective_thermal_capacity = value
@property @property
def indirectly_heated_area_ratio(self): def indirectly_heated_area_ratio(self):
"""
Get thermal zone indirectly heated area ratio
:return: float
"""
return self._indirectly_heated_area_ratio return self._indirectly_heated_area_ratio
@indirectly_heated_area_ratio.setter @indirectly_heated_area_ratio.setter
def indirectly_heated_area_ratio(self, value): def indirectly_heated_area_ratio(self, value):
"""
Set thermal zone indirectly heated area ratio
:param value: float
:return: None
"""
self._indirectly_heated_area_ratio = value self._indirectly_heated_area_ratio = value
@property @property
def infiltration_rate_system_on(self): def infiltration_rate_system_on(self):
"""
Get thermal zone infiltration rate system on in air changes per hour
:return: float
"""
return self._infiltration_rate_system_on return self._infiltration_rate_system_on
@infiltration_rate_system_on.setter @infiltration_rate_system_on.setter
def infiltration_rate_system_on(self, value): def infiltration_rate_system_on(self, value):
"""
Set thermal zone infiltration rate system on in air changes per hour
:param value: float
:return: None
"""
self._infiltration_rate_system_on = value self._infiltration_rate_system_on = value
@property @property
def infiltration_rate_system_off(self): def infiltration_rate_system_off(self):
"""
Get thermal zone infiltration rate system off in air changes per hour
:return: float
"""
return self._infiltration_rate_system_off return self._infiltration_rate_system_off
@infiltration_rate_system_off.setter @infiltration_rate_system_off.setter
def infiltration_rate_system_off(self, value): def infiltration_rate_system_off(self, value):
"""
Set thermal zone infiltration rate system on in air changes per hour
:param value: float
:return: None
"""
self._infiltration_rate_system_off = value self._infiltration_rate_system_off = value
@property @property
def usage_zones(self) -> List[UsageZone]: def usage_zones(self) -> List[UsageZone]:
"""
Get thermal zone usage zones
:return: [UsageZone]
"""
return self._usage_zones return self._usage_zones
@usage_zones.setter @usage_zones.setter
def usage_zones(self, values): def usage_zones(self, values):
"""
Set thermal zone usage zones
:param values: [UsageZone]
:return: None
"""
self._usage_zones = values self._usage_zones = values

83
city_model_structure/window.py
View File

@ -1,83 +0,0 @@
"""
Window module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
"""
class Window:
"""
Window class
"""
def __init__(self):
self._conductivity = None
self._solar_transmittance_at_normal_incidence = None
self._front_side_solar_reflectance_at_normal_incidence = None
self._back_side_solar_reflectance_at_normal_incidence = None
self._frame_ratio = None
self._thickness_m = None
self._shgc = None
@property
def conductivity(self):
"""
Get window conductivity in W/mK
:return: float
"""
return self._conductivity
@conductivity.setter
def conductivity(self, value):
self._conductivity = value
@property
def solar_transmittance_at_normal_incidence(self):
return self._solar_transmittance_at_normal_incidence
@solar_transmittance_at_normal_incidence.setter
def solar_transmittance_at_normal_incidence(self, value):
self._solar_transmittance_at_normal_incidence = value
@property
def front_side_solar_reflectance_at_normal_incidence(self):
return self._front_side_solar_reflectance_at_normal_incidence
@front_side_solar_reflectance_at_normal_incidence.setter
def front_side_solar_reflectance_at_normal_incidence(self, value):
self._front_side_solar_reflectance_at_normal_incidence = value
@property
def back_side_solar_reflectance_at_normal_incidence(self):
return self._back_side_solar_reflectance_at_normal_incidence
@back_side_solar_reflectance_at_normal_incidence.setter
def back_side_solar_reflectance_at_normal_incidence(self, value):
self._back_side_solar_reflectance_at_normal_incidence = value
@property
def frame_ratio(self):
return self._frame_ratio
@frame_ratio.setter
def frame_ratio(self, value):
self._frame_ratio = value
@frame_ratio.setter
def frame_ratio(self, value):
self._frame_ratio = value
@property
def thickness_m(self):
return self._thickness_m
@thickness_m.setter
def thickness_m(self, value):
self._thickness_m = value
@property
def shgc(self):
return self._shgc
@shgc.setter
def shgc(self, value):
self._shgc = value

4
config/configuration.ini
View File

@ -7,8 +7,8 @@ h_e = 25 # W/m2K
frame_ratio = 0 frame_ratio = 0
[thermal_zones] [thermal_zones]
heated = True heated = true
cooled = True cooled = true
additional_thermal_bridge_u_value = 0 additional_thermal_bridge_u_value = 0
indirectly_heated_area_ratio = 0 indirectly_heated_area_ratio = 0
infiltration_rate_system_on = 0 infiltration_rate_system_on = 0

2
helpers/configuration.py
View File

@ -10,7 +10,7 @@ from pathlib import Path
class Configuration: class Configuration:
def __init__(self): def __init__(self):
base_path = Path().resolve().parent base_path = Path().resolve().parent
config_file = Path(base_path / 'config/configuration.ini').resolve() config_file = Path(base_path / 'libs/config/configuration.ini').resolve()
self._config = configparser.ConfigParser() self._config = configparser.ConfigParser()
self._config.read(config_file) self._config.read(config_file)

449
physics/physics_feeders/helpers/us_pluto_to_function.py
View File

@ -7,228 +7,233 @@ Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@conc
class UsPlutoToFunction: class UsPlutoToFunction:
building_function = { building_function = {
'A0': 'single family house', 'A0': 'single family house',
'A1': 'single family house', 'A1': 'single family house',
'A2': 'single family house', 'A2': 'single family house',
'A3': 'single family house', 'A3': 'single family house',
'A4': 'single family house', 'A4': 'single family house',
'A5': 'single family house', 'A5': 'single family house',
'A6': 'single family house', 'A6': 'single family house',
'A7': 'single family house', 'A7': 'single family house',
'A8': 'single family house', 'A8': 'single family house',
'A9': 'single family house', 'A9': 'single family house',
'B1': 'multifamily house', 'B1': 'multifamily house',
'B2': 'multifamily house', 'B2': 'multifamily house',
'B3': 'multifamily house', 'B3': 'multifamily house',
'B9': 'multifamily house', 'B9': 'multifamily house',
'C0': 'residential', 'C0': 'residential',
'C1': 'residential', 'C1': 'residential',
'C2': 'residential', 'C2': 'residential',
'C3': 'residential', 'C3': 'residential',
'C4': 'residential', 'C4': 'residential',
'C5': 'residential', 'C5': 'residential',
'C6': 'residential', 'C6': 'residential',
'C7': 'residential', 'C7': 'residential',
'C8': 'residential', 'C8': 'residential',
'C9': 'residential', 'C9': 'residential',
'D0': 'residential', 'D0': 'residential',
'D1': 'residential', 'D1': 'residential',
'D2': 'residential', 'D2': 'residential',
'D3': 'residential', 'D3': 'residential',
'D4': 'residential', 'D4': 'residential',
'D5': 'residential', 'D5': 'residential',
'D6': 'residential', 'D6': 'residential',
'D7': 'residential', 'D7': 'residential',
'D8': 'residential', 'D8': 'residential',
'D9': 'residential', 'D9': 'residential',
'E1': 'warehouse', 'E1': 'warehouse',
'E3': 'warehouse', 'E3': 'warehouse',
'E4': 'warehouse', 'E4': 'warehouse',
'E5': 'warehouse', 'E5': 'warehouse',
'E7': 'warehouse', 'E7': 'warehouse',
'E9': 'warehouse', 'E9': 'warehouse',
'F1': 'warehouse', 'F1': 'warehouse',
'F2': 'warehouse', 'F2': 'warehouse',
'F4': 'warehouse', 'F4': 'warehouse',
'F5': 'warehouse', 'F5': 'warehouse',
'F8': 'warehouse', 'F8': 'warehouse',
'F9': 'warehouse', 'F9': 'warehouse',
'G0': 'office', 'G0': 'office',
'G1': 'office', 'G1': 'office',
'G2': 'office', 'G2': 'office',
'G3': 'office', 'G3': 'office',
'G4': 'office', 'G4': 'office',
'G5': 'office', 'G5': 'office',
'G6': 'office', 'G6': 'office',
'G7': 'office', 'G7': 'office',
'G8': 'office', 'G8': 'office',
'G9': 'office', 'G9': 'office',
'H1': 'hotel', 'H1': 'hotel',
'H2': 'hotel', 'H2': 'hotel',
'H3': 'hotel', 'H3': 'hotel',
'H4': 'hotel', 'H4': 'hotel',
'H5': 'hotel', 'H5': 'hotel',
'H6': 'hotel', 'H6': 'hotel',
'H7': 'hotel', 'H7': 'hotel',
'H8': 'hotel', 'H8': 'hotel',
'H9': 'hotel', 'H9': 'hotel',
'HB': 'hotel', 'HB': 'hotel',
'HH': 'hotel', 'HH': 'hotel',
'HR': 'hotel', 'HR': 'hotel',
'HS': 'hotel', 'HS': 'hotel',
'I1': 'hospital', 'I1': 'hospital',
'I2': 'outpatient', 'I2': 'outpatient',
'I3': 'outpatient', 'I3': 'outpatient',
'I4': 'residential', 'I4': 'residential',
'I5': 'outpatient', 'I5': 'outpatient',
'I6': 'outpatient', 'I6': 'outpatient',
'I7': 'outpatient', 'I7': 'outpatient',
'I9': 'outpatient', 'I9': 'outpatient',
'J1': 'large office', 'J1': 'large office',
'J2': 'large office', 'J2': 'large office',
'J3': 'large office', 'J3': 'large office',
'J4': 'large office', 'J4': 'large office',
'J5': 'large office', 'J5': 'large office',
'J6': 'large office', 'J6': 'large office',
'J7': 'large office', 'J7': 'large office',
'J8': 'large office', 'J8': 'large office',
'J9': 'large office', 'J9': 'large office',
'K1': 'strip mall', 'K1': 'strip mall',
'K2': 'strip mall', 'K2': 'strip mall',
'K3': 'strip mall', 'K3': 'strip mall',
'K4': 'residential', 'K4': 'residential',
'K5': 'restaurant', 'K5': 'restaurant',
'K6': 'commercial', 'K6': 'commercial',
'K7': 'commercial', 'K7': 'commercial',
'K8': 'commercial', 'K8': 'commercial',
'K9': 'commercial', 'K9': 'commercial',
'L1': 'residential', 'L1': 'residential',
'L2': 'residential', 'L2': 'residential',
'L3': 'residential', 'L3': 'residential',
'L8': 'residential', 'L8': 'residential',
'L9': 'residential', 'L9': 'residential',
'M1': 'large office', 'M1': 'large office',
'M2': 'large office', 'M2': 'large office',
'M3': 'large office', 'M3': 'large office',
'M4': 'large office', 'M4': 'large office',
'M9': 'large office', 'M9': 'large office',
'N1': 'residential', 'N1': 'residential',
'N2': 'residential', 'N2': 'residential',
'N3': 'residential', 'N3': 'residential',
'N4': 'residential', 'N4': 'residential',
'N9': 'residential', 'N9': 'residential',
'O1': 'office', 'O1': 'office',
'O2': 'office', 'O2': 'office',
'O3': 'office', 'O3': 'office',
'O4': 'office', 'O4': 'office',
'O5': 'office', 'O5': 'office',
'O6': 'office', 'O6': 'office',
'O7': 'office', 'O7': 'office',
'O8': 'office', 'O8': 'office',
'O9': 'office', 'O9': 'office',
'P1': 'large office', 'P1': 'large office',
'P2': 'hotel', 'P2': 'hotel',
'P3': 'office', 'P3': 'office',
'P4': 'office', 'P4': 'office',
'P5': 'office', 'P5': 'office',
'P6': 'office', 'P6': 'office',
'P7': 'large office', 'P7': 'large office',
'P8': 'large office', 'P8': 'large office',
'P9': 'office', 'P9': 'office',
'Q0': 'office', 'Q0': 'office',
'Q1': 'office', 'Q1': 'office',
'Q2': 'office', 'Q2': 'office',
'Q3': 'office', 'Q3': 'office',
'Q4': 'office', 'Q4': 'office',
'Q5': 'office', 'Q5': 'office',
'Q6': 'office', 'Q6': 'office',
'Q7': 'office', 'Q7': 'office',
'Q8': 'office', 'Q8': 'office',
'Q9': 'office', 'Q9': 'office',
'R0': 'residential', 'R0': 'residential',
'R1': 'residential', 'R1': 'residential',
'R2': 'residential', 'R2': 'residential',
'R3': 'residential', 'R3': 'residential',
'R4': 'residential', 'R4': 'residential',
'R5': 'residential', 'R5': 'residential',
'R6': 'residential', 'R6': 'residential',
'R7': 'residential', 'R7': 'residential',
'R8': 'residential', 'R8': 'residential',
'R9': 'residential', 'R9': 'residential',
'RA': 'residential', 'RA': 'residential',
'RB': 'residential', 'RB': 'residential',
'RC': 'residential', 'RC': 'residential',
'RD': 'residential', 'RD': 'residential',
'RG': 'residential', 'RG': 'residential',
'RH': 'residential', 'RH': 'residential',
'RI': 'residential', 'RI': 'residential',
'RK': 'residential', 'RK': 'residential',
'RM': 'residential', 'RM': 'residential',
'RR': 'residential', 'RR': 'residential',
'RS': 'residential', 'RS': 'residential',
'RW': 'residential', 'RW': 'residential',
'RX': 'residential', 'RX': 'residential',
'RZ': 'residential', 'RZ': 'residential',
'S0': 'residential', 'S0': 'residential',
'S1': 'residential', 'S1': 'residential',
'S2': 'residential', 'S2': 'residential',
'S3': 'residential', 'S3': 'residential',
'S4': 'residential', 'S4': 'residential',
'S5': 'residential', 'S5': 'residential',
'S9': 'residential', 'S9': 'residential',
'T1': 'na', 'T1': 'na',
'T2': 'na', 'T2': 'na',
'T9': 'na', 'T9': 'na',
'U0': 'warehouse', 'U0': 'warehouse',
'U1': 'warehouse', 'U1': 'warehouse',
'U2': 'warehouse', 'U2': 'warehouse',
'U3': 'warehouse', 'U3': 'warehouse',
'U4': 'warehouse', 'U4': 'warehouse',
'U5': 'warehouse', 'U5': 'warehouse',
'U6': 'warehouse', 'U6': 'warehouse',
'U7': 'warehouse', 'U7': 'warehouse',
'U8': 'warehouse', 'U8': 'warehouse',
'U9': 'warehouse', 'U9': 'warehouse',
'V0': 'na', 'V0': 'na',
'V1': 'na', 'V1': 'na',
'V2': 'na', 'V2': 'na',
'V3': 'na', 'V3': 'na',
'V4': 'na', 'V4': 'na',
'V5': 'na', 'V5': 'na',
'V6': 'na', 'V6': 'na',
'V7': 'na', 'V7': 'na',
'V8': 'na', 'V8': 'na',
'V9': 'na', 'V9': 'na',
'W1': 'primary school', 'W1': 'primary school',
'W2': 'primary school', 'W2': 'primary school',
'W3': 'secondary school', 'W3': 'secondary school',
'W4': 'secondary school', 'W4': 'secondary school',
'W5': 'secondary school', 'W5': 'secondary school',
'W6': 'secondary school', 'W6': 'secondary school',
'W7': 'secondary school', 'W7': 'secondary school',
'W8': 'primary school', 'W8': 'primary school',
'W9': 'secondary school', 'W9': 'secondary school',
'Y1': 'large office', 'Y1': 'large office',
'Y2': 'large office', 'Y2': 'large office',
'Y3': 'large office', 'Y3': 'large office',
'Y4': 'large office', 'Y4': 'large office',
'Y5': 'large office', 'Y5': 'large office',
'Y6': 'large office', 'Y6': 'large office',
'Y7': 'large office', 'Y7': 'large office',
'Y8': 'large office', 'Y8': 'large office',
'Y9': 'large office', 'Y9': 'large office',
'Z0': 'na', 'Z0': 'na',
'Z1': 'large office', 'Z1': 'large office',
'Z2': 'na', 'Z2': 'na',
'Z3': 'na', 'Z3': 'na',
'Z4': 'na', 'Z4': 'na',
'Z5': 'na', 'Z5': 'na',
'Z6': 'na', 'Z6': 'na',
'Z7': 'na', 'Z7': 'na',
'Z8': 'na', 'Z8': 'na',
'Z9': 'na' 'Z9': 'na'
} }
@staticmethod @staticmethod
def function(pluto): def function(building_pluto_function):
return UsPlutoToFunction.building_function[pluto] """
Get nrel function from the given pluto function
:param building_pluto_function: str
:return: str
"""
return UsPlutoToFunction.building_function[building_pluto_function]

48
usage/usage_feeders/helpers/us_function_to_usage.py
View File

@ -6,28 +6,34 @@ Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@conc
class UsFunctionToUsage: class UsFunctionToUsage:
building_usage = { """
'full service restaurant': 'restaurant', UsFunctionToUsage class
'highrise apartment': 'residential', """
'hospital': 'health care', _building_usage = {
'large hotel': 'hotel', 'full service restaurant': 'restaurant',
'large office': 'office and administration', 'highrise apartment': 'residential',
'medium office': 'office and administration', 'hospital': 'health care',
'midrise apartment': 'residential', 'large hotel': 'hotel',
'outpatient healthcare': 'health care', 'large office': 'office and administration',
'primary school': 'education', 'medium office': 'office and administration',
'quick service restaurant': 'restaurant', 'midrise apartment': 'residential',
'secondary school': 'education', 'outpatient healthcare': 'health care',
'small hotel': 'hotel', 'primary school': 'education',
'small office': 'office and administration', 'quick service restaurant': 'restaurant',
'stand alone retail': 'retail', 'secondary school': 'education',
'strip mall': 'hall', 'small hotel': 'hotel',
'supermarket': 'retail', 'small office': 'office and administration',
'warehouse': 'industry' 'stand alone retail': 'retail',
'strip mall': 'hall',
'supermarket': 'retail',
'warehouse': 'industry'
} }
@staticmethod @staticmethod
def usage(building_function): def usage(building_function):
return UsFunctionToUsage.building_usage[building_function] """
Get the usage for the given building function
:param building_function: str
:return: str
"""
return UsFunctionToUsage._building_usage[building_function]

455
usage/usage_feeders/helpers/us_pluto_to_usage.py
View File

@ -7,230 +7,237 @@ from usage.usage_feeders.helpers.us_function_to_usage import UsFunctionToUsage
class UsPlutoToUsage: class UsPlutoToUsage:
building_function = { """
'A0': 'single family house', UsPlutoToUsage class
'A1': 'single family house', """
'A2': 'single family house', _building_function = {
'A3': 'single family house', 'A0': 'single family house',
'A4': 'single family house', 'A1': 'single family house',
'A5': 'single family house', 'A2': 'single family house',
'A6': 'single family house', 'A3': 'single family house',
'A7': 'single family house', 'A4': 'single family house',
'A8': 'single family house', 'A5': 'single family house',
'A9': 'single family house', 'A6': 'single family house',
'B1': 'multifamily house', 'A7': 'single family house',
'B2': 'multifamily house', 'A8': 'single family house',
'B3': 'multifamily house', 'A9': 'single family house',
'B9': 'multifamily house', 'B1': 'multifamily house',
'C0': 'residential', 'B2': 'multifamily house',
'C1': 'residential', 'B3': 'multifamily house',
'C2': 'residential', 'B9': 'multifamily house',
'C3': 'residential', 'C0': 'residential',
'C4': 'residential', 'C1': 'residential',
'C5': 'residential', 'C2': 'residential',
'C6': 'residential', 'C3': 'residential',
'C7': 'residential', 'C4': 'residential',
'C8': 'residential', 'C5': 'residential',
'C9': 'residential', 'C6': 'residential',
'D0': 'residential', 'C7': 'residential',
'D1': 'residential', 'C8': 'residential',
'D2': 'residential', 'C9': 'residential',
'D3': 'residential', 'D0': 'residential',
'D4': 'residential', 'D1': 'residential',
'D5': 'residential', 'D2': 'residential',
'D6': 'residential', 'D3': 'residential',
'D7': 'residential', 'D4': 'residential',
'D8': 'residential', 'D5': 'residential',
'D9': 'residential', 'D6': 'residential',
'E1': 'warehouse', 'D7': 'residential',
'E3': 'warehouse', 'D8': 'residential',
'E4': 'warehouse', 'D9': 'residential',
'E5': 'warehouse', 'E1': 'warehouse',
'E7': 'warehouse', 'E3': 'warehouse',
'E9': 'warehouse', 'E4': 'warehouse',
'F1': 'warehouse', 'E5': 'warehouse',
'F2': 'warehouse', 'E7': 'warehouse',
'F4': 'warehouse', 'E9': 'warehouse',
'F5': 'warehouse', 'F1': 'warehouse',
'F8': 'warehouse', 'F2': 'warehouse',
'F9': 'warehouse', 'F4': 'warehouse',
'G0': 'office', 'F5': 'warehouse',
'G1': 'office', 'F8': 'warehouse',
'G2': 'office', 'F9': 'warehouse',
'G3': 'office', 'G0': 'office',
'G4': 'office', 'G1': 'office',
'G5': 'office', 'G2': 'office',
'G6': 'office', 'G3': 'office',
'G7': 'office', 'G4': 'office',
'G8': 'office', 'G5': 'office',
'G9': 'office', 'G6': 'office',
'H1': 'hotel', 'G7': 'office',
'H2': 'hotel', 'G8': 'office',
'H3': 'hotel', 'G9': 'office',
'H4': 'hotel', 'H1': 'hotel',
'H5': 'hotel', 'H2': 'hotel',
'H6': 'hotel', 'H3': 'hotel',
'H7': 'hotel', 'H4': 'hotel',
'H8': 'hotel', 'H5': 'hotel',
'H9': 'hotel', 'H6': 'hotel',
'HB': 'hotel', 'H7': 'hotel',
'HH': 'hotel', 'H8': 'hotel',
'HR': 'hotel', 'H9': 'hotel',
'HS': 'hotel', 'HB': 'hotel',
'I1': 'hospital', 'HH': 'hotel',
'I2': 'outpatient', 'HR': 'hotel',
'I3': 'outpatient', 'HS': 'hotel',
'I4': 'residential', 'I1': 'hospital',
'I5': 'outpatient', 'I2': 'outpatient',
'I6': 'outpatient', 'I3': 'outpatient',
'I7': 'outpatient', 'I4': 'residential',
'I9': 'outpatient', 'I5': 'outpatient',
'J1': 'large office', 'I6': 'outpatient',
'J2': 'large office', 'I7': 'outpatient',
'J3': 'large office', 'I9': 'outpatient',
'J4': 'large office', 'J1': 'large office',
'J5': 'large office', 'J2': 'large office',
'J6': 'large office', 'J3': 'large office',
'J7': 'large office', 'J4': 'large office',
'J8': 'large office', 'J5': 'large office',
'J9': 'large office', 'J6': 'large office',
'K1': 'strip mall', 'J7': 'large office',
'K2': 'strip mall', 'J8': 'large office',
'K3': 'strip mall', 'J9': 'large office',
'K4': 'residential', 'K1': 'strip mall',
'K5': 'restaurant', 'K2': 'strip mall',
'K6': 'commercial', 'K3': 'strip mall',
'K7': 'commercial', 'K4': 'residential',
'K8': 'commercial', 'K5': 'restaurant',
'K9': 'commercial', 'K6': 'commercial',
'L1': 'residential', 'K7': 'commercial',
'L2': 'residential', 'K8': 'commercial',
'L3': 'residential', 'K9': 'commercial',
'L8': 'residential', 'L1': 'residential',
'L9': 'residential', 'L2': 'residential',
'M1': 'large office', 'L3': 'residential',
'M2': 'large office', 'L8': 'residential',
'M3': 'large office', 'L9': 'residential',
'M4': 'large office', 'M1': 'large office',
'M9': 'large office', 'M2': 'large office',
'N1': 'residential', 'M3': 'large office',
'N2': 'residential', 'M4': 'large office',
'N3': 'residential', 'M9': 'large office',
'N4': 'residential', 'N1': 'residential',
'N9': 'residential', 'N2': 'residential',
'O1': 'office', 'N3': 'residential',
'O2': 'office', 'N4': 'residential',
'O3': 'office', 'N9': 'residential',
'O4': 'office', 'O1': 'office',
'O5': 'office', 'O2': 'office',
'O6': 'office', 'O3': 'office',
'O7': 'office', 'O4': 'office',
'O8': 'office', 'O5': 'office',
'O9': 'office', 'O6': 'office',
'P1': 'large office', 'O7': 'office',
'P2': 'hotel', 'O8': 'office',
'P3': 'office', 'O9': 'office',
'P4': 'office', 'P1': 'large office',
'P5': 'office', 'P2': 'hotel',
'P6': 'office', 'P3': 'office',
'P7': 'large office', 'P4': 'office',
'P8': 'large office', 'P5': 'office',
'P9': 'office', 'P6': 'office',
'Q0': 'office', 'P7': 'large office',
'Q1': 'office', 'P8': 'large office',
'Q2': 'office', 'P9': 'office',
'Q3': 'office', 'Q0': 'office',
'Q4': 'office', 'Q1': 'office',
'Q5': 'office', 'Q2': 'office',
'Q6': 'office', 'Q3': 'office',
'Q7': 'office', 'Q4': 'office',
'Q8': 'office', 'Q5': 'office',
'Q9': 'office', 'Q6': 'office',
'R0': 'residential', 'Q7': 'office',
'R1': 'residential', 'Q8': 'office',
'R2': 'residential', 'Q9': 'office',
'R3': 'residential', 'R0': 'residential',
'R4': 'residential', 'R1': 'residential',
'R5': 'residential', 'R2': 'residential',
'R6': 'residential', 'R3': 'residential',
'R7': 'residential', 'R4': 'residential',
'R8': 'residential', 'R5': 'residential',
'R9': 'residential', 'R6': 'residential',
'RA': 'residential', 'R7': 'residential',
'RB': 'residential', 'R8': 'residential',
'RC': 'residential', 'R9': 'residential',
'RD': 'residential', 'RA': 'residential',
'RG': 'residential', 'RB': 'residential',
'RH': 'residential', 'RC': 'residential',
'RI': 'residential', 'RD': 'residential',
'RK': 'residential', 'RG': 'residential',
'RM': 'residential', 'RH': 'residential',
'RR': 'residential', 'RI': 'residential',
'RS': 'residential', 'RK': 'residential',
'RW': 'residential', 'RM': 'residential',
'RX': 'residential', 'RR': 'residential',
'RZ': 'residential', 'RS': 'residential',
'S0': 'residential', 'RW': 'residential',
'S1': 'residential', 'RX': 'residential',
'S2': 'residential', 'RZ': 'residential',
'S3': 'residential', 'S0': 'residential',
'S4': 'residential', 'S1': 'residential',
'S5': 'residential', 'S2': 'residential',
'S9': 'residential', 'S3': 'residential',
'T1': 'na', 'S4': 'residential',
'T2': 'na', 'S5': 'residential',
'T9': 'na', 'S9': 'residential',
'U0': 'warehouse', 'T1': 'na',
'U1': 'warehouse', 'T2': 'na',
'U2': 'warehouse', 'T9': 'na',
'U3': 'warehouse', 'U0': 'warehouse',
'U4': 'warehouse', 'U1': 'warehouse',
'U5': 'warehouse', 'U2': 'warehouse',
'U6': 'warehouse', 'U3': 'warehouse',
'U7': 'warehouse', 'U4': 'warehouse',
'U8': 'warehouse', 'U5': 'warehouse',
'U9': 'warehouse', 'U6': 'warehouse',
'V0': 'na', 'U7': 'warehouse',
'V1': 'na', 'U8': 'warehouse',
'V2': 'na', 'U9': 'warehouse',
'V3': 'na', 'V0': 'na',
'V4': 'na', 'V1': 'na',
'V5': 'na', 'V2': 'na',
'V6': 'na', 'V3': 'na',
'V7': 'na', 'V4': 'na',
'V8': 'na', 'V5': 'na',
'V9': 'na', 'V6': 'na',
'W1': 'primary school', 'V7': 'na',
'W2': 'primary school', 'V8': 'na',
'W3': 'secondary school', 'V9': 'na',
'W4': 'secondary school', 'W1': 'primary school',
'W5': 'secondary school', 'W2': 'primary school',
'W6': 'secondary school', 'W3': 'secondary school',
'W7': 'secondary school', 'W4': 'secondary school',
'W8': 'primary school', 'W5': 'secondary school',
'W9': 'secondary school', 'W6': 'secondary school',
'Y1': 'large office', 'W7': 'secondary school',
'Y2': 'large office', 'W8': 'primary school',
'Y3': 'large office', 'W9': 'secondary school',
'Y4': 'large office', 'Y1': 'large office',
'Y5': 'large office', 'Y2': 'large office',
'Y6': 'large office', 'Y3': 'large office',
'Y7': 'large office', 'Y4': 'large office',
'Y8': 'large office', 'Y5': 'large office',
'Y9': 'large office', 'Y6': 'large office',
'Z0': 'na', 'Y7': 'large office',
'Z1': 'large office', 'Y8': 'large office',
'Z2': 'na', 'Y9': 'large office',
'Z3': 'na', 'Z0': 'na',
'Z4': 'na', 'Z1': 'large office',
'Z5': 'na', 'Z2': 'na',
'Z6': 'na', 'Z3': 'na',
'Z7': 'na', 'Z4': 'na',
'Z8': 'na', 'Z5': 'na',
'Z9': 'na' 'Z6': 'na',
'Z7': 'na',
'Z8': 'na',
'Z9': 'na'
} }
@staticmethod @staticmethod
def usage(pluto): def usage(building_pluto_function):
nrel_function = UsPlutoToUsage.building_function[pluto] """
return UsFunctionToUsage.building_usage[nrel_function] Get the nrel usage for the given building pluto function
:param building_pluto_function: str
:return: str
"""
return UsFunctionToUsage.usage(UsPlutoToUsage._building_function[building_pluto_function])