fimeval 0.1.56__tar.gz → 0.1.58__tar.gz

{fimeval-0.1.56 → fimeval-0.1.58}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fimeval
-Version: 0.1.56
+Version: 0.1.58
 Summary: A Framework for Automatic Evaluation of Flood Inundation Mapping Predictions Evaluation
 Author: Surface Dynamics Modeling Lab
 Author-email: Supath Dhital <sdhital@crimson.ua.edu>, Dipshika Devi <ddevi@ua.edu>
@@ -680,9 +680,8 @@ Requires-Dist: kaleido==0.2.1
 Requires-Dist: nbformat<6.0.0,>=5.10.4
 Requires-Dist: pyproj<4.0.0,>=3.7.0
 Requires-Dist: notebook<8.0.0,>=7.3.2
-Requires-Dist: boto3<2.0.0,>=1.36.16
+Requires-Dist: boto3>=1.40.0
 Requires-Dist: geemap
-Requires-Dist: uv
 Requires-Dist: seaborn
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
@@ -712,7 +711,7 @@ To address these issues, we developed Flood Inundation Mapping Prediction Evalua
 
 
 
-### **Repository structure**
+### Repository structure
 <hr style="border: 1px solid black; margin: 0;">  
 
 The architecture of the ```fimeval``` integrates different modules to which helps the automation of flood evaluation. All those modules codes are in source (```src``` ) folder.
@@ -721,11 +720,15 @@ fimeval/
 ├── docs/                       # Documentation (contains 'FIMserv' Tool usage sample codes)
 │   └── sampledata/              # Contains the sample data to demonstrate how this frameworks works    
 │   └── fimeval_usage.ipynb            #Sample code usage of the Evaluation framework
+│   └── fimbench_usage.ipynb           #Sample code usage of the FIMbench Query and getting benchmark dataset
 ├── Images/                       # have sample images for documentation       
 ├── src/
-│   └── fimeval/         
+│   └── fimeval/    
+│       ├──BenchFIMQuery/   #Module to interact with the extensive FIMdatabase, hosted in AWS S3
+│       │   └── access_benchfim.py   #Different classes to query right benchmark FIM for any given location and set of filter
+│       │   └── utilis.py   #Support utility      
 │       ├──BuildingFootprint/ # Contains the evaluation of model predicted FIM with microsoft building footprint
-│       │   └── microsoftBF.py 
+│       │   └── arcgis_API.py   #seamless integration of building footprint in evaluation through ArcGIS REST API
 │       │   └── evaluationwithBF.py       
 │       └── ContingencyMap/      # Contains all the metrics calculation and contingency map generation
 │       │   ├── evaluationFIM.py # main evaluation moodule 
@@ -733,18 +736,18 @@ fimeval/
 │       │   └── metrics.py  # metrics calculation module
 │       │   └── plotevaluationmetrics.py  # use to vizualize the different performance metrics
 │       │   └── printcontingency.py  # prints the contingency map to quickly generate the Map layout
-│       │   └── PWBs3.py  # module which helps to get permanent water bodies from s3 bucket
+│       │   └── water_bodies.py  # module which to get permanent water bodies from s3 bucket and ArcGIS REST API
 │       └── utilis.py   #Includes the resampling and reprojection of FIMs
 └── tests/                  # Includes test cases for different functionality
 ```
 The graphical representation of fimeval pipeline can be summarized as follows in **```Figure 1```**. Here, it will show all the steps incorporated within the ```fimeval``` during packaging and all functionality are interconnected to each other, resulting the automation of the framework.
 
 <div align="center">
-  <img width="900" alt="image" src="./Images/flowchart.jpg">
+  <img width="800" alt="image" src="./Images/flowchart.jpg">
 </div>
 Figure 1: Flowchart showing the entire framework pipeline.
 
-### **Framework Installation and Usage**
+### Framework Installation and Usage
 <hr style="border: 1px solid black; margin: 0;">  
 
 This framework is published as a python package in PyPI (https://pypi.org/project/fimeval/).For directly using the package, the user can install this package using python package installer 'pip' and can import on their workflows:
@@ -765,7 +768,9 @@ import fimeval as fp
 ```
 **Note: The framework usage provided in detailed in [Here (docs/fimeval_usage.ipynb)](./docs/fimeval_usage.ipynb)**. It has detail documentation from installation, setup, running- until results.
 
-#### **Main Directory Structure**
+### Main Directory Structure
+<hr style="border: 1px solid black; margin: 0;">  
+
 The main directory contains the primary folder for storing the  case studies. If there is one case study, user can directly pass the case study folder as the main directory. Each case study folder must include a Benchmark FIM (B-FIM)  with a 'benchmark' word  assigned within the B-FIM file and different Model Predicted FIM (M-FIM)
 in tif format. 
 For mutilple case studies,the main directory could be structure in such a way that contain the seperate folders for individual case studies.For example, if a user has two case studies they should create two seperate folders as shown in the Figure below.
@@ -780,13 +785,13 @@ main_dir = Path('./path/to/main/dir')
 ```
 
 #### **Permanent Water Bodies (PWB)**
-This framework uses PWB to first to delineate the PWB in the FIM and assign into different class so that the evaluation will be more fair. For the Contiguous United States (CONUS), the PWB is already integrated within the framework however, if user have more accurate PWB or using fimeval for outside US they can initialize and use PWB within fimeval framework. Currently it is using PWB publicly hosted by ESRI: https://hub.arcgis.com/datasets/esri::usa-detailed-water-bodies/about
+This framework uses PWB to first to delineate the PWB in the FIM and assign into different class so that the evaluation will be more fair. For the Contiguous United States (CONUS), the PWB is already integrated within the framework however, if user have more accurate PWB or using fimeval for outside US they can initialize and use PWB within fimeval framework. Currently it is using PWB publicly hosted by ESRI through REST API: https://hub.arcgis.com/datasets/esri::usa-detailed-water-bodies/about
 
 If user have more precise PWB, they can input their own PWB boundary as .shp and .gpkg format and need to assign the shapefile of the PWB and define directory as,
 ```bash
 PWD_dir = Path('./path/to/PWB/vector/file')
 ```
-#### **Methods for Extracting Flood Extents**
+#### Methods for Extracting Flood Extents
 1. **```smallest_extent```**  
    The framework will first check all the raster extents (benchmark and FIMs). It will then determine the smallest among all the rasters. A shape file will then be created to mask all the rasters.
 
@@ -816,7 +821,7 @@ method_name = "AOI"
 AOI  = Path('./path/to/AOI/vectorfile')
 ```
 
-#### **Executing the Evaluation framework**
+#### Executing the Evaluation framework
 The complete description of different modules, what they are meant for, arguments taken to run that module and what will be the end results from each is described in below **Table 1**. If user import `fimeval` framework as `fp` into workflows, they can call each module mentioned in **Table 1** as `fp.Module_Name(args)`. Here arguments in italic represents the optional field, depending upon the user requirement.
 
 Table 1: Modules in `fimeval` are in order of execution.
@@ -825,7 +830,7 @@ Table 1: Modules in `fimeval` are in order of execution.
 | `EvaluateFIM` | It runs all the evaluation of FIM between B-FIM and M-FIMs. | `main_dir`: Main directory containing the case study folders, <br> `method_name`: How users wants to evaluate their FIM, <br> `outpur_dir`: Output directory where all the results and the intermidiate files will be saved for further calculation, <br>  *`PWB_dir`*: The permanenet water bodies vectory file directory if user wants to user their own boundary, <br> *`target_crs`*: this fimeval framework needs the floodmaps to be in projected CRS so define the projected CRS in epsg code format, <br> *`target_resolution`*: sometime if the benchmark is very high resolution than candidate FIMs, it needs heavy computational time, so user can define the resolution if there FIMs are in different spatial resolution, else it will use the coarser resolution among all FIMS within that case. |The outputs includes generated files in TIFF, SHP, CSV, and PNG formats, all stored within the output folder. Users can visualize the TIFF files using any geospatial platform. The TIFF files consist of the binary Benchmark-FIM (Benchmark.tif), Model-FIM (Candidate.tif), and Agreement-FIM (Contingency.tif). The shp files contain the boundary of the generated flood extent.|
 | `PlotContingencyMap` | For better understanding, It will print the agreement maps derived in first step. | `main_dir`, `method_name`, `output_dir` : Based on the those arguments, once all the evaluation is done, it will dynamically get the corresponding contingency raster for printing.| This prints the contingency map showing different class of evaluation (TP, FP, no data, PWB etc). The outputs look like- Figure 4 first row.|
 | `PlotEvaluationMetrics` | For quick understanding of the evaluation metrics, to plot bar of evaluation scores. | `main_dir`, `method_name`, `output_dir` : Based on the those arguments, once all the evaluation is done, it will dynamically get the corresponding file for printing based on all those info.| This prints the bar plots which includes different performance metrics calculated by EvaluateFIM module. The outputs look like- Figure 4 second row.|
-| `EvaluationWithBuildingFootprint` | For Building Footprint Analysis, user can specify shapefile of building footprints as .shp or .gpkg format. By default it consider global Microsoft building footprint dataset. Those data are hosted in Google Earth Engine (GEE) so, It pops up to authenticate the GEE account, please allow it and it will download the data based on evaluation boundary and evaluation is done. | `main_dir`, `method_name`, `output_dir`: Those arguments are as it is, same as all other modules. <br> *`building_footprint`*: If user wants to use their own building footprint file then pass the directory here, *`country`*: It is the 3 letter based country ISO code (eg. 'USA', NEP' etc), for the building data automation using GEE based on the evaluation extent, *`shapefile_dir`*: this is the directory of user defined AOI if user is working with their own boundary and automatic Building footprint download and evaluation, *`geeprojectID`*: this is the google earth engine google cloud project ID, which helps to access the GEE data and resources to work with building footprint download and process. | It will calculate the different metrics (e.g. TP, FP, CSI, F1, Accuracy etc) based on hit and miss of building on different M-FIM and B-FIM. Those all metrics will be saved as CSV format in `output_dir` and finally using that info it prints the counts of building foorpint in each FIMs as well as scenario on the evaluation end via bar plot.|
+| `EvaluationWithBuildingFootprint` | For Building Footprint Analysis, user can specify shapefile of building footprints as .shp or .gpkg format. By default it consider global Microsoft building footprint dataset hosted in ArcGIS Online. It is seamlessly integrated within framework through ArcGIS REST API. | `main_dir`, `method_name`, `output_dir`: Those arguments are as it is, same as all other modules. <br> *`building_footprint`*: If user wants to use their own building footprint file then pass the directory here, *`shapefile_dir`*: this is the directory of user defined AOI if user is working with their own boundary and automatic Building footprint download and evaluation,| It will calculate the different metrics (e.g. TP, FP, CSI, F1, Accuracy etc) based on hit and miss of building on different M-FIM and B-FIM. Those all metrics will be saved as CSV format in `output_dir` and finally using that info it prints the counts of building foorpint in each FIMs as well as scenario on the evaluation end via bar plot.|
 
 <p align="center">
   <img src="./Images/methodsresults_combined.jpg" width="750" />
@@ -834,8 +839,9 @@ Table 1: Modules in `fimeval` are in order of execution.
 Figure 4: Combined raw output from framework for different two method. First row (subplot a and b) and second row (subplot c and d) is contingency maps and evaluation metrics of FIM derived using `PrintContingencyMaP` and `PlotEvaluationMetrics` module. Third row (subplot e and f) is the output after processing and calculating of evaluation with BF by unsing `EvaluateWithBuildingFoorprint` module.
 
 ## Installation Instructions
+<hr style="border: 1px solid black; margin: 0;">  
 
-### 1. Prerequisites
+#### 1. Prerequisites
 
 Before installing `fimeval`, ensure the following software are installed:
 
@@ -849,13 +855,13 @@ Before installing `fimeval`, ensure the following software are installed:
 
 ---
 
-### 2. Install Anaconda
+#### 2. Install Anaconda
 
 If Anaconda is not installed, download and install it from the [official website](https://www.anaconda.com/products/distribution).
 
 ---
 
-### 3. Set Up Virtual Environment
+#### 3. Set Up Virtual Environment
 
 #### For Mac Users
 
@@ -873,25 +879,43 @@ uv pip install fimeval
 ```
 
 ### Google Colab Version
+<hr style="border: 1px solid black; margin: 0;">  
 
 To use fimeval in Google Colab, follow the steps below:
 
-## Upload Files
+#### Upload Files
 Upload all necessary input files (e.g., raster, shapefiles, model outputs) to your Google Drive.
-## Open Google Colab
+#### Open Google Colab
 Go to Google Colab and sign in with a valid Google account.
-## Mount Google Drive
+#### Mount Google Drive
 In a new Colab notebook, mount the  Google Drive
 ```bash
 pip install fimeval
 ```
-### **Acknowledgements**
+### Citing our work
+<hr style="border: 1px solid black; margin: 0;">  
+
+- Devi, D., Dipsikha, Supath Dhital, Dinuke Munasinghe, Sagy Cohen, Anupal Baruah, Yixian Chen, Dan Tian, & Carson Pruitt (2025).  
+  *A framework for the evaluation of flood inundation predictions over extensive benchmark databases.*  
+  **Environmental Modelling & Software**, 106786.  
+  https://doi.org/10.1016/j.envsoft.2025.106786
+
+- Cohen, S., Baruah, A., Nikrou, P., Tian, D., & Liu, H. (2025). 
+  *Toward robust evaluations of flood inundation predictions using remote sensing–derived benchmark maps.*  
+  **Water Resources Research**, 61(8).  
+  https://doi.org/10.1029/2024WR039574
+
+### Acknowledgements
+<hr style="border: 1px solid black; margin: 0;">  
+
 | | |
 | --- | --- |
 | ![alt text](https://ciroh.ua.edu/wp-content/uploads/2022/08/CIROHLogo_200x200.png) | Funding for this project was provided by the National Oceanic & Atmospheric Administration (NOAA), awarded to the Cooperative Institute for Research to Operations in Hydrology (CIROH) through the NOAA Cooperative Agreement with The University of Alabama.
 
-### **For More Information**
+### For More Information
+
 Contact <a href="https://geography.ua.edu/people/sagy-cohen/" target="_blank">Sagy Cohen</a>
  (sagy.cohen@ua.edu)
+ Supath Dhital, (sdhital@crimson.ua.edu)
  Dipsikha Devi, (ddevi@ua.edu)
-Supath Dhital, (sdhital@crimson.ua.edu)
+

{fimeval-0.1.56 → fimeval-0.1.58}/README.md

@@ -21,7 +21,7 @@ To address these issues, we developed Flood Inundation Mapping Prediction Evalua
 
 
 
-### **Repository structure**
+### Repository structure
 <hr style="border: 1px solid black; margin: 0;">  
 
 The architecture of the ```fimeval``` integrates different modules to which helps the automation of flood evaluation. All those modules codes are in source (```src``` ) folder.
@@ -30,11 +30,15 @@ fimeval/
 ├── docs/                       # Documentation (contains 'FIMserv' Tool usage sample codes)
 │   └── sampledata/              # Contains the sample data to demonstrate how this frameworks works    
 │   └── fimeval_usage.ipynb            #Sample code usage of the Evaluation framework
+│   └── fimbench_usage.ipynb           #Sample code usage of the FIMbench Query and getting benchmark dataset
 ├── Images/                       # have sample images for documentation       
 ├── src/
-│   └── fimeval/         
+│   └── fimeval/    
+│       ├──BenchFIMQuery/   #Module to interact with the extensive FIMdatabase, hosted in AWS S3
+│       │   └── access_benchfim.py   #Different classes to query right benchmark FIM for any given location and set of filter
+│       │   └── utilis.py   #Support utility      
 │       ├──BuildingFootprint/ # Contains the evaluation of model predicted FIM with microsoft building footprint
-│       │   └── microsoftBF.py 
+│       │   └── arcgis_API.py   #seamless integration of building footprint in evaluation through ArcGIS REST API
 │       │   └── evaluationwithBF.py       
 │       └── ContingencyMap/      # Contains all the metrics calculation and contingency map generation
 │       │   ├── evaluationFIM.py # main evaluation moodule 
@@ -42,18 +46,18 @@ fimeval/
 │       │   └── metrics.py  # metrics calculation module
 │       │   └── plotevaluationmetrics.py  # use to vizualize the different performance metrics
 │       │   └── printcontingency.py  # prints the contingency map to quickly generate the Map layout
-│       │   └── PWBs3.py  # module which helps to get permanent water bodies from s3 bucket
+│       │   └── water_bodies.py  # module which to get permanent water bodies from s3 bucket and ArcGIS REST API
 │       └── utilis.py   #Includes the resampling and reprojection of FIMs
 └── tests/                  # Includes test cases for different functionality
 ```
 The graphical representation of fimeval pipeline can be summarized as follows in **```Figure 1```**. Here, it will show all the steps incorporated within the ```fimeval``` during packaging and all functionality are interconnected to each other, resulting the automation of the framework.
 
 <div align="center">
-  <img width="900" alt="image" src="./Images/flowchart.jpg">
+  <img width="800" alt="image" src="./Images/flowchart.jpg">
 </div>
 Figure 1: Flowchart showing the entire framework pipeline.
 
-### **Framework Installation and Usage**
+### Framework Installation and Usage
 <hr style="border: 1px solid black; margin: 0;">  
 
 This framework is published as a python package in PyPI (https://pypi.org/project/fimeval/).For directly using the package, the user can install this package using python package installer 'pip' and can import on their workflows:
@@ -74,7 +78,9 @@ import fimeval as fp
 ```
 **Note: The framework usage provided in detailed in [Here (docs/fimeval_usage.ipynb)](./docs/fimeval_usage.ipynb)**. It has detail documentation from installation, setup, running- until results.
 
-#### **Main Directory Structure**
+### Main Directory Structure
+<hr style="border: 1px solid black; margin: 0;">  
+
 The main directory contains the primary folder for storing the  case studies. If there is one case study, user can directly pass the case study folder as the main directory. Each case study folder must include a Benchmark FIM (B-FIM)  with a 'benchmark' word  assigned within the B-FIM file and different Model Predicted FIM (M-FIM)
 in tif format. 
 For mutilple case studies,the main directory could be structure in such a way that contain the seperate folders for individual case studies.For example, if a user has two case studies they should create two seperate folders as shown in the Figure below.
@@ -89,13 +95,13 @@ main_dir = Path('./path/to/main/dir')
 ```
 
 #### **Permanent Water Bodies (PWB)**
-This framework uses PWB to first to delineate the PWB in the FIM and assign into different class so that the evaluation will be more fair. For the Contiguous United States (CONUS), the PWB is already integrated within the framework however, if user have more accurate PWB or using fimeval for outside US they can initialize and use PWB within fimeval framework. Currently it is using PWB publicly hosted by ESRI: https://hub.arcgis.com/datasets/esri::usa-detailed-water-bodies/about
+This framework uses PWB to first to delineate the PWB in the FIM and assign into different class so that the evaluation will be more fair. For the Contiguous United States (CONUS), the PWB is already integrated within the framework however, if user have more accurate PWB or using fimeval for outside US they can initialize and use PWB within fimeval framework. Currently it is using PWB publicly hosted by ESRI through REST API: https://hub.arcgis.com/datasets/esri::usa-detailed-water-bodies/about
 
 If user have more precise PWB, they can input their own PWB boundary as .shp and .gpkg format and need to assign the shapefile of the PWB and define directory as,
 ```bash
 PWD_dir = Path('./path/to/PWB/vector/file')
 ```
-#### **Methods for Extracting Flood Extents**
+#### Methods for Extracting Flood Extents
 1. **```smallest_extent```**  
    The framework will first check all the raster extents (benchmark and FIMs). It will then determine the smallest among all the rasters. A shape file will then be created to mask all the rasters.
 
@@ -125,7 +131,7 @@ method_name = "AOI"
 AOI  = Path('./path/to/AOI/vectorfile')
 ```
 
-#### **Executing the Evaluation framework**
+#### Executing the Evaluation framework
 The complete description of different modules, what they are meant for, arguments taken to run that module and what will be the end results from each is described in below **Table 1**. If user import `fimeval` framework as `fp` into workflows, they can call each module mentioned in **Table 1** as `fp.Module_Name(args)`. Here arguments in italic represents the optional field, depending upon the user requirement.
 
 Table 1: Modules in `fimeval` are in order of execution.
@@ -134,7 +140,7 @@ Table 1: Modules in `fimeval` are in order of execution.
 | `EvaluateFIM` | It runs all the evaluation of FIM between B-FIM and M-FIMs. | `main_dir`: Main directory containing the case study folders, <br> `method_name`: How users wants to evaluate their FIM, <br> `outpur_dir`: Output directory where all the results and the intermidiate files will be saved for further calculation, <br>  *`PWB_dir`*: The permanenet water bodies vectory file directory if user wants to user their own boundary, <br> *`target_crs`*: this fimeval framework needs the floodmaps to be in projected CRS so define the projected CRS in epsg code format, <br> *`target_resolution`*: sometime if the benchmark is very high resolution than candidate FIMs, it needs heavy computational time, so user can define the resolution if there FIMs are in different spatial resolution, else it will use the coarser resolution among all FIMS within that case. |The outputs includes generated files in TIFF, SHP, CSV, and PNG formats, all stored within the output folder. Users can visualize the TIFF files using any geospatial platform. The TIFF files consist of the binary Benchmark-FIM (Benchmark.tif), Model-FIM (Candidate.tif), and Agreement-FIM (Contingency.tif). The shp files contain the boundary of the generated flood extent.|
 | `PlotContingencyMap` | For better understanding, It will print the agreement maps derived in first step. | `main_dir`, `method_name`, `output_dir` : Based on the those arguments, once all the evaluation is done, it will dynamically get the corresponding contingency raster for printing.| This prints the contingency map showing different class of evaluation (TP, FP, no data, PWB etc). The outputs look like- Figure 4 first row.|
 | `PlotEvaluationMetrics` | For quick understanding of the evaluation metrics, to plot bar of evaluation scores. | `main_dir`, `method_name`, `output_dir` : Based on the those arguments, once all the evaluation is done, it will dynamically get the corresponding file for printing based on all those info.| This prints the bar plots which includes different performance metrics calculated by EvaluateFIM module. The outputs look like- Figure 4 second row.|
-| `EvaluationWithBuildingFootprint` | For Building Footprint Analysis, user can specify shapefile of building footprints as .shp or .gpkg format. By default it consider global Microsoft building footprint dataset. Those data are hosted in Google Earth Engine (GEE) so, It pops up to authenticate the GEE account, please allow it and it will download the data based on evaluation boundary and evaluation is done. | `main_dir`, `method_name`, `output_dir`: Those arguments are as it is, same as all other modules. <br> *`building_footprint`*: If user wants to use their own building footprint file then pass the directory here, *`country`*: It is the 3 letter based country ISO code (eg. 'USA', NEP' etc), for the building data automation using GEE based on the evaluation extent, *`shapefile_dir`*: this is the directory of user defined AOI if user is working with their own boundary and automatic Building footprint download and evaluation, *`geeprojectID`*: this is the google earth engine google cloud project ID, which helps to access the GEE data and resources to work with building footprint download and process. | It will calculate the different metrics (e.g. TP, FP, CSI, F1, Accuracy etc) based on hit and miss of building on different M-FIM and B-FIM. Those all metrics will be saved as CSV format in `output_dir` and finally using that info it prints the counts of building foorpint in each FIMs as well as scenario on the evaluation end via bar plot.|
+| `EvaluationWithBuildingFootprint` | For Building Footprint Analysis, user can specify shapefile of building footprints as .shp or .gpkg format. By default it consider global Microsoft building footprint dataset hosted in ArcGIS Online. It is seamlessly integrated within framework through ArcGIS REST API. | `main_dir`, `method_name`, `output_dir`: Those arguments are as it is, same as all other modules. <br> *`building_footprint`*: If user wants to use their own building footprint file then pass the directory here, *`shapefile_dir`*: this is the directory of user defined AOI if user is working with their own boundary and automatic Building footprint download and evaluation,| It will calculate the different metrics (e.g. TP, FP, CSI, F1, Accuracy etc) based on hit and miss of building on different M-FIM and B-FIM. Those all metrics will be saved as CSV format in `output_dir` and finally using that info it prints the counts of building foorpint in each FIMs as well as scenario on the evaluation end via bar plot.|
 
 <p align="center">
   <img src="./Images/methodsresults_combined.jpg" width="750" />
@@ -143,8 +149,9 @@ Table 1: Modules in `fimeval` are in order of execution.
 Figure 4: Combined raw output from framework for different two method. First row (subplot a and b) and second row (subplot c and d) is contingency maps and evaluation metrics of FIM derived using `PrintContingencyMaP` and `PlotEvaluationMetrics` module. Third row (subplot e and f) is the output after processing and calculating of evaluation with BF by unsing `EvaluateWithBuildingFoorprint` module.
 
 ## Installation Instructions
+<hr style="border: 1px solid black; margin: 0;">  
 
-### 1. Prerequisites
+#### 1. Prerequisites
 
 Before installing `fimeval`, ensure the following software are installed:
 
@@ -158,13 +165,13 @@ Before installing `fimeval`, ensure the following software are installed:
 
 ---
 
-### 2. Install Anaconda
+#### 2. Install Anaconda
 
 If Anaconda is not installed, download and install it from the [official website](https://www.anaconda.com/products/distribution).
 
 ---
 
-### 3. Set Up Virtual Environment
+#### 3. Set Up Virtual Environment
 
 #### For Mac Users
 
@@ -182,25 +189,43 @@ uv pip install fimeval
 ```
 
 ### Google Colab Version
+<hr style="border: 1px solid black; margin: 0;">  
 
 To use fimeval in Google Colab, follow the steps below:
 
-## Upload Files
+#### Upload Files
 Upload all necessary input files (e.g., raster, shapefiles, model outputs) to your Google Drive.
-## Open Google Colab
+#### Open Google Colab
 Go to Google Colab and sign in with a valid Google account.
-## Mount Google Drive
+#### Mount Google Drive
 In a new Colab notebook, mount the  Google Drive
 ```bash
 pip install fimeval
 ```
-### **Acknowledgements**
+### Citing our work
+<hr style="border: 1px solid black; margin: 0;">  
+
+- Devi, D., Dipsikha, Supath Dhital, Dinuke Munasinghe, Sagy Cohen, Anupal Baruah, Yixian Chen, Dan Tian, & Carson Pruitt (2025).  
+  *A framework for the evaluation of flood inundation predictions over extensive benchmark databases.*  
+  **Environmental Modelling & Software**, 106786.  
+  https://doi.org/10.1016/j.envsoft.2025.106786
+
+- Cohen, S., Baruah, A., Nikrou, P., Tian, D., & Liu, H. (2025). 
+  *Toward robust evaluations of flood inundation predictions using remote sensing–derived benchmark maps.*  
+  **Water Resources Research**, 61(8).  
+  https://doi.org/10.1029/2024WR039574
+
+### Acknowledgements
+<hr style="border: 1px solid black; margin: 0;">  
+
 | | |
 | --- | --- |
 | ![alt text](https://ciroh.ua.edu/wp-content/uploads/2022/08/CIROHLogo_200x200.png) | Funding for this project was provided by the National Oceanic & Atmospheric Administration (NOAA), awarded to the Cooperative Institute for Research to Operations in Hydrology (CIROH) through the NOAA Cooperative Agreement with The University of Alabama.
 
-### **For More Information**
+### For More Information
+
 Contact <a href="https://geography.ua.edu/people/sagy-cohen/" target="_blank">Sagy Cohen</a>
  (sagy.cohen@ua.edu)
+ Supath Dhital, (sdhital@crimson.ua.edu)
  Dipsikha Devi, (ddevi@ua.edu)
-Supath Dhital, (sdhital@crimson.ua.edu)
+

{fimeval-0.1.56 → fimeval-0.1.58}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fimeval"
-version = "0.1.56"
+version = "0.1.58"
 description = "A Framework for Automatic Evaluation of Flood Inundation Mapping Predictions Evaluation"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -28,9 +28,8 @@ dependencies = [
   "nbformat>=5.10.4,<6.0.0",
   "pyproj>=3.7.0,<4.0.0",
   "notebook>=7.3.2,<8.0.0",
-  "boto3>=1.36.16,<2.0.0",
+  "boto3>=1.40.0",
   "geemap",
-  "uv",
   "seaborn"
 ]
 

fimeval-0.1.58/src/fimeval/BenchFIMQuery/__init__.py

@@ -0,0 +1,5 @@
+from .access_benchfim import benchFIMquery
+
+__all__ = [
+    "benchFIMquery",
+]