Merge pull request #12 from supathdhitalGEO/main

Sphinx documentation and Preprint Citation

Author: supathdhitalGEO

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -31,6 +31,9 @@ This FIMserv framework is published as python package and published on [PyPI](ht
 ```bash
 FIMserv/
 ├── docs/                   # Documentation (contains 'FIMserv' Tool usage sample codes)
+│     ├── source/           #Contains  sphinx documentation (under development)
+│     ├──code_usage.ipynb  #Contains the detailed documentation
+│     └── FIMin3Steps.ipynb  #Focusing only on FIM generation within 3 steps  
 ├── GeoGLOWS/               # Streamflow download using GeoGLOWS hydrofabrics
 ├── src/
 │   └── fimserve/         
@@ -118,7 +121,23 @@ Use Google Colab. Here is **Detailed code Usage of FIMserv in Google Colab**: [!
 
 **Different HUC8 IDs, USGS gauge stations and flowline information that might be required to further understand/running this framework can be found in this <a href="https://ualabama.maps.arcgis.com/apps/instant/basic/index.html?appid=88789b151b50430d8e840d573225b36b" target="_blank">ArcGIS Instant App</a>.** 
 
- 
+### **Citing This Tool**
+**Using BibTex Citation**
+```
+@article{Baruah2025FIMserv,
+  author = {Anupal Baruah and Supath Dhital and Sagy Cohen and others},
+  title = {{FIMserv v.1.0: A Tool for Streamlining Flood Inundation Mapping (FIM) Using the United States Operational Hydrological Forecasting Framework}},
+  journal = {ESS Open Archive},
+  year = {2025},
+  month = {February 18},
+  doi = {10.22541/essoar.173991613.37443127/v1}
+}
+```
+**OR for other format**,
+```
+Anupal Baruah, Supath Dhital, Sagy Cohen, et al. FIMserv v.1.0: A Tool for Streamlining Flood Inundation Mapping (FIM) Using the United States Operational Hydrological Forecasting Framework. ESS Open Archive . February 18, 2025.
+DOI: 10.22541/essoar.173991613.37443127/v1
+```
 ### **Acknowledgements**
 <hr style="border: 1px solid black; margin: 0;">  
 

docs/source/FIMin3Steps.rst

@@ -0,0 +1,3 @@
+FIM in a 3 Steps
+====================================
+It takes only three steps to generate flood inundation maps using the NOAA OWP framework. First, get the HUC8 level data, get streamflow data and run the framework.

docs/source/_static/graphicaloverview.png

@@ -0,0 +1,69 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'FIMserv'
+copyright = '2025, Surface Dynamics Modeling Lab (SDML)'
+author = 'Surface Dynamics Modeling Lab (SDML)'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'python'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Remove the "Powered by Sphinx" footer
+html_show_sphinx = False
+
+# Customize the copyright footer
+html_theme_options = {
+    "footer_text": "© 2025, Surface Dynamics Modeling Lab (SDML)."
+}
+# Remove "Page source" link from the footer
+html_show_sourcelink = False

docs/source/conf.py

@@ -0,0 +1,3 @@
+Detailed functionality
+====================================
+It contains each functionality of the FIMserv framework in detail.

docs/source/detailedusage.rst

@@ -0,0 +1,3 @@
+Getting Started
+====================================
+Contains the basic information to get you started with fimserve.

docs/source/getting_started.rst

@@ -0,0 +1,22 @@
+Welcome to FIMserv's documentation!
+====================================
+
+This framework presents a streamlined, user-friendly, and cloud-enabled pipeline 
+to generate operational flood inundation maps using the NOAA Office of Water Prediction (OWP) 
+Height Above Nearest Drainage (HAND) Flood Inundation Mapping (FIM) framework. 
+It is developed under the Surface Dynamics Modeling Lab (SDML) as part of a project funded 
+by the Cooperative Institute for Research to Operations in Hydrology (CIROH).
+
+.. image:: _static/graphicaloverview.png
+   :alt: Project Logo
+   :align: center
+   :width: 1000px
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started
+   installation
+   FIMin3Steps
+   detailedusage

docs/source/index.rst

@@ -0,0 +1,3 @@
+Installation guide
+====================================
+It contains the installation guide for the FIMserv framework in local, cloud as well as for the workfolows using poetry.

docs/source/installation.rst

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd