eo-tides 0.6.2.dev7__py3-none-any.whl → 0.6.2.dev10__py3-none-any.whl

eo_tides/model.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 
 import os
 import textwrap
+import warnings
 from concurrent.futures import ProcessPoolExecutor
 from concurrent.futures.process import BrokenProcessPool
 from functools import partial
@@ -83,6 +84,7 @@ def _model_tides(
     cutoff,
     crop,
     crop_buffer,
+    append_node,
 ):
     """Worker function applied in parallel by `model_tides`. Handles the
     extraction of tide modelling constituents and tide modelling using
@@ -104,12 +106,12 @@ def _model_tides(
             lon,
             lat,
             type=pytmd_model.type,
-            crop=crop,
+            crop=True if crop == "auto" else crop,
             buffer=crop_buffer,
             method=method,
             extrapolate=extrapolate,
             cutoff=cutoff,
-            append_node=False,
+            append_node=append_node,
         )
 
         # TODO: Return constituents
@@ -117,16 +119,45 @@ def _model_tides(
         # print(amp.shape, ph.shape, c)
         # print(pd.DataFrame({"amplitude": amp}))
 
-    # Raise error if constituent files no not cover analysis extent
+    except ValueError:
+        # If on-the-fly cropping is auto, try again with crop turned off
+        if crop == "auto":
+            warnings.warn(
+                "On-the-fly cropping is not compatible with the provided "
+                "clipped model files; running with `crop=False`."
+            )
+
+            # Read tidal constants and interpolate to grid points
+            amp, ph, c = pytmd_model.extract_constants(
+                lon,
+                lat,
+                type=pytmd_model.type,
+                crop=False,
+                buffer=crop_buffer,
+                method=method,
+                extrapolate=extrapolate,
+                cutoff=cutoff,
+                append_node=append_node,
+            )
+
+        # Otherwise, raise error if cropping if set to True
+        else:
+            error_msg = (
+                "On-the-fly cropping (e.g. `crop=True`) is not compatible with your "
+                "provided clipped model files. Please set `crop=False` or `crop='auto'`, "
+                "or run your analysis on unclipped global model files to avoid this error."
+            )
+            raise Exception(error_msg) from None
+
+    # Raise error if constituent files do not cover analysis extent
     except IndexError:
-        error_msg = f"""
-        The {model} tide model constituent files do not cover the analysis extent
-        ({min(lon):.2f}, {max(lon):.2f}, {min(lat):.2f}, {max(lat):.2f}).
-        This can occur if you are using clipped model files to improve run times.
-        Consider using model files that cover your entire analysis area, or set `crop=False`
-        to reduce the extent of tide model constituent files that is loaded.
-        """
-        raise Exception(textwrap.dedent(error_msg).strip()) from None
+        error_msg = (
+            f"The {model} tide model constituent files do not cover the analysis extent "
+            f"({min(lon):.2f}, {max(lon):.2f}, {min(lat):.2f}, {max(lat):.2f}). "
+            "This can occur if you are using clipped model files to improve run times. "
+            "Consider using model files that cover your entire analysis area."
+        )
+        raise Exception(error_msg) from None
 
     # Calculate complex phase in radians for Euler's
     cph = -1j * ph * np.pi / 180.0
@@ -397,8 +428,9 @@ def model_tides(
     method: str = "linear",
     extrapolate: bool = True,
     cutoff: float | None = None,
-    crop: bool = True,
+    crop: bool | str = "auto",
     crop_buffer: float | None = 5,
+    append_node: bool = False,
     parallel: bool = True,
     parallel_splits: int | str = "auto",
     parallel_max: int | None = None,
@@ -503,15 +535,22 @@ def model_tides(
         Extrapolation cutoff in kilometers. The default is None, which
         will extrapolate for all points regardless of distance from the
         valid tide modelling domain.
-    crop : bool, optional
+    crop : bool or str, optional
         Whether to crop tide model constituent files on-the-fly to
-        improve performance. Defaults to True; use `crop_buffer`
-        to customise the buffer distance used to crop the files.
+        improve performance. Defaults to "auto", which will attempt to
+        apply on-the-fly cropping where possible (some clipped model
+        files restricted entirely to the western hemisphere are not
+        suitable for on-the-fly cropping). Set `crop_buffer` to
+        customise the buffer distance used to crop the files.
     crop_buffer : int or float, optional
         The buffer distance in degrees used to crop tide model
         constituent files around the modelling area. Defaults to 5,
         which will crop constituents using a five degree buffer on
         either side of the analysis extent.
+    append_node: bool, optional
+        Apply adjustments to harmonic constituents to allow for periodic
+        modulations over the 18.6-year nodal period (lunar nodal tide).
+        Default is False.
     parallel : bool, optional
         Whether to parallelise tide modelling. If multiple tide models
         are requested, these will be run in parallel. If enough workers
@@ -600,6 +639,7 @@ def model_tides(
         cutoff=np.inf if cutoff is None else cutoff,
         crop=crop,
         crop_buffer=crop_buffer,
+        append_node=append_node,
     )
 
     # If automatic parallel splits, calculate optimal value

{eo_tides-0.6.2.dev7.dist-info → eo_tides-0.6.2.dev10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.2.dev7
+Version: 0.6.2.dev10
 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

eo_tides-0.6.2.dev10.dist-info/RECORD

@@ -0,0 +1,10 @@
+eo_tides/__init__.py,sha256=pGvVlxMKiYjm_273G-oYcOgVuPra7uEdNZv0oN1i69c,1693
+eo_tides/eo.py,sha256=TuFt9SSiO9Z2o8Kr1g-wFPzofp0HTcgkfhT83zu03kc,23983
+eo_tides/model.py,sha256=EqulqgiqwzOOtBSqgPHDIX1tW3w6e-lkjF6nsjWFG1U,37173
+eo_tides/stats.py,sha256=ELQpqIH86442IYgjrGrIK3mi0-pu2ZijFw53arA2FYg,23072
+eo_tides/utils.py,sha256=T19OuPLHzaUKcovCVGANvmOiRu-L8VuDXSTzmNlA6Bo,26647
+eo_tides/validation.py,sha256=KP8WLT5z7KLFjQ9oDla7VJOyLQAK4SVbcz2ySAbsbwI,11882
+eo_tides-0.6.2.dev10.dist-info/METADATA,sha256=3_zi2dkFv8Qp85fc6L0po2yJdViJgYUanWidCLF4Wsc,8190
+eo_tides-0.6.2.dev10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+eo_tides-0.6.2.dev10.dist-info/licenses/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
+eo_tides-0.6.2.dev10.dist-info/RECORD,,

eo_tides-0.6.2.dev7.dist-info/RECORD

@@ -1,10 +0,0 @@
-eo_tides/__init__.py,sha256=pGvVlxMKiYjm_273G-oYcOgVuPra7uEdNZv0oN1i69c,1693
-eo_tides/eo.py,sha256=TuFt9SSiO9Z2o8Kr1g-wFPzofp0HTcgkfhT83zu03kc,23983
-eo_tides/model.py,sha256=JjlT5TgylqKTAw-WQ-BC4zhDL7B_QNP0fwtDyZmX9Y4,35553
-eo_tides/stats.py,sha256=ELQpqIH86442IYgjrGrIK3mi0-pu2ZijFw53arA2FYg,23072
-eo_tides/utils.py,sha256=T19OuPLHzaUKcovCVGANvmOiRu-L8VuDXSTzmNlA6Bo,26647
-eo_tides/validation.py,sha256=KP8WLT5z7KLFjQ9oDla7VJOyLQAK4SVbcz2ySAbsbwI,11882
-eo_tides-0.6.2.dev7.dist-info/METADATA,sha256=yX0vxHGViA29zRXoOljVkREx2rNVK63YFmGhrWjHWJQ,8189
-eo_tides-0.6.2.dev7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-eo_tides-0.6.2.dev7.dist-info/licenses/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
-eo_tides-0.6.2.dev7.dist-info/RECORD,,