eo-tides 0.7.6.dev1__py3-none-any.whl → 0.7.6.dev3__py3-none-any.whl

eo_tides/validation.py

@@ -1,3 +1,9 @@
+"""Validation tools for comparing modelled tides to observed tide gauge data.
+
+This module provides functions for loading, filtering, and analysing
+observed tide gauge data to validate modelled tide heights.
+"""
+
 import datetime
 import warnings
 from math import sqrt
@@ -14,10 +20,8 @@ from shapely.geometry import Point
 from sklearn.metrics import mean_absolute_error, mean_squared_error
 
 
-def eval_metrics(x, y, round=3, all_regress=False):
-    """
-    Calculate a set of common statistical metrics
-    based on two input actual and predicted vectors.
+def eval_metrics(x, y, round=3, all_regress=False):  # noqa: A002
+    """Calculate common statistical validation metrics.
 
     These include:
 
@@ -46,8 +50,8 @@ def eval_metrics(x, y, round=3, all_regress=False):
     -------
     pandas.Series
         A `pd.Series` containing all calculated metrics.
-    """
 
+    """
     # Create dataframe to drop na
     xy_df = pd.DataFrame({"x": x, "y": y}).dropna()
 
@@ -77,9 +81,7 @@ def eval_metrics(x, y, round=3, all_regress=False):
 
 
 def _round_date_strings(date, round_type="end"):
-    """
-    Round a date string up or down to the start or end of a given time
-    period.
+    """Round a date string up or down to the start or end of a time period.
 
     Parameters
     ----------
@@ -107,8 +109,8 @@ def _round_date_strings(date, round_type="end"):
 
     >>> round_date_strings('2020-01', round_type='end')
     '2020-01-31 00:00:00'
-    """
 
+    """
     # Determine precision of input date string
     date_segments = len(date.split("-"))
 
@@ -194,8 +196,7 @@ def load_gauge_gesla(
     data_path="GESLA3.0_ALL",
     metadata_path="",
 ):
-    """
-    Load Global Extreme Sea Level Analysis (GESLA) tide gauge data.
+    """Load Global Extreme Sea Level Analysis (GESLA) tide gauge data.
 
     Load and process all available GESLA measured sea-level data
     with an `x, y, time` spatio-temporal query, or from a list of
@@ -259,24 +260,27 @@ def load_gauge_gesla(
         - "use_flag": Use-in-analysis flag (1 = use, 0 = do not use),
 
         ...and additional columns from station metadata.
+
     """
     # Expand and validate data and metadata paths
     data_path = Path(data_path).expanduser()
     metadata_path = Path(metadata_path).expanduser()
 
     if not data_path.exists():
-        raise FileNotFoundError(
+        err_msg = (
             f"GESLA raw data directory not found at: {data_path}\n"
             "Download 'GESLA-3 DATA' from: "
-            "https://gesla787883612.wordpress.com/downloads/"
+            "https://gesla787883612.wordpress.com/downloads/",
         )
+        raise FileNotFoundError(err_msg)
 
     if not metadata_path.exists():
-        raise FileNotFoundError(
+        err_msg = (
             f"GESLA station metadata file not found at: {metadata_path}\n"
             "Download the 'GESLA-3 CSV META-DATA FILE' from: "
-            "https://gesla787883612.wordpress.com/downloads/"
+            "https://gesla787883612.wordpress.com/downloads/",
         )
+        raise FileNotFoundError(err_msg)
 
     # Load tide gauge metadata
     metadata_df, metadata_gdf = _load_gauge_metadata(metadata_path)
@@ -297,20 +301,21 @@ def load_gauge_gesla(
             site_code = (
                 _nearest_row(metadata_gdf, x, y, max_distance).rename({"index_right": "site_code"}, axis=1).site_code
             )
-            # site_code = _nearest_row(metadata_gdf, x, y, max_distance).site_code
 
         # Raise exception if no valid tide gauges are found
-        if site_code.isnull().all():
-            raise Exception(f"No tide gauge found within {max_distance} degrees of {x}, {y}.")
+        if site_code.isna().all():
+            err_msg = f"No tide gauge found within {max_distance} degrees of {x}, {y}."
+            raise Exception(err_msg)
 
     # Otherwise if all are None, return all available site codes
     elif (site_code is None) & (x is None) & (y is None):
         site_code = metadata_df.index.to_list()
 
     else:
-        raise TypeError(
-            "`x` and `y` must be provided as either singular coordinates (e.g. `x=150`), or as a tuple bounding box (e.g. `x=(150, 152)`)."
+        err_msg = (
+            "`x` and `y` must be provided as either singular coordinates (e.g. `x=150`), or as a tuple bounding box (e.g. `x=(150, 152)`).",
         )
+        raise Exception(err_msg)
 
     # Prepare times
     if time is None:
@@ -342,7 +347,7 @@ def load_gauge_gesla(
     data_df = data_df.set_index("time", append=True)
     duplicates = data_df.index.duplicated()
     if duplicates.sum() > 0:
-        warnings.warn("Duplicate timestamps were removed.")
+        warnings.warn("Duplicate timestamps were removed.", stacklevel=2)
         data_df = data_df.loc[~duplicates]
 
     # Remove observed mean sea level if requested

{eo_tides-0.7.6.dev1.dist-info → eo_tides-0.7.6.dev3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.7.6.dev1
+Version: 0.7.6.dev3
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
 Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides
@@ -32,7 +32,7 @@ Requires-Dist: pandas>=2.2.0
 Requires-Dist: psutil>=5.8.0
 Requires-Dist: pyogrio>=0.10.0
 Requires-Dist: pyproj>=3.7.0
-Requires-Dist: pytmd<2.2.5,>=2.2.2
+Requires-Dist: pytmd>=2.2.5
 Requires-Dist: scikit-learn>=1.4.0
 Requires-Dist: scipy>=1.14.1
 Requires-Dist: shapely>=2.0.6

eo_tides-0.7.6.dev3.dist-info/RECORD

@@ -0,0 +1,10 @@
+eo_tides/__init__.py,sha256=HYOWpUHL6oPyJimPOxeloMLyoZ66NYE8G--NPcW5B6o,1857
+eo_tides/eo.py,sha256=dihO7hOi786Ozz3XwZ4GiWaAFR2j0zx-o8x9OG9wGsQ,24336
+eo_tides/model.py,sha256=y1TZKS3C7enbfLE_UeST_1UPlnR2XtYE5mCiZrQMb2Y,39413
+eo_tides/stats.py,sha256=oKq1TQm7LIN0QYVLQaNYxgvMemko6KQHC1sV41RDCZI,23678
+eo_tides/utils.py,sha256=a9Uq5ZQWRasRbnvEY5N9H6OZNnRRck50cKkTBLs7V1Y,28578
+eo_tides/validation.py,sha256=mgJBkt1zhkDbdKvX9pJav6LKEZHoZbd972pkx-OZzgc,12856
+eo_tides-0.7.6.dev3.dist-info/METADATA,sha256=3FEOinJGnUwMCTNVkJ4sIThBY3GkatZOX6_i3trseXk,9319
+eo_tides-0.7.6.dev3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+eo_tides-0.7.6.dev3.dist-info/licenses/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
+eo_tides-0.7.6.dev3.dist-info/RECORD,,

eo_tides-0.7.6.dev1.dist-info/RECORD

@@ -1,10 +0,0 @@
-eo_tides/__init__.py,sha256=LLvX-IipE209LbYLObShRLO5vxQQYBaIP1d3TMHix24,1802
-eo_tides/eo.py,sha256=geXMd9roM7UmZCHK7l7bUUXai2pXGDJdzgAw4GBJ_58,23944
-eo_tides/model.py,sha256=SWqBr0ajin1gw37nYa8ukHHzeiebK5h8XvkXO9LMX4E,37480
-eo_tides/stats.py,sha256=lvl9-0k20ffLQh8Y1kAC_afhjQviK11_3_saRUtX3ws,23009
-eo_tides/utils.py,sha256=wfzJFjWrJVgN8TqRqvwE8Tbtb2WPUQRwmCsihb5j3jc,26625
-eo_tides/validation.py,sha256=6ugPwhNglIovOVTaozZnAiLaIBqU5acOiVmFPHvFDHE,12657
-eo_tides-0.7.6.dev1.dist-info/METADATA,sha256=Xv-Yg8N-7ZY6DljJFXro-w6JjUEAK75SszzogU_wHNE,9326
-eo_tides-0.7.6.dev1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-eo_tides-0.7.6.dev1.dist-info/licenses/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
-eo_tides-0.7.6.dev1.dist-info/RECORD,,