eo-tides 0.6.1.dev6__tar.gz → 0.6.2.dev8__tar.gz

{eo_tides-0.6.1.dev6 → eo_tides-0.6.2.dev8}/.github/workflows/on-release-main.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Need full history for tags
+          fetch-depth: 0 # Need full history for tags
 
       - name: Export tag
         id: vars
@@ -27,12 +27,15 @@ jobs:
           RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
         if: ${{ github.event_name == 'release' }}
 
-      # For merges to main, use ".devN" suffix based on commits since tag
+      # For merges to main, incremement patch version by one
+      # and use ".devN" suffix based on commits since tag
       - name: Set dev version
         run: |
           LATEST_TAG=$(git describe --tags --abbrev=0)
+          IFS='.' read -r MAJOR MINOR PATCH <<< "$LATEST_TAG"
+          PATCH=$((PATCH + 1))
           DEV_NUM=$(git rev-list $LATEST_TAG..HEAD --count)
-          DEV_VERSION="$LATEST_TAG.dev$DEV_NUM"
+          DEV_VERSION="$MAJOR.$MINOR.$PATCH.dev$DEV_NUM"
           sed -i "s/^version = \".*\"/version = \"$DEV_VERSION\"/" pyproject.toml
         if: ${{ github.event_name == 'push' }}
 

{eo_tides-0.6.1.dev6 → eo_tides-0.6.2.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.1.dev6
+Version: 0.6.2.dev8
 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.1.dev6 → eo_tides-0.6.2.dev8}/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.1.dev6 → eo_tides-0.6.2.dev8}/pyproject.toml

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

{eo_tides-0.6.1.dev6 → eo_tides-0.6.2.dev8}/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.1.dev6 → eo_tides-0.6.2.dev8}/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"
    ]
   },
   {