Merge pull request #2 from supathdhitalGEO/main

update on readme

Author: supathdhitalGEO

README.md

@@ -1,4 +1,5 @@
 # Operational Flood Inundation Mapping(FIM) and Evaluation for CONUS
+<hr style="border: 1px solid black; margin: 0;">  
 
 [![Version](https://img.shields.io/github/v/release/sdmlua/fimserve)](https://github.com/sdmlua/fimserve/releases)
 [![Issues](https://img.shields.io/github/issues/sdmlua/fimserve)](https://github.com/sdmlua/fimserve/issues)
@@ -8,15 +9,21 @@
 
 
 ### **Flood Inundation Mapping as a Service (fimserve)**
+<hr style="border: 1px solid black; margin: 0;">  
+
 | | |
 | --- | --- |
 | <a href="https://sdml.ua.edu"><img src="https://sdml.ua.edu/wp-content/uploads/2023/01/SDML_logo_Sq_grey.png" alt="SDML Logo" width="300"></a> | This package presents a sophisticated and user friendly approach to generate Operational flood inundation map using NOAA_OWP Height Above Nearest Drainage (HAND) method-FIM model using National Water Model retrospective and forecasted streamflow data.It is developed under Surface Dynamics Modeling Lab (SDML). |
 
 
 ### **Background**
+<hr style="border: 1px solid black; margin: 0;">  
+
 NOAA-Office of Water Predictions (OWP) use HAND FIM model for operational flood forecasting across CONUS (https://github.com/NOAA-OWP/inundation-mapping). It is a terrain based model that uses the Discharge and reach avergaed synthetic rating curves (SRCs) to generate the inundation and depth rasters at HUC-8 scale (Hydrologic Unit Code-8). The model is capable to produce flood maps less than a minute for all order streams within the watershed. The HUC-8 watersheds have catchment area more than 1000 sqkm , that makes this framework scalable and computationaly efficient. It is a fluvial flood model and doesnot have urban flood compponant.The last released version of the model is 4.5and has gone through significant improvements.The present notebook is user freindly and able to run the HAND FIM model from cloud and capable of running mutiple HUC-8s simulteniously.This model can run at any temporal resolution(hourly, daily, monthly etc).It uses the NHDPlus unique river identifiers and assign the streamflow for each of the segment. 
 
 ### **Package structures**
+<hr style="border: 1px solid black; margin: 0;">  
+
 This version ([![Version](https://img.shields.io/github/v/release/sdmlua/fimserve)](https://github.com/sdmlua/fimserve/releases)) of code is available on [PyPI](https://pypi.org/project/fimserve/0.1.62/).
 ```bash
 fimserve/
@@ -37,7 +44,14 @@ fimserve/
             ├── vizualization.py (In the Local jupyter notebook, it can be used to vizualize the user defined any inundation file interactively.)
 └── tests/(includes test cases for each functionality)
 ```
+**Following is the whole structure of the framework consisting its applications and connection between different functionalities.** The right one one i.e, **b)** is the directory structure once you use this package (for eg. after using this code by following [docs/code_usage.ipynb](./docs/code_usage.ipynb)) to download and process one or multiple hucs. 
+
+<img src="https://github.com/supathdhitalGEO/fimserve/blob/main/images/flowchart.jpg"/>
+
+<em>Figure: Flow chart of the framework a) complete workflow demonstrating how framework is designed b) the directory structure on user end when user run code.</em>
 ### **Usage**
+<hr style="border: 1px solid black; margin: 0;">  
+
 To use this code, 
 
 Firstly, It is not mandatory but,
@@ -69,12 +83,16 @@ fm.DownloadHUC8(HUC)    #Like this it contains multiples functionality.
 Then there are a lot of different modules, call it to work. For reference to run, [Here (docs/code_usage.ipynb)](./docs/code_usage.ipynb) is the sample usuage of this code and different functionality. 
 
 ### **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 (#Funding ID). |
 | | We would like to acknowledge the TEEHR script developed by RTI International (https://github.com/RTIInternational/teehr). We use this script to get NWM discharge quickly.|
 
 ### **For More Information**
+<hr style="border: 1px solid black; margin: 0;">  
+
 #### **Contact**
 
 <a href="https://geography.ua.edu/people/sagy-cohen/" target="_blank">Dr. Sagy Cohen</a>