Merge pull request #96 from GeoOcean/feature/shytcwaves

[JTH] merge first working version of shytcwaves for bulk parameters

Author: tausiaj

bluemath_tk/tc/__init__.py bluemath_tk/config/__init__.pybluemath_tk/tc/__init__.py renamed to bluemath_tk/config/__init__.py

@@ -0,0 +1,112 @@
+import os.path as op
+from typing import Dict
+
+from siphon.catalog import TDSCatalog
+
+GEOOCEAN_CLUSTER_DATA = "/lustre/geocean/DATA/"
+GEOOCEAN_THREDDS_DATA = "https://geoocean.sci.unican.es/thredds/dodsC/geoceanData/"
+
+# Default paths dictionary
+PATHS = {
+    "SHYTCWAVES_COEFS": op.join(
+        GEOOCEAN_THREDDS_DATA, "GEOOCEAN/SHyTCWaves_bulk/ibtracs_coef_pmin_wmax.nc"
+    ),
+    "SHYTCWAVES_BULK": op.join(
+        GEOOCEAN_THREDDS_DATA,
+        "GEOOCEAN/SHyTCWaves_bulk/library_shytcwaves_bulk_params_int32.nc",
+    ),
+    "SHYTCWAVES_MDA": op.join(
+        GEOOCEAN_THREDDS_DATA,
+        "GEOOCEAN/SHyTCWaves_bulk/shytcwaves_mda_indices_clean_int32.nc",
+    ),
+}
+
+
+def update_paths(new_paths: dict) -> None:
+    """
+    Update the paths dictionary with new values.
+
+    Parameters
+    ----------
+    new_paths : dict
+        Dictionary containing new path values to update.
+
+    Examples
+    --------
+    >>> update_paths({"MY_PATH": "/new/path/to/data"})
+    """
+
+    PATHS.update(new_paths)
+
+
+def get_paths() -> dict:
+    """
+    Get the paths dictionary.
+
+    Returns
+    -------
+    dict
+        Dictionary containing the paths.
+    """
+
+    return PATHS
+
+
+def get_thredds_catalog() -> TDSCatalog:
+    """
+    Get the Thredds catalog object.
+
+    Returns
+    -------
+    TDSCatalog
+        Siphon TDSCatalog object containing the catalog information.
+    """
+
+    catalog_url = (
+        "https://geoocean.sci.unican.es/thredds/catalog/geoceanData/catalog.xml"
+    )
+
+    return TDSCatalog(catalog_url)
+
+
+def get_catalog_folders() -> Dict[str, str]:
+    """
+    Get a dictionary of folder names and their links from the first level of the catalog.
+
+    Returns
+    -------
+    Dict[str, str]
+        Dictionary with folder names as keys and their catalog URLs as values.
+    """
+
+    catalog = get_thredds_catalog()
+    folders = {}
+
+    for name, ref in catalog.catalog_refs.items():
+        folders[ref.title] = ref.href
+
+    return folders
+
+
+def print_catalog_table() -> None:
+    """
+    Print a formatted table of available folders in the catalog.
+    """
+
+    folders = get_catalog_folders()
+
+    # Print header
+    print("\nAvailable Folders in GeoOcean Thredds Catalog:")
+    print("-" * 80)
+    print(f"{'Folder Name':<20} | {'Catalog URL':<40}")
+    print("-" * 80)
+
+    # Print each folder
+    for name, url in sorted(folders.items()):
+        print(f"{name:<20} | {url:<40}")
+
+    print("-" * 80)
+
+
+if __name__ == "__main__":
+    print_catalog_table()

bluemath_tk/config/paths.py

@@ -0,0 +1,2 @@
+EARTH_RADIUS = 6378.135  # Earth radius in km
+EARTH_RADIUS_NM = EARTH_RADIUS / 1.852  # Earth radius in nautical miles