Changed references-documentation page from project- to module-level

EOEPCA · Aug 16, 2024 · b3b416e · b3b416e
1 parent e74fa8b
commit b3b416e
Show file tree

Hide file tree

Showing 25 changed files with 149 additions and 121 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@
 venv
 dist
 .idea
-.vscode
+.vscode
+.pre-commit-config.yaml
diff --git a/docs/design/common-library/api/reference.md → docs/design/common-library/api/base.md b/docs/design/common-library/api/reference.md → docs/design/common-library/api/base.md
@@ -1,4 +1,4 @@
-# Reference
-::: lib.lib
+# Base
+::: lib.lib.base
     options:
         show_submodules: true
diff --git a/docs/design/common-library/api/datasets.md b/docs/design/common-library/api/datasets.md
@@ -0,0 +1,4 @@
+# Datasets
+::: lib.lib.datasets
+    options:
+        show_submodules: true
diff --git a/docs/design/common-library/api/providers.md b/docs/design/common-library/api/providers.md
@@ -0,0 +1,4 @@
+# Providers
+::: lib.lib.providers
+    options:
+        show_submodules: true
diff --git a/docs/design/common-library/api/resources.md b/docs/design/common-library/api/resources.md
@@ -0,0 +1,4 @@
+# Resources
+::: lib.lib.resources
+    options:
+        show_submodules: true
diff --git a/lib/lib/base/download.py b/lib/lib/base/download.py
@@ -7,7 +7,7 @@
 
 def access_token():
     """
-        Description...
+    Description...
 
     Returns:
         (str): ...

diff --git a/lib/lib/base/file.py b/lib/lib/base/file.py
@@ -150,7 +150,7 @@ def untar_file(tar_file, remove_tar=True, create_folder=False, base_folder=None)
 
 def check_file_size(expected_file_size, file_path):
     """
-        Description...
+    Description...
 
     Parameters:
         expected_file_size: x
@@ -175,7 +175,7 @@ def check_file_size(expected_file_size, file_path):
 
 def get_file_size(file_path):
     """
-        Description...
+    Description...
 
     Parameters:
         file_path: x
@@ -194,7 +194,7 @@ def get_file_size(file_path):
 
 def get_folder_size(folder_path):
     """
-        Description...
+    Description...
 
     Parameters:
         folder_path: x
@@ -218,7 +218,7 @@ def get_folder_size(folder_path):
 
 def calculate_checksum(algorithm, check_file):
     """
-        Description...
+    Description...
 
     Parameters:
         algorithm: x
@@ -238,7 +238,7 @@ def calculate_checksum(algorithm, check_file):
 
 def delete_file(file: str):
     """
-        Description...
+    Description...
 
     Parameters:
         algorithm: x

diff --git a/lib/lib/base/geometry.py b/lib/lib/base/geometry.py
@@ -3,7 +3,7 @@
 
 def wkt_to_geom(wkt):
     """
-        Description...
+    Description...
 
     Parameters:
         wkt: x
@@ -16,7 +16,7 @@ def wkt_to_geom(wkt):
 
 def geom_to_wkt(geom):
     """
-        Description...
+    Description...
 
     Parameters:
         geom: x
@@ -29,7 +29,7 @@ def geom_to_wkt(geom):
 
 def calculate_bbox(geom):
     """
-        Description...
+    Description...
 
     Parameters:
         geom: x

diff --git a/lib/lib/base/geoparquet.py b/lib/lib/base/geoparquet.py
@@ -3,7 +3,7 @@
 
 def get_max_datetime_from_geoparquet(geoparquet, column):
     """
-        Description...
+    Description...
 
     Parameters:
         geoparquet: x

diff --git a/lib/lib/base/inventory.py b/lib/lib/base/inventory.py
@@ -9,7 +9,7 @@
 
 def update_inventory(scene_id, collection, inventory_dsn):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_id: x
@@ -52,7 +52,7 @@ def update_inventory(scene_id, collection, inventory_dsn):
 
 def get_scene_id_from_inventory_db(conn, collection, max_datetime=None):
     """
-        Description...
+    Description...
 
     Parameters:
         conn: x
@@ -85,7 +85,7 @@ def get_scene_id_from_inventory_db(conn, collection, max_datetime=None):
 
 def get_scenes_from_inventory_file(db_file, date_column="ContentDate:Start", max_datetime=None):
     """
-        Description...
+    Description...
 
     Parameters:
         db_file: x
@@ -113,7 +113,7 @@ def get_scenes_from_inventory_file(db_file, date_column="ContentDate:Start", max
 
 def get_scenes_diff(scenes_inventory, scenes_db, id_column):
     """
-        Description...
+    Description...
 
     Parameters:
         scenes_inventory: x
@@ -142,7 +142,7 @@ def get_scenes_diff(scenes_inventory, scenes_db, id_column):
 
 def get_item_from_id(scene_id, collection, api_url="https://stac.terrabyte.lrz.de/inventory/api"):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_id: x
@@ -170,7 +170,7 @@ def query_geoparquet(
     id_column="id",
 ):
     """
-        Description...
+    Description...
 
     Parameters:
         inventory: x
@@ -229,7 +229,7 @@ def query_geoparquet(
 
 def query_stac_db(cur, inventory, collection, max_datetime=None):
     """
-        Description...
+    Description...
 
     Parameters:
         cur: x
@@ -272,7 +272,7 @@ def query_stac_db(cur, inventory, collection, max_datetime=None):
 
 def query_inventory_db(cur, inventory, collection, max_datetime=None):
     """
-        Description...
+    Description...
 
     Parameters:
         cur: x
@@ -328,7 +328,7 @@ def query_inventory_db(cur, inventory, collection, max_datetime=None):
 
 def calculate_differences(collection, inventory_geoparquet, conn, id_column, date_column, max_datetime=None):
     """
-        Description...
+    Description...
 
     Parameters:
         collection: x
@@ -361,7 +361,7 @@ def calculate_differences(collection, inventory_geoparquet, conn, id_column, dat
 
 def generate_stac_new_scenes(scenes, collection, inventory_fct):
     """
-        Description...
+    Description...
 
     Parameters:
         scenes: x
@@ -385,7 +385,7 @@ def generate_stac_new_scenes(scenes, collection, inventory_fct):
 
 def import_new_scenes(scenes, collection, inventory_fct, dsn):
     """
-        Description...
+    Description...
 
     Parameters:
         scenes: x
@@ -402,7 +402,7 @@ def import_new_scenes(scenes, collection, inventory_fct, dsn):
 
 def delete_removed_scenes(collection, to_be_removed, reasons, api_url, api_user, api_pw):
     """
-        Description...
+    Description...
 
     Parameters:
         collection: x

diff --git a/lib/lib/base/order.py b/lib/lib/base/order.py
@@ -7,7 +7,7 @@
 
 def get_items_from_query(dsn, order_id, collections, where_query):
     """
-        Description...
+    Description...
 
     Parameters:
         dsn: x
@@ -31,7 +31,7 @@ def get_items_from_query(dsn, order_id, collections, where_query):
 
 def get_last_items_from_collection(dsn, order_id, collection, max_items=1000):
     """
-        Description...
+    Description...
 
     Parameters:
         dsn: x
@@ -56,7 +56,7 @@ def get_last_items_from_collection(dsn, order_id, collection, max_items=1000):
 
 def generate_batches_from_inventory(order_id, dsn, collections, where_query, batch_size=1000):
     """
-        Description...
+    Description...
 
     Parameters:
         order_id: x
@@ -99,7 +99,7 @@ def generate_batches_from_inventory(order_id, dsn, collections, where_query, bat
 
 def update_database(cur, conn, order_id, where_query, order_status="ordered"):
     """
-        Description...
+    Description...
 
     Parameters:
         cur: x
@@ -127,7 +127,7 @@ def update_database(cur, conn, order_id, where_query, order_status="ordered"):
 
 def update_database_batch(cur, conn, order_id, batch_id, where_query, batch_size):
     """
-        Description...
+    Description...
 
     Parameters:
         cur: x
@@ -161,7 +161,7 @@ def update_database_batch(cur, conn, order_id, batch_id, where_query, batch_size
 
 def get_order_from_id(scene_id, dsn):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_id: x
@@ -184,7 +184,7 @@ def get_order_from_id(scene_id, dsn):
 
 def get_items_from_order_id(order_id, collections, dsn):
     """
-        Description...
+    Description...
 
     Parameters:
         order_id: x
@@ -211,7 +211,7 @@ def get_items_from_order_id(order_id, collections, dsn):
 
 def insert_into_database(dsn, stac, method="insert_ignore"):
     """
-        Description...
+    Description...
 
     Parameters:
         dsn: x
@@ -235,7 +235,7 @@ def insert_into_database(dsn, stac, method="insert_ignore"):
 
 def get_scenes_from_batch(batch_id, collections, dsn):
     """
-        Description...
+    Description...
 
     Parameters:
         batch_id: x
@@ -275,7 +275,7 @@ def get_scenes_from_batch(batch_id, collections, dsn):
 
 def update_items_inventory_status(property, id, collection, dsn, status="pending"):
     """
-        Description...
+    Description...
 
     Parameters:
         property: x

diff --git a/lib/lib/datasets/landsat.py b/lib/lib/datasets/landsat.py
@@ -107,7 +107,7 @@
 
 def get_scene_id_info(scene_id):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_id: x
@@ -122,7 +122,7 @@ def get_scene_id_info(scene_id):
 
 def get_scene_id_folder(scene_id, folder_format=None):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_id: x
@@ -150,7 +150,7 @@ def get_scene_id_folder(scene_id, folder_format=None):
 
 def landsat_metadata(scene_path, scene_id, return_pystac=False, add_file_size=False):
     """
-        Description...
+    Description...
 
     Parameters:
         scene_path: x
@@ -204,7 +204,7 @@ def landsat_metadata(scene_path, scene_id, return_pystac=False, add_file_size=Fa
 
 def adapt_stac_metadata(scene_path):
     """
-        Changes hrefs in existing Landsat STAC-Metadata
+    Changes hrefs in existing Landsat STAC-Metadata
 
     Parameters:
         scene_path: x
@@ -265,13 +265,12 @@ def adapt_stac_metadata(scene_path):
     return stac_files
 
 
-
 __log = logging.getLogger("Log Info")
 
 
 def modify_landsat_stac(stac_item: pystac.item.Item):
     """
-        Modify the Asset-Keys and eo:bands:name for a Landsat L2 STAC-Item.
+    Modify the Asset-Keys and eo:bands:name for a Landsat L2 STAC-Item.
 
     Args:
         stac_item: The STAC item file to modify. Must be a STACObject.

diff --git a/lib/lib/datasets/modis.preview.py b/lib/lib/datasets/modis.preview.py
@@ -1,7 +1,7 @@
 import os
 from osgeo import gdal
 
-#todo: modis.preview wird von docgenerator nicht gefunden. Möglicherweise wegen . im Namen
+# todo: modis.preview wird von docgenerator nicht gefunden. Punkt im Namen müsste gegen anderes Zeichen ersetzt werden
 
 modis_previews = {
     "mod09ga": {
@@ -125,7 +125,7 @@
 
 def create_preview(infile: str, outdir: str, outres: int) -> str:
     """
-        Creates an 8-Bit RGB COG preview of the MODIS hdf infile
+    Creates an 8-Bit RGB COG preview of the MODIS hdf infile
 
     Args:
         infile (str): Path to input HDF
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,4 +7,5 @@ @@
     venv
     dist
     .idea
-    .vscode
+    .vscode
+    .pre-commit-config.yaml