added the evaluation module within FIMserv

Author: supathdhitalGEO

src/fimserve/__init__.py

@@ -37,6 +37,7 @@
 
 # evaluation of FIM
 from .fimevaluation.fims_setup import FIMService, fim_lookup
+from .fimevaluation.run_fimeval import run_evaluation
 
 
 __all__ = [
@@ -57,4 +58,5 @@
     "getIntersectedHUC8ID",
     "FIMService",
     "fim_lookup",
+    "run_evaluation",
 ]

src/fimserve/fimevaluation/__init__.py

@@ -1,3 +1,4 @@
 from .fims_setup import FIMService, fim_lookup
+from .run_fimeval import run_evaluation
 
-__all__ = ["FIMService", "fim_lookup"]
+__all__ = ["FIMService", "fim_lookup", "run_evaluation"]

src/fimserve/fimevaluation/fims_setup.py

@@ -523,7 +523,7 @@ def fim_lookup(
     date_input: Optional[str] = None,
     file_name: Optional[str] = None,
     run_handfim: bool = False,
-    out_dir: Optional[str] = None,
+    out_dir: Optional[str] = None,  # Directory to place downloaded/generated files
     start_date: Optional[str] = None,
     end_date: Optional[str] = None,
 ) -> str:

src/fimserve/fimevaluation/run_fimeval.py

@@ -0,0 +1,115 @@
+"""
+FIM evaluation workflow module within FIMserv.
+Author: Supath Dhital
+Date: 18 Nov, 2025
+"""
+
+import os
+from pathlib import Path
+from typing import Optional
+import fimeval as fe # type: ignore
+
+class run_evaluation:
+    """
+    Runs the full Flood Inundation Mapping (FIM) evaluation workflow.
+
+    This class loads benchmark FIM data (from FIMbench or user-provided folders),
+    performs raster-based evaluation, optionally prints summary plots, and can also
+    run building-footprint-based exposure evaluation.
+
+    The below mostly used internally, incase user want to run evaluation with modifications of data inputs they can pass different parameters
+    Parameters
+    ----------
+    Main_dir : Optional[str]; Directory containing benchmark FIM inputs. Defaults to ./FIM_Evaluation/FIM_inputs if not provided.
+    output_dir : Optional[str]; Folder where evaluation results and graphs will be saved.
+    shapefile_path : Optional[str]; AOI shapefile or vector file used to clip data during evaluation. Internally used the geopackage within folder.
+    PWB_dir : Optional[str]; Directory containing the Permanent Water Bodies.
+    building_footprint : Optional[str]; Local building footprint dataset (GeoJSON/Shapefile/Parquet) for building-level exposure evaluation.
+    target_crs : Optional[str]; CRS to reproject FIM rasters to (e.g., "EPSG:3857").
+    target_resolution : Optional[float]; Output raster resolution (units depend on CRS).
+    method_name : Optional[str]; Name of the evaluation method to evaluate. Defaults to "AOI".
+    countryISO : Optional[str]; ISO-3 country code used only when downloading footprints from GEE.
+    geeprojectID : Optional[str]; Google Earth Engine project ID for footprint download (if no local file provided).
+    print_graphs : bool; If True, generates and saves contingency maps and evaluation metric plots.
+    Evalwith_BF : bool; If True, performs building-footprint-based exposure evaluation.
+    """
+    def __init__(
+        self,
+        Main_dir: Optional[str] = None,   #If user use their own input directory to save benchmark FIM outputs
+        output_dir: Optional[str] = None,
+        shapefile_path: Optional[str] = None,
+        PWB_dir: Optional[str] = None,
+        building_footprint: Optional[str] = None,
+        target_crs: Optional[str] = None,
+        target_resolution: Optional[float] = None,
+        method_name: Optional[str] = None, #By default it will use 'AOI' which is downloaded but incase user want to explore different method they can pass here
+        countryISO: Optional[str] = None,
+        geeprojectID: Optional[str] = None,
+        print_graphs: bool = False,
+        Evalwith_BF: bool = False,  #If user want to run evaluation with building footprint
+        ):
+        if Main_dir is None:
+            self.Main_dir = os.path.join(os.getcwd(), "FIM_Evaluation", "FIM_inputs")
+        else:
+            self.Main_dir = Main_dir
+        
+        self.shapefile_path = shapefile_path
+        
+        if output_dir is None:
+            self.output_dir = os.path.join(os.getcwd(), "FIM_Evaluation", "Evaluation_Results")
+        else:
+            self.output_dir = output_dir
+            
+        self.PWB_dir = PWB_dir
+        self.building_footprint = building_footprint
+        self.target_crs = target_crs
+        self.target_resolution = target_resolution
+        if method_name is None:
+            self.method_name = 'AOI'
+        else:
+            self.method_name = method_name
+        self.countryISO = countryISO
+        self.geeprojectID = geeprojectID
+        self.Evalwith_BF = Evalwith_BF
+        self.print_graphs = print_graphs
+        
+        #run the process
+        self.run_eval()
+        
+    def run_eval(self):
+        fe.EvaluateFIM(
+            main_dir=self.Main_dir,
+            method_name=self.method_name,
+            output_dir=self.output_dir,
+            PWB_dir=self.PWB_dir,
+            shapefile_dir=self.shapefile_path,
+            target_crs=self.target_crs,
+            target_resolution=self.target_resolution,
+        )
+        
+        if self.print_graphs:
+            fe.PrintContingencyMap(
+                main_dir=self.Main_dir,
+                method_name=self.method_name,
+                output_dir=self.output_dir,
+            )
+            fe.PlotEvaluationMetrics(
+                main_dir=self.Main_dir,
+                method_name=self.method_name,
+                output_dir=self.output_dir,
+            )
+        
+        if self.Evalwith_BF:
+            try:
+                fe.EvaluationWithBuildingFootprint(
+                    main_dir=self.Main_dir,
+                    method_name=self.method_name,
+                    output_dir=self.output_dir,
+                    countryISO=self.countryISO,
+                    geeprojectID=self.geeprojectID,
+                    building_footprint=self.building_footprint,
+                )
+            except Exception as e:
+                print("Skipping evaluation with building footprint due to error:", e)
+            
+

tests/test_evalutionhandfim.py

@@ -7,9 +7,27 @@ def test_bm_fimlookup():
     out = fm.fim_lookup(
         HUCID="10170203",
         date_input="2019-09-19 16:00:00",  # If user is more specific then they can pass date (with hour if known) along with HUC8
-        # run_handfim=True,  #It will look for the owp hand fim for the mentioned HUC8 and date, if not found it will download and generate the owp hand fim
+        run_handfim=True,  #It will look for the owp hand fim for the mentioned HUC8 and date, if not found it will download and generate the owp hand fim
         # file_name="PSS_1_0m_20190919T165541_963659W424518N_BM.tif", #If user pass the specific filename, it will download that and assume that this is the right benchmark, else based on exact match of date it will look for the benchmark
+        # out_dir = None, # If user want to save the benchmark fim in specific directory
         # start_date="2024-06-20", #If user is not sure of the exact date then they can pass a range of dates
         # end_date="2024-06-25",
     )
     print(out)
+    
+#After finalizing the benchmark FIM data user can run evaluation
+def test_run_fimeval():
+    fm.run_evaluation(
+        Main_dir=None,   #If user use their own input directory to where FIM outputs; basically out_dir in fim_lookup us Main_dir here
+        output_dir= None, #Folder where evaluation results will be saved
+        shapefile_path= None, #AOI shapefile or vector file used to clip data during evaluation. Internally used the geopackage within folder.
+        PWB_dir= None, #Directory containing the Permanent Water Bodies.
+        building_footprint= None, #Local building footprint dataset (GeoJSON/Shapefile) for building-level exposure evaluation.
+        target_crs= None, #CRS to reproject FIM rasters to (e.g., "EPSG:3857").
+        target_resolution= None, #Output raster resolution (units depend on CRS).
+        method_name= None, #By default it will use 'AOI' which is downloaded but incase user want to explore different method they can pass here
+        countryISO= None,   #ISO-3 country code used only when downloading footprints from GEE.
+        geeprojectID= None, #Google Earth Engine project ID for footprint download (if no local file provided).
+        print_graphs= False, #If True, generates and saves contingency maps and evaluation metric plots.
+        Evalwith_BF= False,  #If user want to run evaluation with building footprint
+        )