eo-tides 0.7.6.dev1__tar.gz → 0.7.6.dev2__tar.gz

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.7.6.dev1
+Version: 0.7.6.dev2
 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.dev1 → eo_tides-0.7.6.dev2}/eo_tides/model.py

@@ -81,13 +81,15 @@ def _model_tides(
     crop,
     crop_buffer,
     append_node,
+    extra_databases,
 ):
     """Worker function applied in parallel by `model_tides`. Handles the
     extraction of tide modelling constituents and tide modelling using
     `pyTMD`.
     """
-    # Obtain model details
-    pytmd_model = pyTMD.io.model(directory).elevation(model)
+    # Load models from pyTMD database
+    extra_databases = [] if extra_databases is None else extra_databases
+    pytmd_model = pyTMD.io.model(directory=directory, extra_databases=extra_databases).elevation(model)
 
     # Reproject x, y to latitude/longitude
     transformer = pyproj.Transformer.from_crs(crs, "EPSG:4326", always_xy=True)
@@ -437,6 +439,7 @@ def model_tides(
     parallel_splits: int | str = "auto",
     parallel_max: int | None = None,
     ensemble_models: list[str] | None = None,
+    extra_databases: str | os.PathLike | list | None = None,
     **ensemble_kwargs,
 ) -> pd.DataFrame:
     """
@@ -575,6 +578,11 @@ def model_tides(
         `["EOT20", "FES2012", "FES2014_extrapolated", "FES2022_extrapolated",
         "GOT4.10", "GOT5.5_extrapolated", "GOT5.6_extrapolated",
         "TPXO10-atlas-v2-nc", "TPXO8-atlas-nc", "TPXO9-atlas-v5-nc"]`.
+    extra_databases : str or path or list, optional
+        Additional custom tide model definitions to load, provided as
+        dictionaries or paths to JSON database files. Use this to
+        enable custom tide models not included with `pyTMD`.
+        See: https://pytmd.readthedocs.io/en/latest/getting_started/Getting-Started.html#model-database
     **ensemble_kwargs :
         Keyword arguments used to customise the generation of optional
         ensemble tide models if "ensemble" modelling are requested.
@@ -621,11 +629,13 @@ def model_tides(
     # provided, try global environment variable.
     directory = _set_directory(directory)
 
-    # Standardise model list, handling "all" and "ensemble" functionality
+    # Standardise model list, handling "all" and "ensemble" functionality,
+    # and any custom tide model definitions
     models_to_process, models_requested, ensemble_models = _standardise_models(
         model=model,
         directory=directory,
         ensemble_models=ensemble_models,
+        extra_databases=extra_databases,
     )
 
     # Update tide modelling func to add default keyword arguments that
@@ -642,6 +652,7 @@ def model_tides(
         crop=crop,
         crop_buffer=crop_buffer,
         append_node=append_node,
+        extra_databases=extra_databases,
     )
 
     # If automatic parallel splits, calculate optimal value

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/eo_tides/utils.py

@@ -12,11 +12,11 @@ from typing import TypeAlias
 import numpy as np
 import odc.geo
 import pandas as pd
+import pyTMD
 import xarray as xr
 from colorama import Style, init
 from odc.geo.geom import BoundingBox
 from pyTMD.io.model import load_database
-from pyTMD.io.model import model as pytmd_model
 from scipy.spatial import cKDTree as KDTree
 from tqdm import tqdm
 
@@ -80,6 +80,7 @@ def _standardise_models(
     model: str | list[str],
     directory: str | os.PathLike,
     ensemble_models: list[str] | None = None,
+    extra_databases: str | os.PathLike | list | None = None,
 ) -> tuple[list[str], list[str], list[str] | None]:
     """
     Take an input model name or list of names, and return a list
@@ -89,7 +90,7 @@ def _standardise_models(
     Handles two special values passed to `model`: "all", which
     will model tides for all models available in `directory`, and
     "ensemble", which will model tides for all models in a list
-    of custom ensemble models.
+    of ensemble models.
     """
 
     # Turn inputs into arrays for consistent handling
@@ -100,9 +101,13 @@ def _standardise_models(
     if len(duplicates) > 0:
         raise ValueError(f"The model parameter contains duplicate values: {duplicates}")
 
-    # Get full list of supported models from pyTMD database
+    # Load supported models from pyTMD database
     available_models, valid_models = list_models(
-        directory, show_available=False, show_supported=False, raise_error=True
+        directory,
+        show_available=False,
+        show_supported=False,
+        raise_error=True,
+        extra_databases=extra_databases,
     )
     custom_options = ["ensemble", "all"]
 
@@ -433,8 +438,10 @@ def clip_models(
             nc_clipped.to_netcdf(output_directory / file, mode="w")
 
         # Verify that models are ready
-        pytmd_model(directory=output_directory).elevation(m=m).verify
-        print(" ✅ Clipped model exported and verified")
+        if pyTMD.io.model(directory=output_directory).elevation(m=m).verify:
+            print(" ✅ Clipped model exported and verified")
+        else:
+            print(" ❌ Clipped model exported but unable to be verified")
 
     print(f"\nOutputs exported to {output_directory}")
     list_models(directory=output_directory, show_available=True, show_supported=False)
@@ -445,6 +452,7 @@ def list_models(
     show_available: bool = True,
     show_supported: bool = True,
     raise_error: bool = False,
+    extra_databases: str | os.PathLike | list | None = None,
 ) -> tuple[list[str], list[str]]:
     """
     List all tide models available for tide modelling.
@@ -474,6 +482,11 @@ def list_models(
     raise_error : bool, optional
         If True, raise an error if no available models are found.
         If False, raise a warning.
+    extra_databases : str or path or list, optional
+        Additional custom tide model definitions to load, provided as
+        dictionaries or paths to JSON database files. Use this to
+        enable custom tide models not included with `pyTMD`.
+        See: https://pytmd.readthedocs.io/en/latest/getting_started/Getting-Started.html#model-database
 
     Returns
     -------
@@ -488,8 +501,11 @@ def list_models(
     # provided, try global environment variable.
     directory = _set_directory(directory)
 
-    # Get full list of supported models from pyTMD database
-    model_database = load_database()["elevation"]
+    # Load supported models from pyTMD database, adding extras if required
+    extra_databases = [] if extra_databases is None else extra_databases
+    model_database = load_database(extra_databases=extra_databases)["elevation"]
+
+    # Get full list of supported models
     supported_models = list(model_database.keys())
 
     # Extract expected model paths
@@ -503,7 +519,7 @@ def list_models(
         else:
             model_file = model_file[0] if isinstance(model_file, list) else model_file
 
-        # Add path to dict
+        # Add expected path to dict, adding directory prefix
         expected_paths[m] = str(directory / pathlib.Path(model_file).expanduser().parent)
 
     # Define column widths
@@ -522,13 +538,17 @@ def list_models(
     available_models = []
     for m in supported_models:
         try:
-            model_file = pytmd_model(directory=directory).elevation(m=m)
+            # Load model
+            model_file = pyTMD.io.model(directory=directory, extra_databases=extra_databases).elevation(m=m)
+
+            # Append model to list of available model
             available_models.append(m)
 
             if show_available:
                 # Mark available models with a green tick
                 status = "✅"
                 print(f"{status:^{status_width}}│ {m:<{name_width}} │ {expected_paths[m]:<{path_width}}")
+
         except FileNotFoundError:
             if show_supported:
                 # Mark unavailable models with a red cross

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/pyproject.toml

@@ -45,7 +45,7 @@ dependencies = [
     "psutil>=5.8.0",
     "pyogrio>=0.10.0",
     "pyproj>=3.7.0",
-    "pyTMD>=2.2.2,<2.2.5",
+    "pyTMD>=2.2.5",
     "scikit-learn>=1.4.0",
     "scipy>=1.14.1",
     "shapely>=2.0.6",
@@ -97,6 +97,9 @@ source = "vcs"
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"
 
+[tool.hatch.metadata]
+allow-direct-references = true
+
 [tool.mypy]
 files = ["eo_tides"]
 python_version = "3.10"

eo_tides-0.7.6.dev2/tests/data/extra_database.json

@@ -0,0 +1,32 @@
+{
+    "elevation": {
+        "EOT20_custom": {
+            "format": "FES-netcdf",
+            "model_file": [
+                "EOT20/ocean_tides/2N2_ocean_eot20.nc",
+                "EOT20/ocean_tides/J1_ocean_eot20.nc",
+                "EOT20/ocean_tides/K1_ocean_eot20.nc",
+                "EOT20/ocean_tides/K2_ocean_eot20.nc",
+                "EOT20/ocean_tides/M2_ocean_eot20.nc",
+                "EOT20/ocean_tides/M4_ocean_eot20.nc",
+                "EOT20/ocean_tides/MF_ocean_eot20.nc",
+                "EOT20/ocean_tides/MM_ocean_eot20.nc",
+                "EOT20/ocean_tides/N2_ocean_eot20.nc",
+                "EOT20/ocean_tides/O1_ocean_eot20.nc",
+                "EOT20/ocean_tides/P1_ocean_eot20.nc",
+                "EOT20/ocean_tides/Q1_ocean_eot20.nc",
+                "EOT20/ocean_tides/S1_ocean_eot20.nc",
+                "EOT20/ocean_tides/S2_ocean_eot20.nc",
+                "EOT20/ocean_tides/SA_ocean_eot20.nc",
+                "EOT20/ocean_tides/SSA_ocean_eot20.nc",
+                "EOT20/ocean_tides/T2_ocean_eot20.nc"
+            ],
+            "name": "EOT20_custom",
+            "reference": "https://doi.org/10.17882/79489",
+            "scale": 0.01,
+            "type": "z",
+            "variable": "tide_ocean",
+            "version": "EOT20"
+        }
+    }
+}

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/tests/test_model.py

@@ -462,6 +462,67 @@ def test_model_tides_ensemble_dtype(dtype):
     assert ensemble_df.tide_height.dtype == modelled_tides_df.tide_height.dtype
 
 
+# Test listing extra_databases models from dict and file
+@pytest.mark.parametrize(
+    "extra_databases",
+    [
+        # Extra database as a JSON file
+        ["./tests/data/extra_database.json"],
+        # Extra database as a dictionary
+        [
+            {
+                "elevation": {
+                    "EOT20_custom": {
+                        "format": "FES-netcdf",
+                        "model_file": [
+                            "EOT20/ocean_tides/2N2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/J1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/K1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/K2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/M2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/M4_ocean_eot20.nc",
+                            "EOT20/ocean_tides/MF_ocean_eot20.nc",
+                            "EOT20/ocean_tides/MM_ocean_eot20.nc",
+                            "EOT20/ocean_tides/N2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/O1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/P1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/Q1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/S1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/S2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/SA_ocean_eot20.nc",
+                            "EOT20/ocean_tides/SSA_ocean_eot20.nc",
+                            "EOT20/ocean_tides/T2_ocean_eot20.nc",
+                        ],
+                        "name": "EOT20_custom",
+                        "reference": "https://doi.org/10.17882/79489",
+                        "scale": 0.01,
+                        "type": "z",
+                        "variable": "tide_ocean",
+                        "version": "EOT20",
+                    }
+                }
+            }
+        ],
+    ],
+    ids=["file", "dict"],
+)
+def test_model_tides_extra_databases(extra_databases):
+    # Run modelling for custom tide model in extra database
+    modelled_tides_df = model_tides(
+        x=[GAUGE_X],
+        y=[GAUGE_Y],
+        time=pd.date_range("2020-01-01", "2020-01-02", freq="h"),
+        model=["EOT20_custom", "EOT20"],
+        extra_databases=extra_databases,
+        output_format="wide",
+    )
+
+    # Verify custom column exists and contains data
+    assert "EOT20_custom" in modelled_tides_df
+    assert modelled_tides_df["EOT20_custom"].notna().any()
+    assert np.allclose(modelled_tides_df["EOT20_custom"], modelled_tides_df["EOT20"])
+
+
 @pytest.mark.parametrize("time_offset", ["15 min", "20 min"])
 def test_model_phases(time_offset):
     phase_df = model_phases(

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/tests/test_utils.py

@@ -6,7 +6,13 @@ import pandas as pd
 import pytest
 
 from eo_tides.model import model_tides
-from eo_tides.utils import _standardise_models, _standardise_time, clip_models, idw, list_models
+from eo_tides.utils import (
+    _standardise_models,
+    _standardise_time,
+    clip_models,
+    idw,
+    list_models,
+)
 
 
 @pytest.mark.parametrize(
@@ -16,11 +22,35 @@ from eo_tides.utils import _standardise_models, _standardise_time, clip_models,
         ("EOT20", None, ["EOT20"], ["EOT20"], None),
         (["EOT20"], None, ["EOT20"], ["EOT20"], None),
         # Case 3, 4: Using "all" to request all available models
-        ("all", None, ["EOT20", "GOT5.5", "HAMTIDE11"], ["EOT20", "GOT5.5", "HAMTIDE11"], None),
-        (["all"], None, ["EOT20", "GOT5.5", "HAMTIDE11"], ["EOT20", "GOT5.5", "HAMTIDE11"], None),
+        (
+            "all",
+            None,
+            ["EOT20", "GOT5.5", "HAMTIDE11"],
+            ["EOT20", "GOT5.5", "HAMTIDE11"],
+            None,
+        ),
+        (
+            ["all"],
+            None,
+            ["EOT20", "GOT5.5", "HAMTIDE11"],
+            ["EOT20", "GOT5.5", "HAMTIDE11"],
+            None,
+        ),
         # Case 5, 6: Using "ensemble" to model tides for specific set of ensemble models
-        ("ensemble", ["EOT20", "HAMTIDE11"], ["EOT20", "HAMTIDE11"], ["ensemble"], ["EOT20", "HAMTIDE11"]),
-        (["ensemble"], ["EOT20", "HAMTIDE11"], ["EOT20", "HAMTIDE11"], ["ensemble"], ["EOT20", "HAMTIDE11"]),
+        (
+            "ensemble",
+            ["EOT20", "HAMTIDE11"],
+            ["EOT20", "HAMTIDE11"],
+            ["ensemble"],
+            ["EOT20", "HAMTIDE11"],
+        ),
+        (
+            ["ensemble"],
+            ["EOT20", "HAMTIDE11"],
+            ["EOT20", "HAMTIDE11"],
+            ["ensemble"],
+            ["EOT20", "HAMTIDE11"],
+        ),
         # Case 7: Modelling tides using ensemble set and an additional model
         (
             ["ensemble", "GOT5.5"],
@@ -97,14 +127,44 @@ def test_clip_models():
 @pytest.mark.parametrize(
     "model, bbox, point, name",
     [
-        ("EOT20", (-166, 14, -151, 29), (19.60, -155.46), "hawaii"),  # entirely W of prime meridian
+        (
+            "EOT20",
+            (-166, 14, -151, 29),
+            (19.60, -155.46),
+            "hawaii",
+        ),  # entirely W of prime meridian
         ("EOT20", (-13, 49, 6, 60), (51.47, 0.84), "uk"),  # crossing prime meridian
-        ("EOT20", (105, -48, 160, -5), (-25.59, 153.03), "aus"),  # entirely E of prime meridian
-        ("EOT20", (-257, 7, -120, 63), (19.59, -155.45), "pacific"),  # crossing antimeridian
-        ("HAMTIDE11", (-166, 14, -151, 29), (19.60, -155.46), "hawaii"),  # entirely W of prime meridian
+        (
+            "EOT20",
+            (105, -48, 160, -5),
+            (-25.59, 153.03),
+            "aus",
+        ),  # entirely E of prime meridian
+        (
+            "EOT20",
+            (-257, 7, -120, 63),
+            (19.59, -155.45),
+            "pacific",
+        ),  # crossing antimeridian
+        (
+            "HAMTIDE11",
+            (-166, 14, -151, 29),
+            (19.60, -155.46),
+            "hawaii",
+        ),  # entirely W of prime meridian
         ("HAMTIDE11", (-13, 49, 6, 60), (51.47, 0.84), "uk"),  # crossing prime meridian
-        ("HAMTIDE11", (105, -48, 160, -5), (-25.59, 153.03), "aus"),  # entirely E of prime meridian
-        ("HAMTIDE11", (-257, 7, -120, 63), (19.59, -155.45), "pacific"),  # crossing antimeridian
+        (
+            "HAMTIDE11",
+            (105, -48, 160, -5),
+            (-25.59, 153.03),
+            "aus",
+        ),  # entirely E of prime meridian
+        (
+            "HAMTIDE11",
+            (-257, 7, -120, 63),
+            (19.59, -155.45),
+            "pacific",
+        ),  # crossing antimeridian
     ],
 )
 def test_clip_models_bbox(model, bbox, point, name):
@@ -151,11 +211,20 @@ def test_clip_models_bbox(model, bbox, point, name):
         # Case 1: None
         (None, None),
         # Case 2: Single datetime.datetime object
-        (datetime(2020, 1, 12, 21, 14), np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]")),
+        (
+            datetime(2020, 1, 12, 21, 14),
+            np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]"),
+        ),
         # Case 3: Single pandas.Timestamp
-        (pd.Timestamp("2020-01-12 21:14"), np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]")),
+        (
+            pd.Timestamp("2020-01-12 21:14"),
+            np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]"),
+        ),
         # Case 4: np.datetime64 scalar
-        (np.datetime64("2020-01-12T21:14:00"), np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]")),
+        (
+            np.datetime64("2020-01-12T21:14:00"),
+            np.array(["2020-01-12T21:14:00"], dtype="datetime64[ns]"),
+        ),
         # Case 5: 1D numpy array of np.datetime64
         (
             np.array(["2020-01-12T21:14:00", "2021-02-14T15:30:00"], dtype="datetime64[ns]"),
@@ -169,7 +238,10 @@ def test_clip_models_bbox(model, bbox, point, name):
         # Case 7: pandas.DatetimeIndex
         (
             pd.date_range(start="2000-01-01", end="2000-01-02", periods=3),
-            np.array(["2000-01-01T00:00:00", "2000-01-01T12:00:00", "2000-01-02T00:00:00"], dtype="datetime64[ns]"),
+            np.array(
+                ["2000-01-01T00:00:00", "2000-01-01T12:00:00", "2000-01-02T00:00:00"],
+                dtype="datetime64[ns]",
+            ),
         ),
         # Case 8: Mixed array with datetime.datetime and np.datetime64
         (
@@ -214,6 +286,60 @@ def test_list_models():
     assert available_models == ["EOT20", "GOT5.5", "HAMTIDE11"]
 
 
+# Test running extra_databases models from dict and file
+@pytest.mark.parametrize(
+    "extra_databases",
+    [
+        # Extra database as a JSON file
+        ["./tests/data/extra_database.json"],
+        # Extra database as a dictionary
+        [
+            {
+                "elevation": {
+                    "EOT20_custom": {
+                        "format": "FES-netcdf",
+                        "model_file": [
+                            "EOT20/ocean_tides/2N2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/J1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/K1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/K2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/M2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/M4_ocean_eot20.nc",
+                            "EOT20/ocean_tides/MF_ocean_eot20.nc",
+                            "EOT20/ocean_tides/MM_ocean_eot20.nc",
+                            "EOT20/ocean_tides/N2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/O1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/P1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/Q1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/S1_ocean_eot20.nc",
+                            "EOT20/ocean_tides/S2_ocean_eot20.nc",
+                            "EOT20/ocean_tides/SA_ocean_eot20.nc",
+                            "EOT20/ocean_tides/SSA_ocean_eot20.nc",
+                            "EOT20/ocean_tides/T2_ocean_eot20.nc",
+                        ],
+                        "name": "EOT20_custom",
+                        "reference": "https://doi.org/10.17882/79489",
+                        "scale": 0.01,
+                        "type": "z",
+                        "variable": "tide_ocean",
+                        "version": "EOT20",
+                    }
+                }
+            }
+        ],
+    ],
+    ids=["file", "dict"],
+)
+def test_list_models_extra_databases(extra_databases):
+    # Verify that custom models are added to lists of
+    # available and supported models
+    available_models, supported_models = list_models(
+        extra_databases=extra_databases,
+    )
+    assert "EOT20_custom" in available_models
+    assert "EOT20_custom" in supported_models
+
+
 # Test Inverse Distance Weighted function
 def test_idw():
     # Basic psuedo-1D example

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/tests/testing.ipynb

@@ -16,7 +16,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!pip install pyTMD==2.2.4"
+    "# !pip install pyTMD==2.2.4"
    ]
   },
   {
@@ -30,7 +30,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -55,17 +55,9 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "/home/jovyan/Robbi/eo-tides\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "cd .."
    ]
@@ -268,7 +260,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_model.py --verbose -k test_parallel_splits"
+    "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_model.py --verbose -k test_model_tides_extra_databases"
    ]
   },
   {
@@ -298,6 +290,236 @@
     "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_utils.py --verbose -k test_clip_models"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!export EO_TIDES_TIDE_MODELS=./tests/data/tide_models && pytest tests/test_utils.py --verbose -k test_list_models_extra_databases"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Tests for custom models"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pyTMD\n",
+    "\n",
+    "custom_dict = {\n",
+    "    \"format\": \"FES-netcdf\",\n",
+    "    \"model_file\": [\n",
+    "        \"EOT20/ocean_tides/2N2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/J1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/K1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/K2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/M2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/M4_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/MF_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/MM_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/N2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/O1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/P1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/Q1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/S1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/S2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/SA_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/SSA_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/T2_ocean_eot20.nc\"\n",
+    "    ],\n",
+    "    \"name\": \"EOT20_custom\",\n",
+    "    \"reference\": \"https://doi.org/10.17882/79489\",\n",
+    "    \"scale\": 0.01,\n",
+    "    \"type\": \"z\",\n",
+    "    \"variable\": \"tide_ocean\",\n",
+    "    \"version\": \"EOT20\"\n",
+    "}\n",
+    "\n",
+    "\n",
+    "\n",
+    "pyTMD.io.model(\"/gdata1/data/tide_models\").from_dict(custom_dict).to_dict()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import model def from dict\n",
+    "model = pyTMD.io.model(directory=\"/var/share/tide_models/\").from_dict(custom_dict)\n",
+    "assert model.verify\n",
+    "\n",
+    "# Read tidal constants and interpolate to grid points\n",
+    "amp, ph, c = model.extract_constants(155, -32)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model.model_file"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Import model def from file\n",
+    "model = pyTMD.io.model(directory=\"/var/share/tide_models/\").from_file(\"tests/data/model_EOT20custom.json\")\n",
+    "assert model.verify\n",
+    "\n",
+    "# Read tidal constants and interpolate to grid points\n",
+    "amp, ph, c = model.extract_constants(155, -32)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model.model_file"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "model.validate_format()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "pyTMD.io.model(\"/gdata1/data/tide_models\").from_file(\"/gdata1/data/tide_models/INATIDES/model_INATIDES.json\").to_dict()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pyTMD\n",
+    "import pandas as pd\n",
+    "from eo_tides.utils import _custom_model_definitions, list_models\n",
+    "from eo_tides.model import model_tides\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "available_models, supported_models = list_models(\n",
+    "    directory=\"/var/share/tide_models/\",\n",
+    "    custom_models=[custom_dict],\n",
+    "    show_supported=False,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "\n",
+    "custom_dict = {\n",
+    "    \"format\": \"FES-netcdf\",\n",
+    "    \"model_file\": [\n",
+    "        \"EOT20/ocean_tides/2N2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/J1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/K1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/K2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/M2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/M4_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/MF_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/MM_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/N2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/O1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/P1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/Q1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/S1_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/S2_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/SA_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/SSA_ocean_eot20.nc\",\n",
+    "        \"EOT20/ocean_tides/T2_ocean_eot20.nc\"\n",
+    "    ],\n",
+    "    \"name\": \"EOT20_custom\",\n",
+    "    \"reference\": \"https://doi.org/10.17882/79489\",\n",
+    "    \"scale\": 0.01,\n",
+    "    \"type\": \"z\",\n",
+    "    \"variable\": \"tide_ocean\",\n",
+    "    \"version\": \"EOT20\"\n",
+    "}\n",
+    "\n",
+    "\n",
+    "model_tides(\n",
+    "    x=115.313154,\n",
+    "    y=-8.668534,\n",
+    "    time=pd.date_range(\"2022-01-01\", \"2022-01-31\", freq=\"1h\"),\n",
+    "    model=\"EOT20_custom\",\n",
+    "    directory=\"/var/share/tide_models/\",\n",
+    "    custom_models=[custom_dict],\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "df = model_tides(\n",
+    "    x=115.313154,\n",
+    "    y=-8.668534,\n",
+    "    time=pd.date_range(\"2022-01-01\", \"2022-01-31\", freq=\"1h\"),\n",
+    "    model=[\"INATIDES\", \"EOT20\", \"HAMTIDE11\"],\n",
+    "    directory=\"/gdata1/data/tide_models\",\n",
+    "    custom_models=[\"/gdata1/data/tide_models/INATIDES/model_INATIDES.json\"],\n",
+    "    output_format=\"wide\",\n",
+    "    parallel=False,\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Test available tide models\n",
+    "def test_list_models_custom():\n",
+    "    # Verify that custom models are added to lists of\n",
+    "    # available and supported models\n",
+    "    available_models, supported_models = list_models(\n",
+    "        directory=\"./tests/data/tide_models\", \n",
+    "        custom_models=[\"./tests/data/model_EOT20custom.json\"],\n",
+    "    )\n",
+    "    assert \"EOT20_custom\" in available_models\n",
+    "    assert \"EOT20_custom\" in supported_models\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

{eo_tides-0.7.6.dev1 → eo_tides-0.7.6.dev2}/uv.lock

@@ -782,7 +782,7 @@ requires-dist = [
     { name = "pyogrio", specifier = ">=0.10.0" },
     { name = "pyproj", specifier = ">=3.7.0" },
     { name = "pystac-client", marker = "extra == 'notebooks'", specifier = ">=0.8.3" },
-    { name = "pytmd", specifier = ">=2.2.2,<2.2.5" },
+    { name = "pytmd", specifier = ">=2.2.5" },
     { name = "scikit-learn", specifier = ">=1.4.0" },
     { name = "scipy", specifier = ">=1.14.1" },
     { name = "shapely", specifier = ">=2.0.6" },
@@ -1881,11 +1881,11 @@ wheels = [
 
 [[package]]
 name = "narwhals"
-version = "1.43.1"
+version = "1.44.0"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/61/82/9f351a79260a6456db3f53d248268b4c3791f1e3228eec3c745e8816afd6/narwhals-1.43.1.tar.gz", hash = "sha256:6ff56d600da67a0a0980b83bd5577d076772fdba96474076ba4e76c920dbc1e5", size = 496655, upload-time = "2025-06-19T09:37:56.398Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/56/e5/0b875d29e2a4d112c58fef6aac2ed3a73bbdd4d8d0dce722fd154357248a/narwhals-1.44.0.tar.gz", hash = "sha256:8cf0616d4f6f21225b3b56fcde96ccab6d05023561a0f162402aa9b8c33ad31d", size = 499250, upload-time = "2025-06-23T08:28:08.653Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/8f/1e/b741d4eabbde95b1790e7df3c33c6b19f9b48db98a1416c6a6f06572bc66/narwhals-1.43.1-py3-none-any.whl", hash = "sha256:1ee508fa4dc0e05aa5b88717ba11613d8d9ccf0dd1e48513d4a3afb237dba9f2", size = 362737, upload-time = "2025-06-19T09:37:54.415Z" },
+    { url = "https://files.pythonhosted.org/packages/ff/fb/12f4a971467aac3cb7cbccbbfca5d0f05e23722068112c1ac4a393613ebe/narwhals-1.44.0-py3-none-any.whl", hash = "sha256:a170ea0bab4cf1f323d9f8bf17f2d7042c3d73802bea321996b39bf075d57de5", size = 365240, upload-time = "2025-06-23T08:28:06.314Z" },
 ]
 
 [[package]]
@@ -2864,7 +2864,7 @@ wheels = [
 
 [[package]]
 name = "pytmd"
-version = "2.2.4"
+version = "2.2.5"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "lxml" },
@@ -2878,9 +2878,9 @@ dependencies = [
     { name = "setuptools-scm" },
     { name = "timescale" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/72/dd/4368e24136a3964437457e84f579930ed2984073cddb3ee5683ea161d983/pytmd-2.2.4.tar.gz", hash = "sha256:0b38d499b0159209b20efd89a454c2651a44eba58cec1df3097142ae37d76d72", size = 6334322, upload-time = "2025-05-07T18:31:33.588Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/93/d4/b087234e49a1e9b206a7260f185ecf297fc1c60c49c16c07acc6859b117f/pytmd-2.2.5.tar.gz", hash = "sha256:4e969c693205607cc34577b1488c93d6191681e52bc1c04f897033b59f4403f3", size = 6335895, upload-time = "2025-06-23T16:40:28.904Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/e5/47/b0aa85b8f883ab2d92c6404acdb305d82b667fea2537db91a55ba994ccaf/pytmd-2.2.4-py3-none-any.whl", hash = "sha256:f289d8827733f8cacbb6bc2e435c58e1bb498eb37d771df60d4bbd4baca0b81d", size = 6356538, upload-time = "2025-05-07T18:31:31.338Z" },
+    { url = "https://files.pythonhosted.org/packages/cd/8c/db1e1f72ebde819e072b67a9a74b54429e5a1023d83753dd2dc9b11c7217/pytmd-2.2.5-py3-none-any.whl", hash = "sha256:2ec5ae56d98a3464bf2d05cffcef0bba2bd5f1a325068b6cbabeb90ecdbef8ec", size = 6358190, upload-time = "2025-06-23T16:40:27.054Z" },
 ]
 
 [[package]]