eo-tides 0.0.18__py3-none-any.whl → 0.0.19__py3-none-any.whl

eo_tides/model.py

@@ -9,11 +9,73 @@ import odc.geo.xr
 import pandas as pd
 import pyproj
 import pyTMD
+from pyTMD.io.model import load_database, model
 from tqdm import tqdm
 
 from eo_tides.utils import idw
 
 
+def available_models(directory=None, show_supported=True):
+    """
+    Prints a list of all tide models available for tide
+    modelling using `eo-tides`.
+
+    This function scans the specified tide model directory
+    for tide models supported by the `pyTMD` package, and
+    prints a list of models that are available in the
+    directory as well as the full list of supported models.
+
+    For instructions on setting up tide models, see:
+    <https://geoscienceaustralia.github.io/eo-tides/setup/>
+
+    Parameters
+    ----------
+    directory : str
+        Path to the directory containing tide model files.
+
+    Returns
+    -------
+    available_m : list
+        A list of all available tide models within
+        `directory`.
+    """
+    # TODO: Pull directory code into re-usable function
+
+    # Set tide modelling files directory. If no custom path is provided,
+    # first try global environmental var, then "/var/share/tide_models"
+    if directory is None:
+        if "EO_TIDES_TIDE_MODELS" in os.environ:
+            directory = os.environ["EO_TIDES_TIDE_MODELS"]
+        else:
+            directory = "/var/share/tide_models"
+
+    # Verify path exists
+    directory = pathlib.Path(directory).expanduser()
+    if not directory.exists():
+        raise FileNotFoundError("Invalid tide directory")
+
+    # Get full list of supported models from the database
+    supported_models = load_database()["elevation"].keys()
+
+    # Print list of supported models, marking available and
+    # unavailable models and appending available to list
+    print(f"Tide models available in `{directory}`:")
+    available_m = []
+    for m in supported_models:
+        try:
+            model(directory=directory).elevation(m=m)
+            # Mark available models with a green tick
+            print(f" ✅ {m}")
+            available_m.append(m)
+        except:
+            if show_supported:
+                # Mark unavailable models with a red cross
+                print(f" ❌ {m}")
+
+    # Return list of available models
+    return available_m
+
+
 def _model_tides(
     model,
     x,
@@ -411,6 +473,7 @@ def model_tides(
 
     This function is parallelised to improve performance, and
     supports all tidal models supported by `pyTMD`, including:
+
         - Empirical Ocean Tide model (`EOT20`)
         - Finite Element Solution tide models (`FES2022`, `FES2014`, `FES2012`)
         - TOPEX/POSEIDON global tide models (`TPXO10`, `TPXO9`, `TPXO8`)

{eo_tides-0.0.18.dist-info → eo_tides-0.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eo-tides
-Version: 0.0.18
+Version: 0.0.19
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Author-email: Robbi Bishop-Taylor <Robbi.BishopTaylor@ga.gov.au>
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/

eo_tides-0.0.19.dist-info/RECORD

@@ -0,0 +1,10 @@
+eo_tides/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+eo_tides/model.py,sha256=yPUioASD8_Ikm5PDdtK4DzxbzAYLeBw7HZ9v4Ol6MJk,45393
+eo_tides/stats.py,sha256=Lzo46pWUhox3ZUnMLtyLzqZ9FrCNG6nJ6iS5IpqEsy8,158
+eo_tides/utils.py,sha256=l9VXJawQzaRBYaFMsP8VBeaN5VA3rFDdzcvF7Rk04Vc,5620
+eo_tides/validation.py,sha256=kpYGHOeK-YP11c3tHt9l5_8IvOHF1SAJP79PXA7i-Vs,11434
+eo_tides-0.0.19.dist-info/LICENSE,sha256=NYULqbFuDRV6CysPbkR2WZk863YwwHeftBtnsb4cWf8,1077
+eo_tides-0.0.19.dist-info/METADATA,sha256=e1Wl1lCXvOvCp0U6smxXzU2nUEs0QtxSUGoYkmxfBV4,5335
+eo_tides-0.0.19.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+eo_tides-0.0.19.dist-info/top_level.txt,sha256=lXZDUUM1DlLdKWHRn8zdmtW8Rx-eQOIWVvt0b8VGiyQ,9
+eo_tides-0.0.19.dist-info/RECORD,,

eo_tides-0.0.18.dist-info/RECORD

@@ -1,10 +0,0 @@
-eo_tides/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-eo_tides/model.py,sha256=5teDNCgtqRyp0vJHhXMdPtZYdaKzXcAo-a9Cum46Jgg,43305
-eo_tides/stats.py,sha256=Lzo46pWUhox3ZUnMLtyLzqZ9FrCNG6nJ6iS5IpqEsy8,158
-eo_tides/utils.py,sha256=l9VXJawQzaRBYaFMsP8VBeaN5VA3rFDdzcvF7Rk04Vc,5620
-eo_tides/validation.py,sha256=kpYGHOeK-YP11c3tHt9l5_8IvOHF1SAJP79PXA7i-Vs,11434
-eo_tides-0.0.18.dist-info/LICENSE,sha256=NYULqbFuDRV6CysPbkR2WZk863YwwHeftBtnsb4cWf8,1077
-eo_tides-0.0.18.dist-info/METADATA,sha256=WLxfpg2EhN7Ly9GbNhLLFJVa2LiuO3NHckIcmjY2pqE,5335
-eo_tides-0.0.18.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-eo_tides-0.0.18.dist-info/top_level.txt,sha256=lXZDUUM1DlLdKWHRn8zdmtW8Rx-eQOIWVvt0b8VGiyQ,9
-eo_tides-0.0.18.dist-info/RECORD,,