wrap the permission shell script within python module and fix building count issue

Author: supathdhitalGEO

docs/fimeval_usage.ipynb

@@ -255,18 +255,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/supath/Downloads/MSResearch/FIMpef/fimpef/.venv/lib/python3.11/site-packages/geemap/conversion.py:23: UserWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html. The pkg_resources package is slated for removal as early as 2025-11-30. Refrain from using this package or pin to Setuptools<81.\n",
-      "  import pkg_resources\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "#Import the package\n",
     "import fimeval as fp\n",
@@ -282,7 +273,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -337,7 +328,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -363,13 +354,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [],
    "source": [
     "fp.EvaluateFIM(main_dir, method_name, output_dir)   #It uses the default Permanent Water Bodies (PWB) dataset for United States.\n",
     "\n",
-    "#If the User has their PWB shapefile, then give the following argument\n",
+    "# #If the User has their PWB shapefile, then give the following argument\n",
     "fp.EvaluateFIM(main_dir, method_name, output_dir, PWB_dir = PWD_dir)"
    ]
   },
@@ -434,6 +425,13 @@
     "# fp.EvaluationWithBuildingFootprint(main_dir, method_name, output_dir, building_footprint = building_footprint, shapefile_dir= AOI)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**For building automation, need to install java runtime (preferred version is 8: https://www.java.com/en/download/manual.jsp). For Windows need to setup the path and environmental variables carefully to avoid the RunTimeError**"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -453,7 +451,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "fimpef",
+   "display_name": "fimeval",
    "language": "python",
    "name": "python3"
   },
@@ -467,7 +465,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.13"
+   "version": "3.10.18"
   }
  },
  "nbformat": 4,

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fimeval"
-version = "0.1.53"
+version = "0.1.54"
 description = "A Framework for Automatic Evaluation of Flood Inundation Mapping Predictions Evaluation"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -29,7 +29,8 @@ dependencies = [
   "pyproj>=3.7.0,<4.0.0",
   "notebook>=7.3.2,<8.0.0",
   "boto3>=1.36.16,<2.0.0",
-  "geemap"
+  "geemap",
+  "uv"
 ]
 
 [project.optional-dependencies]

src/fimeval.egg-info/PKG-INFO

@@ -20,7 +20,6 @@ def Changeintogpkg(input_path, output_dir, layer_name):
         gdf.to_file(output_gpkg, driver="GPKG")
         return output_gpkg
 
-
 def GetFloodedBuildingCountInfo(
     building_fp_path,
     study_area_path,
@@ -31,7 +30,6 @@ def GetFloodedBuildingCountInfo(
     basename,
 ):
     output_dir = os.path.dirname(building_fp_path)
-
     building_fp_gpkg = Changeintogpkg(
         building_fp_path, output_dir, "building_footprint"
     )
@@ -42,7 +40,6 @@ def GetFloodedBuildingCountInfo(
     with rasterio.open(raster1_path) as src:
         target_crs = str(src.crs)
 
-    # Reproject all GeoDataFrames to the target CRS
     if building_gdf.crs != target_crs:
         building_gdf = building_gdf.to_crs(target_crs)
         print("reproject building_gdf")
@@ -55,43 +52,32 @@ def GetFloodedBuildingCountInfo(
     clipped_buildings["centroid"] = clipped_buildings.geometry.centroid
 
     centroid_counts = {
-        "Benchmark": 0,
-        "Candidate": 0,
         "False Positive": 0,
         "False Negative": 0,
         "True Positive": 0,
     }
 
-    def count_centroids_in_raster(raster_path, label):
+    # Count centroids in the contingency map
+    def count_centroids_in_contingency(raster_path):
         with rasterio.open(raster_path) as src:
             raster_data = src.read(1)
-            transform = src.transform
-
             for centroid in clipped_buildings["centroid"]:
                 row, col = src.index(centroid.x, centroid.y)
                 if 0 <= row < raster_data.shape[0] and 0 <= col < raster_data.shape[1]:
                     pixel_value = raster_data[row, col]
-                    if label in ["Benchmark", "Candidate"]:
-                        if pixel_value == 2:  # False Positive
-                            centroid_counts[label] += 1
-                    else:
-                        if pixel_value == 2:
-                            centroid_counts["False Positive"] += 1
-                        elif pixel_value == 3:
-                            centroid_counts["False Negative"] += 1
-                        elif pixel_value == 4:
-                            centroid_counts["True Positive"] += 1
+                    if pixel_value == 2:
+                        centroid_counts["False Positive"] += 1
+                    elif pixel_value == 3:
+                        centroid_counts["False Negative"] += 1
+                    elif pixel_value == 4:
+                        centroid_counts["True Positive"] += 1
 
-    if "bm" in str(raster1_path).lower():
-        count_centroids_in_raster(raster1_path, "Benchmark")
-        count_centroids_in_raster(raster2_path, "Candidate")
+    count_centroids_in_contingency(contingency_map)
 
-    elif "candidate" in str(raster2_path).lower():
-        count_centroids_in_raster(raster1_path, "Candidate")
-        count_centroids_in_raster(raster2_path, "Benchmark")
+    # Calculate Candidate and Benchmark counts from the contingency map counts
+    centroid_counts["Candidate"] = centroid_counts["True Positive"] + centroid_counts["False Positive"]
+    centroid_counts["Benchmark"] = centroid_counts["True Positive"] + centroid_counts["False Negative"]
 
-    if "contingency" in str(contingency_map).lower():
-        count_centroids_in_raster(contingency_map, "Contingency")
 
     total_buildings = len(clipped_buildings)
     percentages = {
@@ -107,10 +93,14 @@ def count_centroids_in_raster(raster_path, label):
     FAR = FP / (TP + FP) if (TP + FP) > 0 else 0
     POD = TP / (TP + FN) if (TP + FN) > 0 else 0
 
-    BDR = (
-        centroid_counts["Candidate"] - centroid_counts["Benchmark"]
-    ) / centroid_counts["Benchmark"]
-
+    if centroid_counts["Benchmark"] > 0:
+        BDR = (
+            (centroid_counts["Candidate"] - centroid_counts["Benchmark"])
+            / centroid_counts["Benchmark"]
+        )
+    else:
+            BDR = 0
+        
     counts_data = {
         "Category": [
             "Candidate",
@@ -290,15 +280,19 @@ def detect_shapefile(folder):
 def ensure_pyspark(version: str | None = "3.5.4") -> None:
     """Install pyspark at runtime via `uv pip` into this env (no-op if present)."""
     import importlib, shutil, subprocess, sys, re
+
     try:
         import importlib.util
+
         if importlib.util.find_spec("pyspark"):
             return
     except Exception:
         pass
     uv = shutil.which("uv")
     if not uv:
-        raise RuntimeError("`uv` not found on PATH. Please install uv or add it to PATH.")
+        raise RuntimeError(
+            "`uv` not found on PATH. Please install uv or add it to PATH."
+        )
     if version is None:
         spec = "pyspark"
     else:
@@ -307,7 +301,6 @@ def ensure_pyspark(version: str | None = "3.5.4") -> None:
     subprocess.check_call([uv, "pip", "install", "--python", sys.executable, spec])
 
 
-
 def EvaluationWithBuildingFootprint(
     main_dir,
     method_name,
@@ -338,11 +331,11 @@ def EvaluationWithBuildingFootprint(
                     boundary = detect_shapefile(main_dir)
 
                 building_footprintMS = building_footprint
-                
+
                 if building_footprintMS is None:
                     ensure_pyspark()
                     from .microsoftBF import BuildingFootprintwithISO
-                    
+
                     out_dir = os.path.join(method_path, "BuildingFootprint")
                     if not os.path.exists(out_dir):
                         os.makedirs(out_dir)
@@ -398,11 +391,11 @@ def EvaluationWithBuildingFootprint(
                             boundary = detect_shapefile(os.path.join(main_dir, folder))
 
                         building_footprintMS = building_footprint
-                        
+
                         if building_footprintMS is None:
                             ensure_pyspark()
                             from .microsoftBF import BuildingFootprintwithISO
-                            
+
                             out_dir = os.path.join(method_path, "BuildingFootprint")
                             if not os.path.exists(out_dir):
                                 os.makedirs(out_dir)

src/fimeval.egg-info/SOURCES.txt

@@ -18,6 +18,7 @@
 # Authenticate and initialize Earth Engine
 ee.Authenticate()
 
+
 # %%
 def split_into_tiles(boundary, tile_size=0.1):
     bounds = boundary.total_bounds

src/fimeval.egg-info/dependency_links.txt

@@ -31,24 +31,35 @@ def is_writable(path):
 
 def fix_permissions(path):
     path = Path(path).resolve()
-    script_path = Path(__file__).parent / "fix_permissions.sh"
-
-    if not script_path.exists():
-        raise FileNotFoundError(f"Shell script not found: {script_path}")
 
     if is_writable(path):
         return
 
+    uname = platform.system()
+
     try:
-        result = subprocess.run(
-            ["bash", str(script_path), str(path)],
-            check=True,
-            capture_output=True,
-            text=True,
-        )
-        print(result.stdout)
+        if uname in ["Darwin", "Linux"]:
+            subprocess.run(
+                ["chmod", "-R", "u+rwX", str(path)],
+                check=True,
+                capture_output=True,
+                text=True,
+            )
+            print(f"Permissions granted for user (u+rwX): {path}")
+
+        elif "MINGW" in uname or "MSYS" in uname or "CYGWIN" in uname:
+            subprocess.run(
+                ["icacls", str(path), "/grant", "Everyone:F", "/T"],
+                check=True,
+                capture_output=True,
+                text=True,
+            )
+            print(f"Permissions granted for working folder: {path}")
+
+        else:
+            print(f"Unsupported OS: {uname}")
     except subprocess.CalledProcessError as e:
-        print(f"Shell script failed:\n{e.stderr}")
+        print(f"Failed to fix permissions for {path}:\n{e.stderr}")
 
 
 # Function for the evalution of the model