[JTH] add more info to __init__s in submodules

tausiaj · tausiaj · commit c83fbf5eec91 · 2025-04-16T16:38:15.000+02:00
diff --git a/bluemath_tk/core/__init__.py b/bluemath_tk/core/__init__.py
@@ -0,0 +1,40 @@
+"""
+Project: BlueMath_tk
+Sub-Module: core
+Author: GeoOcean Research Group, Universidad de Cantabria
+Creation Date: 9 December 2024
+Repository: https://github.com/GeoOcean/BlueMath_tk.git
+Status: Under development (Working)
+"""
+
+# Import essential functions/classes to be available at the package level.
+from .dask import setup_dask_client
+from .operations import (
+    convert_lonlat_to_utm,
+    convert_utm_to_lonlat,
+    denormalize,
+    destandarize,
+    get_degrees_from_uv,
+    get_uv_components,
+    mathematical_to_nautical,
+    nautical_to_mathematical,
+    normalize,
+    spatial_gradient,
+    standarize,
+)
+
+# Optionally, define the module's `__all__` variable to control what gets imported when using `from module import *`.
+__all__ = [
+    "setup_dask_client",
+    "convert_lonlat_to_utm",
+    "convert_utm_to_lonlat",
+    "denormalize",
+    "destandarize",
+    "get_degrees_from_uv",
+    "get_uv_components",
+    "mathematical_to_nautical",
+    "nautical_to_mathematical",
+    "normalize",
+    "spatial_gradient",
+    "standarize",
+]
diff --git a/bluemath_tk/datamining/__init__.py b/bluemath_tk/datamining/__init__.py
@@ -3,7 +3,6 @@
 Sub-Module: datamining
 Author: GeoOcean Research Group, Universidad de Cantabria
 Creation Date: 19 January 2024
-License: MIT
 Repository: https://github.com/GeoOcean/BlueMath_tk.git
 Status: Under development (Working)
 """
diff --git a/bluemath_tk/datamining/_base_datamining.py b/bluemath_tk/datamining/_base_datamining.py
@@ -243,6 +243,8 @@ def plot_selected_centroids(
             sharex=False,
             sharey=False,
         )
+        if isinstance(axes, Axes):
+            axes = np.array([[axes]])
 
         for c1, v1 in enumerate(variables_names[1:]):
             for c2, v2 in enumerate(variables_names[:-1]):
diff --git a/bluemath_tk/downloaders/__init__.py b/bluemath_tk/downloaders/__init__.py
@@ -3,7 +3,6 @@
 Sub-Module: downloaders
 Author: GeoOcean Research Group, Universidad de Cantabria
 Creation Date: 9 August 2024
-License: MIT
 Repository: https://github.com/GeoOcean/BlueMath_tk.git
 Status: Under development (Working)
 """
diff --git a/bluemath_tk/interpolation/__init__.py b/bluemath_tk/interpolation/__init__.py
@@ -0,0 +1,18 @@
+"""
+Project: BlueMath_tk
+Sub-Module: interpolation
+Author: GeoOcean Research Group, Universidad de Cantabria
+Creation Date: 19 January 2025
+Repository: https://github.com/GeoOcean/BlueMath_tk.git
+Status: Under development (Working)
+"""
+
+# Import essential functions/classes to be available at the package level.
+from ._base_interpolation import BaseInterpolation
+from .rbf import RBF
+
+# Optionally, define the module's `__all__` variable to control what gets imported when using `from module import *`.
+__all__ = [
+    "BaseInterpolation",
+    "RBF",
+]
diff --git a/bluemath_tk/predictor/__init__.py b/bluemath_tk/predictor/__init__.py
@@ -2,8 +2,7 @@
 Project: BlueMath_tk
 Sub-Module: predictor
 Author: GeoOcean Research Group, Universidad de Cantabria
-Creation Date: 19 March 2024
-License: MIT
+Creation Date: 19 March 2025
 Repository: https://github.com/GeoOcean/BlueMath_tk.git
 Status: Under development (Working)
 """
diff --git a/bluemath_tk/setup/__init__.py b/bluemath_tk/setup/__init__.py
diff --git a/bluemath_tk/topo_bathy/__init__.py b/bluemath_tk/topo_bathy/__init__.py
@@ -0,0 +1,8 @@
+"""
+Project: BlueMath_tk
+Sub-Module: topo_bathy
+Author: GeoOcean Research Group, Universidad de Cantabria
+Creation Date: 19 April 2025
+Repository: https://github.com/GeoOcean/BlueMath_tk.git
+Status: Under development (Working)
+"""
diff --git a/bluemath_tk/topo_bathy/profiles.py b/bluemath_tk/topo_bathy/profiles.py
@@ -128,7 +128,7 @@ def biparabolic(h0, hsig, omega_surf_list, TR):
     hr = 1.1 * hsig + TR
 
     # Legal point
-    ha = 3 * hsig + TR
+    _ha = 3 * hsig + TR
 
     # Empirical adjusted parameters
     A = 0.21 - 0.02 * omega_surf_list
@@ -141,7 +141,7 @@ def biparabolic(h0, hsig, omega_surf_list, TR):
     h_cont = []
 
     # Important points for the profile
-    xr = (hr / A) ** (3 / 2) + (B / (A ** (3 / 2))) * hr**3
+    _xr = (hr / A) ** (3 / 2) + (B / (A ** (3 / 2))) * hr**3
 
     # Lines for the profile
     x, Xx, X, xX = [], [], [], []
diff --git a/bluemath_tk/waves/__init__.py b/bluemath_tk/waves/__init__.py
@@ -0,0 +1,28 @@
+"""
+Project: BlueMath_tk
+Sub-Module: waves
+Author: GeoOcean Research Group, Universidad de Cantabria
+Creation Date: 19 February 2025
+Repository: https://github.com/GeoOcean/BlueMath_tk.git
+Status: Under development (Working)
+"""
+
+# Import essential functions/classes to be available at the package level.
+from .binwaves import (
+    generate_swan_cases,
+    plot_selected_cases_grid,
+    plot_selected_subset_parameters,
+    process_kp_coefficients,
+    reconstruc_spectra,
+)
+from .estela import ESTELA
+
+# Optionally, define the module's `__all__` variable to control what gets imported when using `from module import *`.
+__all__ = [
+    "generate_swan_cases",
+    "reconstruc_spectra",
+    "process_kp_coefficients",
+    "plot_selected_cases_grid",
+    "plot_selected_subset_parameters",
+    "ESTELA",
+]
diff --git a/bluemath_tk/wrappers/__init__.py b/bluemath_tk/wrappers/__init__.py
@@ -3,7 +3,6 @@
 Sub-Module: wrappers
 Author: GeoOcean Research Group, Universidad de Cantabria
 Creation Date: 9 December 2024
-License: MIT
 Repository: https://github.com/GeoOcean/BlueMath_tk.git
 Status: Under development (Working)
 """

Original file line number	Diff line number	Diff line change
`@@ -243,6 +243,8 @@ def plot_selected_centroids(`
`243`	`243`	`sharex=False,`
`244`	`244`	`sharey=False,`
`245`	`245`	`)`
	`246`	`+ if isinstance(axes, Axes):`
	`247`	`+ axes = np.array([[axes]])`
`246`	`248`
`247`	`249`	`for c1, v1 in enumerate(variables_names[1:]):`
`248`	`250`	`for c2, v2 in enumerate(variables_names[:-1]):`