classify the final FIM result

Author: supathdhitalGEO

.gitignore

@@ -0,0 +1,33 @@
+# Byte-compiled / cache files
+__pycache__/
+*.py[cod]
+*.so
+
+# Distribution / packaging
+build/
+*.egg-info/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Test / coverage
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Ruff
+.ruff_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Environment variables
+.env
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing to FIMserv
+
+Thank you for your interest in contributing to **FIMserv**! This tool is developed and maintained by the Surface Dynamics Modeling Lab (SDML) at The University of Alabama. Contributions of all kinds are welcome — bug reports, feature requests, documentation improvements, and code.
+
+## Getting Started
+
+1. **Fork** the repository on GitHub and clone your fork:
+
+   ```bash
+   git clone https://github.com/<your-username>/FIMserv.git
+   cd FIMserv
+   ```
+
+2. **Create a virtual environment** (recommended) and install the package in editable mode with the development dependencies:
+
+   ```bash
+   conda create --name fimserve python==3.10
+   conda activate fimserve
+
+   pip install -e ".[dev]"
+   ```
+
+3. **Create a branch** for your change:
+
+   ```bash
+   git checkout -b my-feature
+   ```
+
+## Code Style and Linting
+
+This project uses [Ruff](https://docs.astral.sh/ruff/) for linting and formatting. The configuration lives in `pyproject.toml`.
+
+Before opening a pull request, run:
+
+```bash
+# Lint the codebase (auto-fix what is safe to fix)
+ruff check src tests --fix
+
+# Format the codebase
+ruff format src tests
+```
+
+Both commands must pass cleanly for a pull request to be accepted.
+
+## Running Tests
+
+Tests are written with [pytest](https://docs.pytest.org/) and live in the `tests/` directory:
+
+```bash
+pytest
+```
+
+Please add or update tests for any code you change, and make sure the existing test suite still passes.
+
+## Submitting a Pull Request
+
+1. Keep pull requests focused — one feature or fix per PR.
+2. Write a clear description of **what** the change does and **why** it is needed.
+3. Make sure `ruff check`, `ruff format --check`, and `pytest` all pass.
+4. Reference any related issues (e.g., `Fixes #123`).
+
+## Reporting Issues
+
+Found a bug or have a feature request? Please open an issue at
+[github.com/sdmlua/FIMserv/issues](https://github.com/sdmlua/FIMserv/issues) and include:
+
+- A clear description of the problem or request
+- Steps to reproduce (for bugs), including the HUC8 ID and date range used
+- Your Python version and operating system
+
+## Contact
+
+- Dr. Sagy Cohen (sagy.cohen@ua.edu)
+- Dr. Anupal Baruah (abaruah@ua.edu)
+- Supath Dhital (sdhital@crimson.ua.edu)

README.md

@@ -7,6 +7,7 @@
     <a href="https://opensource.org/licenses/GPL-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3" /></a><br>
     <a href="https://badge.fury.io/py/fimserve"><img src="https://badge.fury.io/py/fimserve.svg?icon=si%3Apython" alt="PyPI version" /></a>
     <a href="https://pepy.tech/projects/fimserve"><img src="https://static.pepy.tech/badge/fimserve" alt="PyPI Downloads" /></a>
+    <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" /></a>
   </p>
 </div>
 
@@ -21,7 +22,7 @@
 ### **Background**
 <hr style="border: 1px solid black; margin: 0;">  
 
-OWP HAND-FIM is a national-scale operational flood forecasting framework (https://github.com/NOAA-OWP/inundation-mapping). It is a terrain-based fluvial flooding model that uses model-predicted streamflow and reach-averaged Synthetic Rating Curves (SRCs) to generate inundation extent and depth rasters at HUC-8 scale (Hydrologic Unit Code-8). The model can produce FIMs for all order streams within the watershed at a very low computational cost. This notebook streamline the FIM generation process or the OWP HAND-FIM framework on the cloud. It allow users to run over mutiple HUC-8s simultaneously. This model can run using any temporal resolution available from the input streamflow data (hourly, daily, monthly etc). ### **Currently we are hosting the FIM-4.5 and 4.8 version for Inundation Mapping.Based on user's choice HAND rasters from specific version can be called and used in FIM (Please refer to Step-1)** 
+OWP HAND-FIM is a national-scale operational flood forecasting framework (https://github.com/NOAA-OWP/inundation-mapping). It is a terrain-based fluvial flooding model that uses model-predicted streamflow and reach-averaged Synthetic Rating Curves (SRCs) to generate inundation extent and depth rasters at HUC-8 scale (Hydrologic Unit Code-8). The model can produce FIMs for all order streams within the watershed at a very low computational cost. This notebook streamline the FIM generation process or the OWP HAND-FIM framework on the cloud. It allow users to run over mutiple HUC-8s simultaneously. This model can run using any temporal resolution available from the input streamflow data (hourly, daily, monthly etc). **Currently we are hosting the FIM-4.5 and 4.8 version for Inundation Mapping.** Based on user's choice HAND rasters from specific version can be called and used in FIM (Please refer to Step-1)
 
 ### **Package structures**
 <hr style="border: 1px solid black; margin: 0;">  

dist/fimserve-0.1.2-py3-none-any.whl

@@ -1,6 +1,6 @@
 [project]
 name = "fimserve"
-version = "0.1.98"
+version = "0.1.2"
 description = "Framework which is developed with the purpose of quickly generating Flood Inundation Maps (FIM) for emergency response and risk assessment. It is developed under Surface Dynamics Modeling Lab (SDML)."
 authors = [{ name = "Supath Dhital", email = "sdhital@crimson.ua.edu" }]
 maintainers = [{ name = "Supath Dhital", email = "sdhital@crimson.ua.edu" }]
@@ -43,7 +43,7 @@ dev = [
     "pytest>=8.3,<8.4",
     "sphinx<7.0",
     "sphinx-autobuild>=2024.10.3",
-    "black"
+    "ruff>=0.15"
 ]
 
 # Install with: pip install "fimserve[sm]"
@@ -73,3 +73,15 @@ exclude = ["tests*"]
 minversion = "6.0"
 addopts = "-ra -q"
 testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 88
+extend-exclude = ["docs", "GeoGLOWS", "*.ipynb"]
+
+[tool.ruff.lint]
+# E402/F403/F405: module-level star imports and late imports are part of the
+# package's existing style. F841 fixes are unsafe and left for manual cleanup.
+ignore = ["E402", "F403", "F405", "F841"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]

dist/fimserve-0.1.2.tar.gz

@@ -1,12 +1,9 @@
 import os
-import glob
 import rasterio
 from rasterio.mask import mask
 from pathlib import Path
 import geopandas as gpd
 
-from ..datadownload import setup_directories
-
 
 def checkSHP(input_file):
     if isinstance(input_file, Path):

pyproject.toml

@@ -2,7 +2,6 @@
 import glob
 import geopandas as gpd
 from shapely.geometry import Point
-from pyproj import CRS
 import rasterio
 from rasterio.mask import mask
 

src/fimserve/FIMsubset/shpsubset.py

@@ -1,7 +1,5 @@
 import warnings
 
-from fimserve.fimevaluation.fims_setup import fim_lookup
-
 warnings.simplefilter("ignore")
 
 from .datadownload import DownloadHUC8
@@ -65,7 +63,7 @@ def getpopulation_exposure(*args, **kwargs):
 
 __all__ = [
     "DownloadHUC8",
-    "getNWMRetrospectivedata",
+    "getNWMretrospectivedata",
     "runOWPHANDFIM",
     "getNWMForecasteddata",
     "getGEOGLOWSstreamflow",

src/fimserve/FIMsubset/xycoord.py

@@ -156,7 +156,7 @@ def DownloadHUC8(huc, stream_order=None, version=None):
     EnvFile(code_dir)
     HUC_dir = os.path.join(output_dir, f"flood_{huc}")
     hydrotable_dir = os.path.join(HUC_dir, str(huc), "hydrotable.csv")
-    featureID_dir = os.path.join(HUC_dir, f"feature_IDs.csv")
+    featureID_dir = os.path.join(HUC_dir, "feature_IDs.csv")
     if stream_order is None:
         uniqueFID(hydrotable_dir, featureID_dir)
     else: