eo-tides 0.0.23__tar.gz → 0.1.1__tar.gz

{eo_tides-0.0.23 → eo_tides-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eo-tides
-Version: 0.0.23
+Version: 0.1.1
 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/
@@ -91,6 +91,10 @@ For instructions on how to set up these models for use in `eo-tides`, refer to [
 
 To get started with `eo-tides`, follow the [Installation](https://geoscienceaustralia.github.io/eo-tides/install/) and [Setting up tide models](https://geoscienceaustralia.github.io/eo-tides/setup/) guides.
 
+## Jupyter Notebooks code examples
+
+Interactive Jupyter Notebook usage examples and more complex coastal EO case studies can be found in the [`docs/notebooks/`](https://github.com/GeoscienceAustralia/eo-tides/tree/main/docs/notebooks) directory, or [rendered in the documentation here](https://geoscienceaustralia.github.io/eo-tides/notebooks/Model_tides/).
+
 ## Citing `eo-tides`
 
 To cite `eo-tides` in your work, please use the following citation:

{eo_tides-0.0.23 → eo_tides-0.1.1}/README.md

@@ -47,6 +47,10 @@ For instructions on how to set up these models for use in `eo-tides`, refer to [
 
 To get started with `eo-tides`, follow the [Installation](https://geoscienceaustralia.github.io/eo-tides/install/) and [Setting up tide models](https://geoscienceaustralia.github.io/eo-tides/setup/) guides.
 
+## Jupyter Notebooks code examples
+
+Interactive Jupyter Notebook usage examples and more complex coastal EO case studies can be found in the [`docs/notebooks/`](https://github.com/GeoscienceAustralia/eo-tides/tree/main/docs/notebooks) directory, or [rendered in the documentation here](https://geoscienceaustralia.github.io/eo-tides/notebooks/Model_tides/).
+
 ## Citing `eo-tides`
 
 To cite `eo-tides` in your work, please use the following citation:

{eo_tides-0.0.23 → eo_tides-0.1.1}/eo_tides/model.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 
 import os
 import pathlib
+import textwrap
 import warnings
 from concurrent.futures import ProcessPoolExecutor
 from concurrent.futures.process import BrokenProcessPool
@@ -148,16 +149,19 @@ def list_models(
 
     # Raise error or warning if no models are available
     if not available_models:
-        warning_text = (
-            f"No valid tide models are available in `{directory}`. "
-            "Are you sure you have provided the correct `directory` path, "
-            "or set the `EO_TIDES_TIDE_MODELS` environment variable "
-            "to point to the location of your tide model directory?"
-        )
+        warning_msg = textwrap.dedent(
+            f"""
+            No valid tide models are available in `{directory}`.
+            Are you sure you have provided the correct `directory` path, or set the
+            `EO_TIDES_TIDE_MODELS` environment variable to point to the location of your
+            tide model directory?
+            """
+        ).strip()
+
         if raise_error:
-            raise Exception(warning_text)
+            raise Exception(warning_msg)
         else:
-            warnings.warn(warning_text, UserWarning)
+            warnings.warn(warning_msg, UserWarning)
 
     # Return list of available and supported models
     return available_models, supported_models
@@ -286,12 +290,14 @@ def _model_tides(
 
     # Raise error if constituent files no not cover analysis extent
     except IndexError:
-        error_msg = (
-            f"The {model} tide model constituent files do not cover the requested analysis extent. "
-            "This can occur if you are using clipped model files to improve run times. "
-            "Consider using model files that cover your analysis area, or set `crop=False` "
-            "to reduce the extent of tide model constituent files that is loaded."
-        )
+        error_msg = textwrap.dedent(
+            f"""
+            The {model} tide model constituent files do not cover the requested analysis extent.
+            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.
+            """
+        ).strip()
         raise Exception(error_msg)
 
     # Calculate complex phase in radians for Euler's
@@ -562,8 +568,8 @@ def model_tides(
     <https://pytmd.readthedocs.io/en/latest/getting_started/Getting-Started.html#directories>
 
     This function is a modification of the `pyTMD` package's
-    `compute_tidal_elevations` function. For more info:
-    <https://pytmd.readthedocs.io/en/latest/api_reference/compute_tidal_elevations.html>
+    `pyTMD.compute.tide_elevations` function. For more info:
+    <https://pytmd.readthedocs.io/en/latest/api_reference/compute.html#pyTMD.compute.tide_elevations>
 
     Parameters
     ----------

{eo_tides-0.0.23 → eo_tides-0.1.1}/eo_tides/stats.py

@@ -136,7 +136,7 @@ def _plot_biases(
 
 
 def tide_stats(
-    ds: xr.Dataset,
+    ds: xr.Dataset | xr.DataArray,
     model: str = "EOT20",
     directory: str | os.PathLike | None = None,
     tidepost_lat: float | None = None,
@@ -167,7 +167,7 @@ def tide_stats(
 
     Parameters
     ----------
-    ds : xarray.Dataset
+    ds : xarray.Dataset or xarray.DataArray
         A multi-dimensional dataset (e.g. "x", "y", "time") used
         to calculate tide statistics. This dataset must contain
         a "time" dimension.
@@ -266,7 +266,7 @@ def tide_stats(
         return_tideposts=True,
         **model_tides_kwargs,
     )
-    obs_tides_da = obs_tides_da.sortby("time")
+    obs_tides_da = obs_tides_da.reindex_like(ds)
 
     # Generate range of times covering entire period of satellite record
     all_timerange = pd.date_range(

{eo_tides-0.0.23 → eo_tides-0.1.1}/eo_tides.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eo-tides
-Version: 0.0.23
+Version: 0.1.1
 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/
@@ -91,6 +91,10 @@ For instructions on how to set up these models for use in `eo-tides`, refer to [
 
 To get started with `eo-tides`, follow the [Installation](https://geoscienceaustralia.github.io/eo-tides/install/) and [Setting up tide models](https://geoscienceaustralia.github.io/eo-tides/setup/) guides.
 
+## Jupyter Notebooks code examples
+
+Interactive Jupyter Notebook usage examples and more complex coastal EO case studies can be found in the [`docs/notebooks/`](https://github.com/GeoscienceAustralia/eo-tides/tree/main/docs/notebooks) directory, or [rendered in the documentation here](https://geoscienceaustralia.github.io/eo-tides/notebooks/Model_tides/).
+
 ## Citing `eo-tides`
 
 To cite `eo-tides` in your work, please use the following citation:

{eo_tides-0.0.23 → eo_tides-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.0.23"
+version = "0.1.1"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [{ name = "Robbi Bishop-Taylor", email = "Robbi.BishopTaylor@ga.gov.au" }]
 readme = "README.md"

{eo_tides-0.0.23 → eo_tides-0.1.1}/tests/test_model.py

@@ -223,6 +223,10 @@ def test_model_tides_mode(mode, models, output_format):
             assert all(modelled_tides_df.index.get_level_values("x") == np.tile(x, len(models)))
             assert all(modelled_tides_df.index.get_level_values("y") == np.tile(y, len(models)))
 
+            # Verify correct models exist in column
+            assert "tide_model" in modelled_tides_df.columns
+            assert all(modelled_tides_df.tide_model.unique() == models)
+
     if mode == "one-to-many":
         if output_format == "wide":
             # In "wide" output format, the number of rows should equal
@@ -243,6 +247,10 @@ def test_model_tides_mode(mode, models, output_format):
             assert all(modelled_tides_df.index.get_level_values("x") == np.tile(np.repeat(x, len(times)), len(models)))
             assert all(modelled_tides_df.index.get_level_values("y") == np.tile(np.repeat(y, len(times)), len(models)))
 
+            # Verify correct models exist in column
+            assert "tide_model" in modelled_tides_df.columns
+            assert all(modelled_tides_df.tide_model.unique() == models)
+
 
 # Test ensemble modelling functionality
 def test_model_tides_ensemble():