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

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/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.dist-info → eo_tides-0.7.6.dev2.dist-info}/METADATA

@@ -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.dev2.dist-info/RECORD

@@ -0,0 +1,10 @@
+eo_tides/__init__.py,sha256=LLvX-IipE209LbYLObShRLO5vxQQYBaIP1d3TMHix24,1802
+eo_tides/eo.py,sha256=geXMd9roM7UmZCHK7l7bUUXai2pXGDJdzgAw4GBJ_58,23944
+eo_tides/model.py,sha256=RrR6552FDF3ZzYD38q_1J8uJo8nLAh2HUrrPoXxr6ic,38169
+eo_tides/stats.py,sha256=lvl9-0k20ffLQh8Y1kAC_afhjQviK11_3_saRUtX3ws,23009
+eo_tides/utils.py,sha256=TjAT7LcUqf4hIKXG724wcKhzXdWz-YRrZI9drax4JjU,27523
+eo_tides/validation.py,sha256=6ugPwhNglIovOVTaozZnAiLaIBqU5acOiVmFPHvFDHE,12657
+eo_tides-0.7.6.dev2.dist-info/METADATA,sha256=_A6NXJ50Dnuf7oVhtHyCqRtIoukeiNzOYb0zhePDwvc,9319
+eo_tides-0.7.6.dev2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+eo_tides-0.7.6.dev2.dist-info/licenses/LICENSE,sha256=owxWsXViCL2J6Ks3XYhot7t4Y93nstmXAT95Zf030Cc,11350
+eo_tides-0.7.6.dev2.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,,