updating documentation

docs/conf.py

@@ -1,7 +1,6 @@
 # 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:
+# For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
@@ -16,22 +15,17 @@
 
 sys.path.insert(0, os.path.abspath('..'))
 
-
 # -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'floodpy'
-copyright = '2024, Kleanthis Karamvasis'
+copyright = '2024, Kleanthis Karamvasis, Alekos Falagas'
 author = 'Kleanthis Karamvasis, Alekos Falagas'
-
-# The full version, including alpha/beta/rc tags
 release = '0.7.0'
 
-
 # -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = [
     'sphinx.ext.duration',
     'sphinx.ext.autodoc',
@@ -41,24 +35,14 @@
     'myst_parser',
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# 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 -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#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 = 'sphinx_rtd_theme'
 html_logo = '../figures/Floodpy_logo.png'
-
-# 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']

docs/floodpy.Download.eof.rst

@@ -0,0 +1,77 @@
+floodpy.Download.eof package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   floodpy.Download.eof.tests
+
+Submodules
+----------
+
+floodpy.Download.eof.asf\_client module
+---------------------------------------
+
+.. automodule:: floodpy.Download.eof.asf_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.cli module
+-------------------------------
+
+.. automodule:: floodpy.Download.eof.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.dataspace\_client module
+---------------------------------------------
+
+.. automodule:: floodpy.Download.eof.dataspace_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.download module
+------------------------------------
+
+.. automodule:: floodpy.Download.eof.download
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.log module
+-------------------------------
+
+.. automodule:: floodpy.Download.eof.log
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.parsing module
+-----------------------------------
+
+.. automodule:: floodpy.Download.eof.parsing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.products module
+------------------------------------
+
+.. automodule:: floodpy.Download.eof.products
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: floodpy.Download.eof
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/floodpy.Download.eof.tests.rst

@@ -0,0 +1,45 @@
+floodpy.Download.eof.tests package
+==================================
+
+Submodules
+----------
+
+floodpy.Download.eof.tests.test\_asf\_client module
+---------------------------------------------------
+
+.. automodule:: floodpy.Download.eof.tests.test_asf_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.tests.test\_dataspace\_client module
+---------------------------------------------------------
+
+.. automodule:: floodpy.Download.eof.tests.test_dataspace_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.tests.test\_eof module
+-------------------------------------------
+
+.. automodule:: floodpy.Download.eof.tests.test_eof
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Download.eof.tests.test\_products module
+------------------------------------------------
+
+.. automodule:: floodpy.Download.eof.tests.test_products
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: floodpy.Download.eof.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/floodpy.Download.rst

@@ -1,6 +1,14 @@
 floodpy.Download package
 ========================
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   floodpy.Download.eof
+
 Submodules
 ----------
 
@@ -20,6 +28,14 @@ floodpy.Download.Download\_GFS module
    :undoc-members:
    :show-inheritance:
 
+floodpy.Download.Download\_GFS\_precipitation module
+----------------------------------------------------
+
+.. automodule:: floodpy.Download.Download_GFS_precipitation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 floodpy.Download.Download\_LandCover module
 -------------------------------------------
 
@@ -28,10 +44,10 @@ floodpy.Download.Download\_LandCover module
    :undoc-members:
    :show-inheritance:
 
-floodpy.Download.Download\_orbits module
-----------------------------------------
+floodpy.Download.Query\_Sentinel\_1\_products module
+----------------------------------------------------
 
-.. automodule:: floodpy.Download.Download_orbits
+.. automodule:: floodpy.Download.Query_Sentinel_1_products
    :members:
    :undoc-members:
    :show-inheritance:
@@ -44,18 +60,10 @@ floodpy.Download.Sentinel\_1\_download module
    :undoc-members:
    :show-inheritance:
 
-floodpy.Download.Sentinel\_1\_download timespan module
-------------------------------------------------------
-
-.. automodule:: floodpy.Download.Sentinel_1_download timespan
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-floodpy.Download.Sentinel\_2\_download module
----------------------------------------------
+floodpy.Download.Sentinel\_1\_orbits\_download module
+-----------------------------------------------------
 
-.. automodule:: floodpy.Download.Sentinel_2_download
+.. automodule:: floodpy.Download.Sentinel_1_orbits_download
    :members:
    :undoc-members:
    :show-inheritance:

docs/floodpy.Preprocessing_S1_data.rst

@@ -4,10 +4,10 @@ floodpy.Preprocessing\_S1\_data package
 Submodules
 ----------
 
-floodpy.Preprocessing\_S1\_data.Classify\_S1\_images module
------------------------------------------------------------
+floodpy.Preprocessing\_S1\_data.DEM\_funcs module
+-------------------------------------------------
 
-.. automodule:: floodpy.Preprocessing_S1_data.Classify_S1_images
+.. automodule:: floodpy.Preprocessing_S1_data.DEM_funcs
    :members:
    :undoc-members:
    :show-inheritance:
@@ -20,6 +20,22 @@ floodpy.Preprocessing\_S1\_data.Preprocessing\_S1\_data module
    :undoc-members:
    :show-inheritance:
 
+floodpy.Preprocessing\_S1\_data.snap\_preprocessing\_funcs module
+-----------------------------------------------------------------
+
+.. automodule:: floodpy.Preprocessing_S1_data.snap_preprocessing_funcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+floodpy.Preprocessing\_S1\_data.xarray\_funcs module
+----------------------------------------------------
+
+.. automodule:: floodpy.Preprocessing_S1_data.xarray_funcs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------