Update to newest Delft version and setup impacted population

docs/data/national_structure_inventory.rst

@@ -16,13 +16,13 @@ user can access the data through providing 'NSI' in the configuration file as su
 The following attributes for Delft-FIAT (left-hand side) will be filled with data from the
 corresponding NSI fields (right-hand side)::
 
-    "Object ID": "fd_id",
-    "Object Name": "fd_id",
-    "Primary Object Type": "st_damcat",
-    "Secondary Object Type": "occtype",
-    "Max Potential Damage: Structure": "val_struct",
-    "Max Potential Damage: Content": "val_cont",
-    "Ground Elevation": "ground_el",
+    "object_id": "fd_id",
+    "object_name": "fd_id",
+    "primary_object_type": "st_damcat",
+    "secondary_object_type": "occtype",
+    "max_damages_structure": "val_struct",
+    "max_damages_content": "val_cont",
+    "ground_elevtn": "ground_el",
     "X Coordinate": "x",
     "Y Coordinate": "y",
     "Aggregation Label: Census Block": "cbfips"

docs/user_guide/user_guide_overview.rst

@@ -39,8 +39,8 @@ See below how the `setup_exposure_buildings` method can be used to build or upda
    occupancy_type = <Key in the Data Catalog, data API key, or path to local data>
    damage_types = <List of damage types, e.g. ["structure", "content"]>
    max_potential_damage = <Key in the Data Catalog, data API key, or path to local data>
-   ground_floor_height = <For now only a number can be entered here for uniform ground floor heights>
-   unit = <The unit of the values in the exposure data inputs, e.g. if the ground floor height in meters, "m">
+   ground_floor_height = <For now only a number can be entered here for uniform Ground Floor Heights>
+   unit = <The unit of the values in the exposure data inputs, e.g. if the Ground Floor Height in meters, "m">
 
 The following method is used to build or update the **exposure** data:
 
@@ -89,9 +89,9 @@ After loading the configuration file (*.yml*) and executing the **FIAT Hydro MT*
 
    Aggregation Label: {label_name}
 
-*Note: It may occur that polygons overlap in the aggregation vector files. In this case the information for the affected Object ID will be merged and both aggregation zones will be assigned to the object.* ::
+*Note: It may occur that polygons overlap in the aggregation vector files. In this case the information for the affected object_id will be merged and both aggregation zones will be assigned to the object.* ::
 
-   Object ID   Zone
+   object_id   Zone
 
    1           Base Zone 1
    2           Land Use 1, Land Use 3    >  two zones (polygons) in the land-use aggregation file overlap and object

examples/aggregation_zones_example.ipynb

@@ -338,7 +338,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Load the newly created *exposure.csv* file from the <em>/ \"output\" / \"aggregation_zones_test1\" /</em> - directory and the original exposure geopackage from the <em> \"exposure\" / \"buildings.gpkg\" </em>. Before the results can be displayed, we must merge the **exposure.csv** with the  **buildings.gpkg** via common *\"Object ID\"*. "
+    "Load the newly created *exposure.csv* file from the <em>/ \"output\" / \"aggregation_zones_test1\" /</em> - directory and the original exposure geopackage from the <em> \"exposure\" / \"buildings.gpkg\" </em>. Before the results can be displayed, we must merge the **exposure.csv** with the  **buildings.gpkg** via common *\"object_id\"*. "
    ]
   },
   {
@@ -354,7 +354,7 @@
     "new_exposure=gpd.read_file(Path(os.path.abspath(\"\")) / \"data\" / \"aggregation_zones\" / \"aggregation_zones_test1\" / \"exposure\" / \"buildings.gpkg\")\n",
     "\n",
     "#Merge dataframe with GeoDataFrame\n",
-    "merged_gdf = new_exposure.merge(df_single_aggregation, left_on='Object ID', right_on='Object ID', how='inner')\n",
+    "merged_gdf = new_exposure.merge(df_single_aggregation, left_on='object_id', right_on='object_id', how='inner')\n",
     "\n",
     "#Display base_zones aggregation zone\n",
     "base_zones_map = merged_gdf.explore(column = 'Base_zones')\n",
@@ -372,7 +372,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Load the newly created *exposure.csv* file from the <em>/ \"output\" / \"aggregation_zones_test2\" /</em> - directory and the original exposure geopackage from the <em> \"exposure\" / \"buildings.gpkg\" </em>.  Before the results can be displayed, we must merge the **exposure.csv** with the  **buildings.gpkg** via common *\"Object ID\"*. "
+    "Load the newly created *exposure.csv* file from the <em>/ \"output\" / \"aggregation_zones_test2\" /</em> - directory and the original exposure geopackage from the <em> \"exposure\" / \"buildings.gpkg\" </em>.  Before the results can be displayed, we must merge the **exposure.csv** with the  **buildings.gpkg** via common *\"object_id\"*. "
    ]
   },
   {
@@ -388,7 +388,7 @@
     "new_exposure=gpd.read_file(Path(os.path.abspath(\"\")) / \"data\" / \"aggregation_zones\" / \"aggregation_zones_test2\" / \"exposure\" / \"buildings.gpkg\")\n",
     "\n",
     "# Merge dataframe with GeoDataFrame\n",
-    "merged_gdf_multiple = new_exposure.merge(df_multiple_aggregation, left_on='Object ID', right_on='Object ID', how='inner')"
+    "merged_gdf_multiple = new_exposure.merge(df_multiple_aggregation, left_on='object_id', right_on='object_id', how='inner')"
    ]
   },
   {

examples/data/aggregation_zones/fiat_model/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748561544418,-79.93000008,32.770545239,450190002002010,1,centroid,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635444641,-79.92968382,32.771271301,450190002002010,1,centroid,RES4
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.364031290178299,-79.93179589,32.773364727,450190002002004,1,centroid,RES1-2SNB

examples/data/aggregation_zones/fiat_model/output/aggregation_zones_test1/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Aggregation Label: Base_zones
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,Aggregation Label: Base_zones
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748561544418,-79.93000008,32.770545239,450190002002010,1,centroid,RES4,SR-3
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635444641,-79.92968382,32.771271301,450190002002010,1,centroid,RES4,SR-4
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.364031290178299,-79.93179589,32.773364727,450190002002004,1,centroid,RES1-2SNB,SR-5

examples/data/aggregation_zones/fiat_model/output/aggregation_zones_test2/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Aggregation Label: Base_zones,Aggregation Label: Land_use,Aggregation Label: Accommodation_type
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,Aggregation Label: Base_zones,Aggregation Label: Land_use,Aggregation Label: Accommodation_type
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748561544418,-79.93000008,32.770545239,450190002002010,1,centroid,RES4,SR-3,Neighborhood,
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635444641,-79.92968382,32.771271301,450190002002010,1,centroid,RES4,SR-4,Neighborhood,
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.364031290178299,-79.93179589,32.773364727,450190002002004,1,centroid,RES1-2SNB,SR-5,Neighborhood,

examples/data/aggregation_zones/fiat_model_aggregation1/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Aggregation Label: Zoning_map
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,Aggregation Label: Zoning_map
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748561544418,-79.93000008,32.770545239,450190002002010,1,centroid,RES4,SR-3
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635444641,-79.92968382,32.771271301,450190002002010,1,centroid,RES4,SR-4
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.364031290178299,-79.93179589,32.773364727,450190002002004,1,centroid,RES1-2SNB,SR-5

examples/data/aggregation_zones/fiat_model_aggregation2/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Aggregation Label: Zoning_map,Aggregation Label: Land_use_map,Aggregation Label: Accomodation_Zone
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,Aggregation Label: Zoning_map,Aggregation Label: Land_use_map,Aggregation Label: Accomodation_Zone
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748561544418,-79.93000008,32.770545239,450190002002010,1,centroid,RES4,SR-3,Neighborhood,
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635444641,-79.92968382,32.771271301,450190002002010,1,centroid,RES4,SR-4,Neighborhood,
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.364031290178299,-79.93179589,32.773364727,450190002002004,1,centroid,RES1-2SNB,SR-5,Neighborhood,

examples/data/building_footprints/fiat_model/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,4.5019E+14,1,centroid,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,4.5019E+14,1,centroid,RES4
 573785665,573785665,RES,RES1-2SNB,330007.42,165003.71,7.36403129,4.5019E+14,1,centroid,RES1-2SNB

examples/data/setup_exposure_buildings/test_vulnerability_and_exposure_NSI/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Floor Height,Ground Elevation,Aggregation Label: Census Block,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_flht,ground_elevtn,Aggregation Label: Census Block,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,0.5,2.580267906188965,450190001001006,centroid,RES3A_structure,RES3A_content
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.0,2.580267906188965,450190002002010,centroid,RES4_structure,RES4_content
 573783433,573783433,COM,RES4,476216.254,238108.127,0.5,2.0590968132019043,450190002002010,centroid,RES4_structure,RES4_content

examples/data/setup_exposure_buildings_with_dem_data/test_vulnerability_and_exposure_NSI/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Floor Height,Ground Elevation,Aggregation Label: Census Block,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_flht,ground_elevtn,Aggregation Label: Census Block,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,0.5,7.298348064632416,450190001001006,centroid,RES3A_structure,RES3A_content
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.0,8.381748561544418,450190002002010,centroid,RES4_structure,RES4_content
 573783433,573783433,COM,RES4,476216.254,238108.127,0.5,7.374183635444641,450190002002010,centroid,RES4_structure,RES4_content

examples/data/setup_new_composite_area/test_read/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,4.5019E+14,1,centroid,RES3A,RES3A
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,-79.93000008,32.77054524,4.5019E+14,1,centroid,RES4,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,-79.92968382,32.7712713,4.5019E+14,1,centroid,RES4,RES4

examples/data/setup_new_composite_area/test_setup_new_composite_area_elevation_aggregation/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content,LONGNAME,ZONE_BASE,LAND_USE
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content,LONGNAME,ZONE_BASE,LAND_USE
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,450190000000000.0,1.0,centroid,RES3A,RES3A,,,
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,-79.93000008,32.77054524,450190000000000.0,1.0,centroid,RES4,RES4,,,
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,-79.92968382,32.7712713,450190000000000.0,1.0,centroid,RES4,RES4,,,

examples/data/update_ground_elevation/fiat_model/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,4.5019E+14,1,centroid,RES3A,RES3A
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,-79.93000008,32.77054524,4.5019E+14,1,centroid,RES4,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,-79.92968382,32.7712713,4.5019E+14,1,centroid,RES4,RES4

examples/data/update_ground_elevation/test_update_ground_elevation/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,2.580267906188965,-79.93682513,32.77688289,450190000000000.0,1,centroid,RES3A,RES3A
 573783417,573783417,COM,RES4,1177614.2,588807.1,2.580267906188965,-79.93000008,32.77054524,450190000000000.0,1,centroid,RES4,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,2.0590968132019043,-79.92968382,32.7712713,450190000000000.0,1,centroid,RES4,RES4

examples/data/update_ground_floor_height/fiat_model/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,4.5019E+14,1,centroid,RES3A,RES3A
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,-79.93000008,32.77054524,4.5019E+14,1,centroid,RES4,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,-79.92968382,32.7712713,4.5019E+14,1,centroid,RES4,RES4

examples/data/update_max_potential_damage/fiat_model/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,4.5019E+14,1,centroid,RES3A,RES3A
 573783417,573783417,COM,RES4,1177614.2,588807.1,8.381748562,-79.93000008,32.77054524,4.5019E+14,1,centroid,RES4,RES4
 573783433,573783433,COM,RES4,476216.254,238108.127,7.374183635,-79.92968382,32.7712713,4.5019E+14,1,centroid,RES4,RES4

examples/data/update_max_potential_damage/test_update_max_potential_damage_polygons/exposure/exposure.csv

@@ -1,4 +1,4 @@
-Object ID,Object Name,Primary Object Type,Secondary Object Type,Max Potential Damage: Structure,Max Potential Damage: Content,Ground Elevation,X Coordinate,Y Coordinate,Aggregation Label: Census Block,Ground Floor Height,Extraction Method,Damage Function: Structure,Damage Function: Content,geometry,groundfloorheight,maxpotential_content
+object_id,object_name,primary_object_type,secondary_object_type,max_damages_structure,max_damages_content,ground_elevtn,X Coordinate,Y Coordinate,Aggregation Label: Census Block,ground_flht,extract_method,fn_damages_structure,fn_damages_content,geometry,groundfloorheight,maxpotential_content
 574486973,574486973,RES,RES3A,480189.335,240094.667,7.298348065,-79.93682513,32.77688289,450190000000000.0,1,centroid,RES3A,RES3A,POINT (-79.93682513 32.776882893),,
 573783417,573783417,COM,RES4,10000.0,588807.1,8.381748562,-79.93000008,32.77054524,450190000000000.0,1,centroid,RES4,RES4,POINT (-79.93000008 32.770545239),7.0,10000.0
 573783433,573783433,COM,RES4,10000.0,238108.127,7.374183635,-79.92968382,32.7712713,450190000000000.0,1,centroid,RES4,RES4,POINT (-79.92968382 32.771271301),7.0,10000.0