eo-tides 0.6.2.dev7__tar.gz → 0.6.2.dev10__tar.gz

{eo_tides-0.6.2.dev7 → eo_tides-0.6.2.dev10}/PKG-INFO

@@ -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.dev7 → eo_tides-0.6.2.dev10}/docs/changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.6.2
+
+### New features
+
+- Added `apply_node` parameteter to `model_tides` to apply `pyTMD`'s adjustments to harmonic constituents to allow for periodic modulations over the 18.6-year nodal period (lunar nodal tide). Default is False.
+
+### Bug fixes
+
+- Further fixes for bug causing tide model clipping with `clip_tides` to fail for bounding boxes completely west of the prime meridian ([#50](https://github.com/GeoscienceAustralia/eo-tides/issues/50)); default value for `crop` param is now `"auto"` instead of `True`.
+
 ## v0.6.1
 
 ### Bug fixes

{eo_tides-0.6.2.dev7 → eo_tides-0.6.2.dev10}/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 → eo_tides-0.6.2.dev10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.6.2.dev7"
+version = "0.6.2.dev10"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [
     { name = "Robbi Bishop-Taylor" },

{eo_tides-0.6.2.dev7 → eo_tides-0.6.2.dev10}/tests/test_utils.py

@@ -72,7 +72,7 @@ def test_clip_models():
 
     # Set modelling location
     x, y = 122.28, -18.06
-    time = pd.date_range(start="2000-01", end="2001-03", freq="5h")
+    time = pd.date_range(start="2000-01", end="2001-02", freq="5h")
 
     # Model using unclipped vs clipped files
     df_unclipped = model_tides(
@@ -81,7 +81,7 @@ def test_clip_models():
         time=time,
         model="HAMTIDE11",
         directory=in_dir,
-        crop=False,
+        # crop=False,
     )
     df_clipped = model_tides(
         x=x,
@@ -89,7 +89,6 @@ def test_clip_models():
         time=time,
         model="HAMTIDE11",
         directory=out_dir,
-        crop=False,
     )
 
     # Verify both produce the same results
@@ -98,15 +97,15 @@ def test_clip_models():
 
 # Test clipping across multiple global locations using synthetic HAMTIDE11 data
 @pytest.mark.parametrize(
-    "bbox, name",
+    "bbox, point, name",
     [
-        ((-166, 14, -151, 29), "hawaii"),  # entirely W of prime meridian
-        ((-13, 49, 6, 60), "uk"),  # crossing prime meridian
-        ((105.292969, -47.872144, 160.312500, -5.266008), "aus"),  # entirely E of prime meridian
-        ((-256.640625, 7.013668, -119.794922, 63.391522), "pacific"),  # crossing antimeridian
+        ((-166, 14, -151, 29), (19.60, -155.46), "hawaii"),  # entirely W of prime meridian
+        ((-13, 49, 6, 60), (51.47, 0.84), "uk"),  # crossing prime meridian
+        ((105, -48, 160, -5), (-25.59, 153.03), "aus"),  # entirely E of prime meridian
+        ((-257, 7, -120, 63), (19.59, -155.45), "pacific"),  # crossing antimeridian
     ],
 )
-def test_clip_models_bbox(bbox, name):
+def test_clip_models_bbox(bbox, point, name):
     # Set input and output paths
     in_dir = "tests/data/tide_models_synthetic/"
     out_dir = f"tests/data/tide_models_synthetic_{name}/"
@@ -121,8 +120,8 @@ def test_clip_models_bbox(bbox, name):
     )
 
     # Set modelling location based on bbox centroid
-    x, y = odc.geo.geom.BoundingBox(*bbox, crs="EPSG:4326").polygon.centroid.xy
-    time = pd.date_range(start="2000-01", end="2001-03", freq="5h")
+    y, x = point
+    time = pd.date_range(start="2000-01", end="2001-02", freq="5h")
 
     # Model using unclipped vs clipped files
     df_unclipped = model_tides(
@@ -131,7 +130,6 @@ def test_clip_models_bbox(bbox, name):
         time=time,
         model="HAMTIDE11",
         directory=in_dir,
-        crop=False,
     )
     df_clipped = model_tides(
         x=x,
@@ -139,7 +137,6 @@ def test_clip_models_bbox(bbox, name):
         time=time,
         model="HAMTIDE11",
         directory=out_dir,
-        crop=False,
     )
 
     # Verify both produce the same results

{eo_tides-0.6.2.dev7 → eo_tides-0.6.2.dev10}/tests/testing.ipynb

@@ -175,7 +175,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
@@ -235,11 +235,46 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1m============================= test session starts ==============================\u001b[0m\n",
+      "platform linux -- Python 3.10.15, pytest-8.3.3, pluggy-1.5.0 -- /env/bin/python3.10\n",
+      "cachedir: .pytest_cache\n",
+      "rootdir: /home/jovyan/Robbi/eo-tides\n",
+      "configfile: pyproject.toml\n",
+      "plugins: anyio-4.6.2.post1, nbval-0.11.0\n",
+      "collected 25 items / 20 deselected / 5 selected                                \u001b[0m\u001b[1m\n",
+      "\n",
+      "tests/test_utils.py::test_clip_models \u001b[32mPASSED\u001b[0m\u001b[33m                             [ 20%]\u001b[0m\n",
+      "tests/test_utils.py::test_clip_models_bbox[bbox0-point0-hawaii] \u001b[32mPASSED\u001b[0m\u001b[33m   [ 40%]\u001b[0m\n",
+      "tests/test_utils.py::test_clip_models_bbox[bbox1-point1-uk] \u001b[32mPASSED\u001b[0m\u001b[33m       [ 60%]\u001b[0m\n",
+      "tests/test_utils.py::test_clip_models_bbox[bbox2-point2-aus] \u001b[32mPASSED\u001b[0m\u001b[33m      [ 80%]\u001b[0m\n",
+      "tests/test_utils.py::test_clip_models_bbox[bbox3-point3-pacific] \u001b[32mPASSED\u001b[0m\u001b[33m  [100%]\u001b[0m\n",
+      "\n",
+      "\u001b[33m=============================== warnings summary ===============================\u001b[0m\n",
+      "<frozen importlib._bootstrap>:241\n",
+      "  <frozen importlib._bootstrap>:241: RuntimeWarning: numpy.ndarray size changed, may indicate binary incompatibility. Expected 16 from C header, got 96 from PyObject\n",
+      "\n",
+      "tests/test_utils.py: 20 warnings\n",
+      "  /env/lib/python3.10/site-packages/pyproj/transformer.py:817: DeprecationWarning: Conversion of an array with ndim > 0 to a scalar is deprecated, and will error in future. Ensure you extract a single element from your array before performing this operation. (Deprecated NumPy 1.25.)\n",
+      "    return self._transformer._transform_point(\n",
+      "\n",
+      "tests/test_utils.py::test_clip_models_bbox[bbox0-point0-hawaii]\n",
+      "  /home/jovyan/Robbi/eo-tides/eo_tides/model.py:127: UserWarning: On-the-fly cropping is not compatible with the provided clipped model files; running with `crop=False`.\n",
+      "    warnings.warn(\"On-the-fly cropping is not compatible with the provided \"\n",
+      "\n",
+      "-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html\n",
+      "\u001b[33m================ \u001b[32m5 passed\u001b[0m, \u001b[33m\u001b[1m20 deselected\u001b[0m, \u001b[33m\u001b[1m22 warnings\u001b[0m\u001b[33m in 16.32s\u001b[0m\u001b[33m ================\u001b[0m\n"
+     ]
+    }
+   ],
    "source": [
-    "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_utils.py --verbose -k test_clip_models_bbox"
+    "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_utils.py --verbose -k test_clip_models"
    ]
   },
   {

{eo_tides-0.6.2.dev7 → eo_tides-0.6.2.dev10}/uv.lock

@@ -574,11 +574,11 @@ wheels = [
 
 [[package]]
 name = "decorator"
-version = "5.2.0"
+version = "5.2.1"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/6e/e2/33c72e8409b39389b9a69e807e40d3466a63996ba4c65caaea1d31dfde16/decorator-5.2.0.tar.gz", hash = "sha256:1cf2ab68f8c1c7eae3895d82ab0daab41294cfbe6fbdebf50b44307299980762", size = 16973 }
+sdist = { url = "https://files.pythonhosted.org/packages/43/fa/6d96a0978d19e17b68d634497769987b16c8f4cd0a7a05048bec693caa6b/decorator-5.2.1.tar.gz", hash = "sha256:65f266143752f734b0a7cc83c46f4618af75b8c5911b00ccb61d0ac9b6da0360", size = 56711 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/f6/0e/fc5d7660912606d43f32470cf952846a47512d3674fe9a3196f1a80a638b/decorator-5.2.0-py3-none-any.whl", hash = "sha256:f30a69c066f698c7c11fa1fa3425f684d3b4b01b494ee41e73c0a14f3de48427", size = 9149 },
+    { url = "https://files.pythonhosted.org/packages/4e/8c/f3147f5c4b73e7550fe5f9352eaa956ae838d5c51eb58e7a25b9f3e2643b/decorator-5.2.1-py3-none-any.whl", hash = "sha256:d316bb415a2d9e2d2b3abcc4084c6502fc09240e292cd76a76afc106a1c8e04a", size = 9190 },
 ]
 
 [[package]]
@@ -657,7 +657,7 @@ wheels = [
 
 [[package]]
 name = "eo-tides"
-version = "0.6.1"
+version = "0.6.2"
 source = { editable = "." }
 dependencies = [
     { name = "colorama" },
@@ -1521,16 +1521,16 @@ wheels = [
 
 [[package]]
 name = "mkdocs-autorefs"
-version = "1.3.1"
+version = "1.4.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "markdown" },
     { name = "markupsafe" },
     { name = "mkdocs" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/52/f4/77e3cf5e7ba54dca168bc718688127844721982ae88b08684669c5b5752d/mkdocs_autorefs-1.3.1.tar.gz", hash = "sha256:a6d30cbcccae336d622a66c2418a3c92a8196b69782774529ad441abb23c0902", size = 2056416 }
+sdist = { url = "https://files.pythonhosted.org/packages/83/79/e846eb3323d1546b25d2ae4c957f5edf1bdfb7e0b695d43feae034c61553/mkdocs_autorefs-1.4.0.tar.gz", hash = "sha256:a9c0aa9c90edbce302c09d050a3c4cb7c76f8b7b2c98f84a7a05f53d00392156", size = 3128903 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/db/19/f20edc082c1de2987dbaf30fcc514ed7a908d465a15aba7cba595c3b245a/mkdocs_autorefs-1.3.1-py3-none-any.whl", hash = "sha256:18c504ae4d3ee7f344369bb26cb31d4105569ee252aab7d75ec2734c2c8b0474", size = 2837887 },
+    { url = "https://files.pythonhosted.org/packages/33/0e/a6ff5d3b3ac428fa8c43a356df449f366ff0dbe242dac9f87fa9d20515ed/mkdocs_autorefs-1.4.0-py3-none-any.whl", hash = "sha256:bad19f69655878d20194acd0162e29a89c3f7e6365ffe54e72aa3fd1072f240d", size = 4368332 },
 ]
 
 [[package]]
@@ -1597,7 +1597,7 @@ wheels = [
 
 [[package]]
 name = "mkdocstrings"
-version = "0.28.1"
+version = "0.28.2"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "jinja2" },
@@ -1608,9 +1608,9 @@ dependencies = [
     { name = "mkdocs-get-deps" },
     { name = "pymdown-extensions" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/82/6a/3980e05d7522423dc4ca547771d16d399fc3f4266df652f624f4f4dd7890/mkdocstrings-0.28.1.tar.gz", hash = "sha256:fb64576906771b7701e8e962fd90073650ff689e95eb86e86751a66d65ab4489", size = 4551690 }
+sdist = { url = "https://files.pythonhosted.org/packages/e8/83/5eab81d31953c725942eb663b6a4cf36ad06d803633c8e1c6ddc708af62d/mkdocstrings-0.28.2.tar.gz", hash = "sha256:9b847266d7a588ea76a8385eaebe1538278b4361c0d1ce48ed005be59f053569", size = 5691916 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/6f/5d/8580b426396d8cbbe98df364ef891487c4942e36356d56bb5a6dd91f51a9/mkdocstrings-0.28.1-py3-none-any.whl", hash = "sha256:a5878ae5cd1e26f491ff084c1f9ab995687d52d39a5c558e9b7023d0e4e0b740", size = 6426938 },
+    { url = "https://files.pythonhosted.org/packages/32/60/15ef9759431cf8e60ffda7d5bba3914cc764f2bd8e7f62e1bd301ea292e0/mkdocstrings-0.28.2-py3-none-any.whl", hash = "sha256:57f79c557e2718d217d6f6a81bf75a0de097f10e922e7e5e00f085c3f0ff6895", size = 8056702 },
 ]
 
 [package.optional-dependencies]
@@ -1620,7 +1620,7 @@ python = [
 
 [[package]]
 name = "mkdocstrings-python"
-version = "1.16.1"
+version = "1.16.2"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "griffe" },
@@ -1628,9 +1628,9 @@ dependencies = [
     { name = "mkdocstrings" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/82/a4/3475fd03f3d566ca05872cec76a86d94ead23d99bbf6a89035b924a3e9b6/mkdocstrings_python-1.16.1.tar.gz", hash = "sha256:d7152d17da74d3616a0f17df5d2da771ecf7340518c158650e5a64a0a95973f4", size = 423399 }
+sdist = { url = "https://files.pythonhosted.org/packages/ed/a9/5990642e1bb2d90b049f655b92f46d0a77acb76ed59ef3233d5a6934312e/mkdocstrings_python-1.16.2.tar.gz", hash = "sha256:942ec1a2e0481d28f96f93be3d6e343cab92a21e5baf01c37dd2d7236c4d0bd7", size = 423492 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/00/f7/433201c48d4b59208dcbae6e1481febdf732ae20ecb2aee84a4ea142f043/mkdocstrings_python-1.16.1-py3-none-any.whl", hash = "sha256:b88ff6fc6a293cee9cb42313f1cba37a2c5cdf37bcc60b241ec7ab66b5d41b58", size = 449139 },
+    { url = "https://files.pythonhosted.org/packages/82/a2/60be7e17a2f2a9d4bfb7273cdb2071eeeb65bdca5c0d07ff16df63221ca2/mkdocstrings_python-1.16.2-py3-none-any.whl", hash = "sha256:ff7e719404e59ad1a72f1afbe854769984c889b8fa043c160f6c988e1ad9e966", size = 449141 },
 ]
 
 [[package]]