Merge pull request #3911 from architecture-building-systems/some-fix-from-idp-shanghai---void-deck-and-pv-without-demand

Allow running pv plots without running demand

Author: reyery

cea/analysis/lca/embodied.py

@@ -15,7 +15,7 @@
 import cea.inputlocator
 from cea.constants import SERVICE_LIFE_OF_BUILDINGS, SERVICE_LIFE_OF_TECHNICAL_SYSTEMS, \
     CONVERSION_AREA_TO_FLOOR_AREA_RATIO, EMISSIONS_EMBODIED_TECHNICAL_SYSTEMS
-from cea.datamanagement.void_deck_migrator import migrate_void_deck_data
+from cea.datamanagement.utils import migrate_void_deck_data
 
 __author__ = "Jimeno A. Fonseca"
 __copyright__ = "Copyright 2015, Architecture and Building Systems - ETH Zurich"

cea/datamanagement/archetypes_mapper.py

@@ -100,6 +100,7 @@ def archetypes_mapper(locator,
         supply_mapper(locator, building_typology_df)
 
 
+
 def indoor_comfort_mapper(list_uses, locator, occupant_densities, building_typology_df):
     comfort_DB = pd.read_csv(locator.get_database_archetypes_use_type())
     # define comfort
@@ -400,7 +401,6 @@ def verify_building_standards(building_typology_df, db_standards):
         diff = typology_standards.difference(db_standards)
         raise ValueError(f'The following standards are not found in the database: {", ".join(diff)}')
 
-
 def main(config):
     """
     Run the properties script with input from the reference case and compare the results. This ensures that changes

cea/datamanagement/format_helper/cea4_migrate.py

@@ -24,6 +24,7 @@
 from cea.datamanagement.format_helper.cea4_verify import cea4_verify, verify_shp, \
     COLUMNS_ZONE_4, print_verification_results_4, path_to_input_file_without_db_4, CSV_BUILDING_PROPERTIES_3_CSV
 from cea.datamanagement.format_helper.cea4_verify_db import check_directory_contains_csv
+from cea.datamanagement.utils import migrate_void_deck_data
 from cea.utilities.dbf import dbf_to_dataframe
 
 COLUMNS_ZONE_3 = ['Name', 'floors_bg', 'floors_ag', 'height_bg', 'height_ag']
@@ -550,9 +551,12 @@ def migrate_cea3_to_cea4(scenario, verbose=False):
                 pass
                 # print('For Scenario: {scenario}, '.format(scenario=scenario_name), 'zone.shp already follows the CEA-4 format.')
             else:
-                raise ValueError('! zone.shp exists but follows neither the CEA-3 nor CEA-4 format. CEA cannot proceed with the data migration.'
-                                 'Check the following column(s) for CEA-3 format: {list_missing_attributes_zone_3}.'.format(list_missing_attributes_zone_3=list_missing_attributes_zone_3),
-                                 'Check the following column(s) for CEA-4 format: {list_missing_attributes_zone_4}.'.format(list_missing_attributes_zone_4=list_missing_attributes_zone_4)
+                if list_missing_attributes_zone_4[0] == 'void_deck' and len(list_missing_attributes_zone_4) == 1:
+                    config = cea.config.Configuration()
+                    locator = cea.inputlocator.InputLocator(config.scenario)
+                    migrate_void_deck_data(locator)
+                else:
+                    raise ValueError('! zone.shp exists but follows neither the CEA-3 nor CEA-4 format. CEA cannot proceed with the data migration. Check the following column(s) for CEA-3 format: {list_missing_attributes_zone_3}.'.format(list_missing_attributes_zone_3=list_missing_attributes_zone_3), 'Check the following column(s) for CEA-4 format: {list_missing_attributes_zone_4}.'.format(list_missing_attributes_zone_4=list_missing_attributes_zone_4)
                                  )
         else:
             print("! Ensure zone.shp (CEA-3 format) is present in building-geometry folder.")
@@ -571,9 +575,12 @@ def migrate_cea3_to_cea4(scenario, verbose=False):
                 pass
                 # print('For Scenario: {scenario}, '.format(scenario=scenario_name), 'surroundings.shp already follows the CEA-4 format.')
             else:
-                raise ValueError('surroundings.shp exists but follows neither the CEA-3 nor CEA-4 format. CEA cannot proceed with the data migration.'
-                                 'Check the following column(s) for CEA-3 format: {list_missing_attributes_surroundings_3}.'.format(list_missing_attributes_surroundings_3=list_missing_attributes_surroundings_3),
-                                 'Check the following column(s) for CEA-4 format: {list_missing_attributes_surroundings_4}.'.format(list_missing_attributes_surroundings_4=list_missing_attributes_surroundings_4)
+                if list_missing_attributes_zone_4[0] == 'void_deck' and len(list_missing_attributes_zone_4) == 1:
+                    config = cea.config.Configuration()
+                    locator = cea.inputlocator.InputLocator(config.scenario)
+                    migrate_void_deck_data(locator)
+                else:
+                    raise ValueError('surroundings.shp exists but follows neither the CEA-3 nor CEA-4 format. CEA cannot proceed with the data migration. Check the following column(s) for CEA-3 format: {list_missing_attributes_surroundings_3}.'.format(list_missing_attributes_surroundings_3=list_missing_attributes_surroundings_3), 'Check the following column(s) for CEA-4 format: {list_missing_attributes_surroundings_4}.'.format(list_missing_attributes_surroundings_4=list_missing_attributes_surroundings_4)
                                  )
         else:
             print('! (optional) Run Surroundings Helper to generate surroundings.shp after the data migration.')

cea/datamanagement/void_deck_migrator.py renamed to cea/datamanagement/utils/__init__.py

@@ -1,10 +1,15 @@
+from __future__ import annotations
+from typing import TYPE_CHECKING
+import warnings
+
 import pandas as pd
 import geopandas as gpd
-import cea.inputlocator
-import warnings
 
+if TYPE_CHECKING:
+    from cea.inputlocator import InputLocator
 
-def migrate_void_deck_data(locator: cea.inputlocator.InputLocator) -> None:
+
+def migrate_void_deck_data(locator: InputLocator) -> None:
     """Check if void_deck exists in zone.shp and copy it from envelope.csv if necessary.
 
     :param locator: the input locator object.
@@ -23,6 +28,8 @@ def migrate_void_deck_data(locator: cea.inputlocator.InputLocator) -> None:
                 envelope_df[["name", "void_deck"]], on="name", how="left"
             )
             zone_gdf["void_deck"] = zone_gdf["void_deck"].fillna(0)
+            zone_gdf.to_file(locator.get_zone_geometry())
+
             print("Migrated void_deck data from envelope.csv to zone.shp.")
             envelope_df.drop(columns=["void_deck"], inplace=True)
             envelope_df.to_csv(locator.get_building_architecture(), index=False)
@@ -32,4 +39,11 @@ def migrate_void_deck_data(locator: cea.inputlocator.InputLocator) -> None:
             warnings.warn(
                 "No void_deck data found in envelope.csv, setting to 0 in zone.shp"
             )
-        zone_gdf.to_file(locator.get_zone_geometry(), driver="ESRI Shapefile")
+
+    # Validate that floors_ag is larger than void_deck for each building
+    actual_floors = zone_gdf["floors_ag"] - zone_gdf["void_deck"]
+    invalid_floors = zone_gdf[actual_floors <= 0]
+    if len(invalid_floors) > 0:
+        invalid_buildings = invalid_floors["name"].tolist()
+        warnings.warn(f"Some buildings have void_deck greater than floors_ag: {invalid_buildings}",
+                      RuntimeWarning)

cea/demand/building_properties/building_geometry.py

@@ -4,6 +4,7 @@
 from __future__ import annotations
 from geopandas import GeoDataFrame as Gdf
 
+from cea.datamanagement.databases_verification import COLUMNS_ZONE_GEOMETRY
 from cea.utilities.standardize_coordinates import get_lat_lon_projected_shapefile, get_projected_coordinate_system
 
 from typing import TYPE_CHECKING
@@ -25,18 +26,19 @@ def __init__(self, locator: InputLocator, building_names: list[str]):
         :param locator: an InputLocator for locating the input files
         :param building_names: list of buildings to read properties for
         """
-        prop_geometry: Gdf = Gdf.from_file(locator.get_zone_geometry()).set_index('name').loc[building_names]
+        prop_geometry = Gdf.from_file(locator.get_zone_geometry())[COLUMNS_ZONE_GEOMETRY + ['geometry']].set_index('name').loc[building_names]
 
         # reproject to projected coordinate system (in meters) to calculate area
         lat, lon = get_lat_lon_projected_shapefile(prop_geometry)
         target_crs = get_projected_coordinate_system(float(lat), float(lon))
-        prop_geometry: Gdf = prop_geometry.to_crs(target_crs)
+        prop_geometry = prop_geometry.to_crs(target_crs)
 
+        # TODO: Check usage of footprint and perimeter in other parts of the code
         prop_geometry['footprint'] = prop_geometry.area
         prop_geometry['perimeter'] = prop_geometry.length
         prop_geometry['Blength'], prop_geometry['Bwidth'] = self.calc_bounding_box_geom(prop_geometry)
 
-        self._prop_geometry = prop_geometry.drop('geometry', axis=1)
+        self._prop_geometry = prop_geometry
 
     @staticmethod
     def calc_bounding_box_geom(gdf: Gdf) -> tuple[list[float], list[float]]:

cea/demand/building_properties/building_properties.py

@@ -108,10 +108,7 @@ def check_buildings(self, min_gfa: float = 100):
         """
 
         # FIXME: This is not a very good indicator of potential issue which causes overheating problems in some cases.
-        footprint = self.geometry._prop_geometry.footprint
-        floors = self.geometry._prop_geometry.floors_ag
-
-        GFA_m2 = footprint * floors
+        GFA_m2 = self.rc_model._prop_rc_model['GFA_m2']
         small_buildings = GFA_m2[GFA_m2 < min_gfa]
 
         if len(small_buildings) > 0:

cea/demand/building_properties/building_properties_row.py

@@ -234,6 +234,13 @@ class EnvelopeProperties:
     A_op: Annotated[float, "Opaque area above ground [m2]"]
     win_wall: Annotated[float, "Window to wall ratio [-]"]
 
+    # Area fields added from BuildingRCModel
+    Aroof: Annotated[float, "Roof area [m2]"]
+    Aunderside: Annotated[float, "Underside area [m2]"]
+    Awall_ag: Annotated[float, "Above ground wall area [m2]"]
+    Awin_ag: Annotated[float, "Above ground window area [m2]"]
+    Aop_bg: Annotated[float, "Area of opaque surfaces below ground [m2]"]
+
     # FIXME: These fields does not neccessarily describe the building envelope
     Es: Annotated[float, "Heated/cooled share [-]"]
     occupied_bg: Annotated[float, "Basement occupation factor [-]"]
@@ -263,18 +270,14 @@ def from_dict(cls, solar: dict):
 @dataclass(frozen=True)
 class RCModelProperties:
     # --- Area properties ---
+    footprint: Annotated[float, "Building footprint area [m2]"]
     Atot: Annotated[float, "Area of all surfaces facing the building zone [m2]"]
+    Am: Annotated[float, "Effective mass area [m2]"]
+    # TODO: Determine if these fields belong here (calculated using calc_useful_areas)
     Af: Annotated[float, "Conditioned floor area (areas that are heated or cooled) [m2]"]
     GFA_m2: Annotated[float, "Gross floor area [m2]"]
-    footprint: Annotated[float, "Building footprint area [m2]"]
-    Aroof: Annotated[float, "Roof area [m2]"]
-    Aunderside: Annotated[float, "Underside area [m2]"]
-    Awall_ag: Annotated[float, "Above ground wall area [m2]"]
-    Awin_ag: Annotated[float, "Above ground window area [m2]"]
-    Am: Annotated[float, "Effective mass area [m2]"]
     Aef: Annotated[float, "Electrified area (share of gross floor area that is electrified) [m2]"]
     Aocc: Annotated[float, "Occupied floor area [m2]"]
-    Aop_bg: Annotated[float, "Area of opaque surfaces below ground [m2]"]
     Hs_ag: Annotated[float, "Share of above-ground gross floor area that is conditioned [m2/m2]"]
 
     # --- Thermal properties ---
@@ -289,13 +292,6 @@ class RCModelProperties:
     Htr_op: Annotated[float, "Thermal transmission coefficient for opaque surfaces in RC-model [W/K]"]
     Htr_w: Annotated[float, "Thermal transmission coefficient for windows in RC-model [W/K]"]
 
-    # FIXME: Decide if these fields should be in envelope or rc_model
-    # --- U-values (Duplicated Envelope properties) ---
-    U_wall: Annotated[float, "U-value of wall [W/m2K]"]
-    U_roof: Annotated[float, "U-value of roof [W/m2K]"]
-    U_win: Annotated[float, "U-value of windows [W/m2K]"]
-    U_base: Annotated[float, "U-value of floor [W/m2K]"]
-
     @classmethod
     def from_dict(cls, rc_model: dict):
         field_names = cls.__annotations__.keys()