eo-tides 0.0.20__py3-none-any.whl → 0.0.22__py3-none-any.whl

eo_tides/stats.py

@@ -1,15 +1,320 @@
-def tide_stats(a):
+# Used to postpone evaluation of type annotations
+from __future__ import annotations
+
+import os
+from typing import TYPE_CHECKING
+
+import matplotlib.pyplot as plt
+import numpy as np
+import odc.geo.xr
+import pandas as pd
+from scipy import stats
+
+# Only import if running type checking
+if TYPE_CHECKING:
+    import xarray as xr
+
+from .eo import tag_tides
+from .model import model_tides
+
+
+def tide_stats(
+    ds: xr.Dataset,
+    model: str = "EOT20",
+    directory: str | os.PathLike | None = None,
+    tidepost_lat: float | None = None,
+    tidepost_lon: float | None = None,
+    plain_english: bool = True,
+    plot: bool = True,
+    plot_col: str | None = None,
+    modelled_freq: str = "2h",
+    linear_reg: bool = False,
+    min_max_q: tuple = (0.0, 1.0),
+    round_stats: int = 3,
+    **model_tides_kwargs,
+) -> pd.Series:
     """
-    Test function.
+    Takes a multi-dimensional dataset and generate statistics
+    about the data's astronomical and satellite-observed tide
+    conditions.
+
+    By comparing the subset of tides observed by satellites
+    against the full astronomical tidal range, we can evaluate
+    whether the tides observed by satellites are biased
+    (e.g. fail to observe either the highest or lowest tides).
+
+    For more information about the tidal statistics computed by this
+    function, refer to Figure 8 in Bishop-Taylor et al. 2018:
+    <https://www.sciencedirect.com/science/article/pii/S0272771418308783#fig8>
 
     Parameters
     ----------
-    a : int
-        Test
+    ds : xarray.Dataset
+        A multi-dimensional dataset (e.g. "x", "y", "time") to
+        use to calculate tide statistics. This dataset must contain
+        a "time" dimension.
+    model : string, optional
+        The tide model to use to model tides. Defaults to "EOT20";
+        for a full list of available/supported models, run
+        `eo_tides.model.list_models`.
+    directory : string, optional
+        The directory containing tide model data files. If no path is
+        provided, this will default to the environment variable
+        `EO_TIDES_TIDE_MODELS` if set, or raise an error if not.
+        Tide modelling files should be stored in sub-folders for each
+        model that match the structure required by `pyTMD`
+        (<https://geoscienceaustralia.github.io/eo-tides/setup/>).
+    tidepost_lat, tidepost_lon : float or int, optional
+        Optional coordinates used to model tides. The default is None,
+        which uses the centroid of the dataset as the tide modelling
+        location.
+    plain_english : bool, optional
+        An optional boolean indicating whether to print a plain english
+        version of the tidal statistics to the screen. Defaults to True.
+    plot : bool, optional
+        An optional boolean indicating whether to plot how satellite-
+        observed tide heights compare against the full tidal range.
+        Defaults to True.
+    plot_col : str, optional
+        Optional name of a coordinate, dimension or variable in the array
+        that will be used to plot observations with unique symbols.
+        Defaults to None, which will plot all observations as circles.
+    modelled_freq : str, optional
+        An optional string giving the frequency at which to model tides
+        when computing the full modelled tidal range. Defaults to '2h',
+        which computes a tide height for every two hours across the
+        temporal extent of `ds`.
+    linear_reg: bool, optional
+        Whether to return linear regression statistics that assess
+        whether satellite-observed tides show any decreasing  or
+        increasing trends over time. This may indicate whether your
+        satellite data may produce misleading trends based on uneven
+        sampling of the local tide regime.
+    min_max_q : tuple, optional
+        Quantiles used to calculate max and min observed and modelled
+        astronomical tides. By default `(0.0, 1.0)` which is equivalent
+        to minimum and maximum; to use a softer threshold that is more
+        robust to outliers, use e.g. `(0.1, 0.9)`.
+    round_stats : int, optional
+        The number of decimal places used to round the output statistics.
+        Defaults to 3.
+    **model_tides_kwargs :
+        Optional parameters passed to the `eo_tides.model.model_tides`
+        function. Important parameters include `cutoff` (used to
+        extrapolate modelled tides away from the coast; defaults to
+        `np.inf`), `crop` (whether to crop tide model constituent files
+        on-the-fly to improve performance) etc.
 
     Returns
     -------
-    Test
+    A `pandas.Series` containing the following statistics:
+
+        - `tidepost_lat`: latitude used for modelling tide heights
+        - `tidepost_lon`: longitude used for modelling tide heights
+        - `observed_min_m`: minimum tide height observed by the satellite
+        - `all_min_m`: minimum tide height from all available tides
+        - `observed_max_m`: maximum tide height observed by the satellite
+        - `all_max_m`: maximum tide height from all available tides
+        - `observed_range_m`: tidal range observed by the satellite
+        - `all_range_m`: full astronomical tidal range based on all available tides
+        - `spread_m`: proportion of the full astronomical tidal range observed by the satellite (see Bishop-Taylor et al. 2018)
+        - `low_tide_offset`: proportion of the lowest tides never observed by the satellite (see Bishop-Taylor et al. 2018)
+        - `high_tide_offset`: proportion of the highest tides never observed by the satellite (see Bishop-Taylor et al. 2018)
+
+    If `linear_reg = True`, the output will also contain:
+
+        - `observed_slope`: slope of any relationship between observed tide heights and time
+        - `observed_pval`: significance/p-value of any relationship between observed tide heights and time
 
     """
-    return a
+    # Verify that only one tide model is provided
+    if isinstance(model, list):
+        raise Exception("Only single tide models are supported by `tide_stats`.")
+
+    # If custom tide modelling locations are not provided, use the
+    # dataset centroid
+    if not tidepost_lat or not tidepost_lon:
+        tidepost_lon, tidepost_lat = ds.odc.geobox.geographic_extent.centroid.coords[0]
+
+    # Model tides for each observation in the supplied xarray object
+    ds_tides = tag_tides(
+        ds,
+        model=model,
+        directory=directory,
+        tidepost_lat=tidepost_lat,  # type: ignore
+        tidepost_lon=tidepost_lon,  # type: ignore
+        return_tideposts=True,
+        **model_tides_kwargs,
+    )
+    ds_tides = ds_tides.sortby("time")
+
+    # Drop spatial ref for nicer plotting
+    ds_tides = ds_tides.drop_vars("spatial_ref")
+
+    # Generate range of times covering entire period of satellite record
+    all_timerange = pd.date_range(
+        start=ds_tides.time.min().item(),
+        end=ds_tides.time.max().item(),
+        freq=modelled_freq,
+    )
+
+    # Model tides for each timestep
+    all_tides_df = model_tides(
+        x=tidepost_lon,  # type: ignore
+        y=tidepost_lat,  # type: ignore
+        time=all_timerange,
+        model=model,
+        directory=directory,
+        crs="EPSG:4326",
+        **model_tides_kwargs,
+    )
+
+    # Get coarse statistics on all and observed tidal ranges
+    obs_mean = ds_tides.tide_height.mean().item()
+    all_mean = all_tides_df.tide_height.mean()
+    obs_min, obs_max = ds_tides.tide_height.quantile(min_max_q).values
+    all_min, all_max = all_tides_df.tide_height.quantile(min_max_q).values
+
+    # Calculate tidal range
+    obs_range = obs_max - obs_min
+    all_range = all_max - all_min
+
+    # Calculate Bishop-Taylor et al. 2018 tidal metrics
+    spread = obs_range / all_range
+    low_tide_offset_m = abs(all_min - obs_min)
+    high_tide_offset_m = abs(all_max - obs_max)
+    low_tide_offset = low_tide_offset_m / all_range
+    high_tide_offset = high_tide_offset_m / all_range
+
+    # Plain text descriptors
+    mean_diff = "higher" if obs_mean > all_mean else "lower"
+    mean_diff_icon = "⬆️" if obs_mean > all_mean else "⬇️"
+    spread_icon = "🟢" if spread >= 0.9 else "🟡" if 0.7 < spread <= 0.9 else "🔴"
+    low_tide_icon = "🟢" if low_tide_offset <= 0.1 else "🟡" if 0.1 <= low_tide_offset < 0.2 else "🔴"
+    high_tide_icon = "🟢" if high_tide_offset <= 0.1 else "🟡" if 0.1 <= high_tide_offset < 0.2 else "🔴"
+
+    # Extract x (time in decimal years) and y (distance) values
+    all_times = all_tides_df.index.get_level_values("time")
+    all_x = all_times.year + ((all_times.dayofyear - 1) / 365) + ((all_times.hour) / 24)
+    time_period = all_x.max() - all_x.min()
+
+    # Extract x (time in decimal years) and y (distance) values
+    obs_x = ds_tides.time.dt.year + ((ds_tides.time.dt.dayofyear - 1) / 365) + ((ds_tides.time.dt.hour) / 24)
+    obs_y = ds_tides.tide_height.values.astype(np.float32)
+
+    # Compute linear regression
+    obs_linreg = stats.linregress(x=obs_x, y=obs_y)
+
+    # return obs_linreg
+
+    if plain_english:
+        print(f"\n\n🌊 Modelled astronomical tide range: {all_range:.2f} metres.")
+        print(f"🛰️ Observed tide range: {obs_range:.2f} metres.\n")
+        print(f"    {spread_icon} {spread:.0%} of the modelled astronomical tide range was observed at this location.")
+        print(
+            f"    {high_tide_icon} The highest {high_tide_offset:.0%} ({high_tide_offset_m:.2f} metres) of the tide range was never observed."
+        )
+        print(
+            f"    {low_tide_icon} The lowest {low_tide_offset:.0%} ({low_tide_offset_m:.2f} metres) of the tide range was never observed.\n"
+        )
+        print(f"🌊 Mean modelled astronomical tide height: {all_mean:.2f} metres.")
+        print(f"🛰️ Mean observed tide height: {obs_mean:.2f} metres.\n")
+        print(
+            f"    {mean_diff_icon} The mean observed tide height was {obs_mean - all_mean:.2f} metres {mean_diff} than the mean modelled astronomical tide height."
+        )
+
+        if linear_reg:
+            if obs_linreg.pvalue > 0.01:
+                print("    ➖ Observed tides showed no significant trends over time.")
+            else:
+                obs_slope_desc = "decreasing" if obs_linreg.slope < 0 else "increasing"
+                print(
+                    f"    ⚠️ Observed tides showed a significant {obs_slope_desc} trend over time (p={obs_linreg.pvalue:.3f}, {obs_linreg.slope:.2f} metres per year)"
+                )
+
+    if plot:
+        # Create plot and add all time and observed tide data
+        fig, ax = plt.subplots(figsize=(10, 6))
+        all_tides_df.reset_index(["x", "y"]).tide_height.plot(ax=ax, alpha=0.4, label="Modelled tides")
+
+        # Look through custom column values if provided
+        if plot_col is not None:
+            # Create a list of marker styles
+            markers = ["o", "^", "s", "D", "v", "<", ">", "p", "*", "h", "H", "+", "x", "d", "|", "_"]
+            for i, value in enumerate(np.unique(ds_tides[plot_col])):
+                ds_tides.where(ds_tides[plot_col] == value, drop=True).tide_height.plot.line(
+                    ax=ax,
+                    linewidth=0.0,
+                    color="black",
+                    marker=markers[i % len(markers)],
+                    markersize=4,
+                    label=value,
+                )
+        # Otherwise, plot all data at once
+        else:
+            ds_tides.tide_height.plot.line(
+                ax=ax, marker="o", linewidth=0.0, color="black", markersize=3.5, label="Satellite observations"
+            )
+
+        ax.legend(loc="upper center", bbox_to_anchor=(0.5, 1.04), ncol=20, borderaxespad=0, frameon=False)
+
+        ax.plot(
+            ds_tides.time.isel(time=[0, -1]),
+            obs_linreg.intercept + obs_linreg.slope * obs_x[[0, -1]],
+            "r",
+            label="fitted line",
+        )
+
+        # Add horizontal lines for spread/offsets
+        ax.axhline(obs_min, color="black", linestyle=":", linewidth=1)
+        ax.axhline(obs_max, color="black", linestyle=":", linewidth=1)
+        ax.axhline(all_min, color="black", linestyle=":", linewidth=1)
+        ax.axhline(all_max, color="black", linestyle=":", linewidth=1)
+
+        # Add text annotations for spread/offsets
+        ax.annotate(
+            f"    High tide\n    offset ({high_tide_offset:.0%})",
+            xy=(all_timerange.max(), np.mean([all_max, obs_max])),
+            va="center",
+        )
+        ax.annotate(
+            f"    Spread\n    ({spread:.0%})",
+            xy=(all_timerange.max(), np.mean([obs_min, obs_max])),
+            va="center",
+        )
+        ax.annotate(
+            f"    Low tide\n    offset ({low_tide_offset:.0%})",
+            xy=(all_timerange.max(), np.mean([all_min, obs_min])),
+        )
+
+        # Remove top right axes and add labels
+        ax.spines["right"].set_visible(False)
+        ax.spines["top"].set_visible(False)
+        ax.set_ylabel("Tide height (m)")
+        ax.set_xlabel("")
+        ax.margins(x=0.015)
+
+    # Export pandas.Series containing tidal stats
+    output_stats = {
+        "tidepost_lat": tidepost_lat,
+        "tidepost_lon": tidepost_lon,
+        "observed_mean_m": obs_mean,
+        "all_mean_m": all_mean,
+        "observed_min_m": obs_min,
+        "all_min_m": all_min,
+        "observed_max_m": obs_max,
+        "all_max_m": all_max,
+        "observed_range_m": obs_range,
+        "all_range_m": all_range,
+        "spread": spread,
+        "low_tide_offset": low_tide_offset,
+        "high_tide_offset": high_tide_offset,
+    }
+
+    if linear_reg:
+        output_stats.update({
+            "observed_slope": obs_linreg.slope,
+            "observed_pval": obs_linreg.pvalue,
+        })
+
+    return pd.Series(output_stats).round(round_stats)

eo_tides/validation.py

@@ -75,7 +75,7 @@ def eval_metrics(x, y, round=3, all_regress=False):
     return pd.Series(stats_dict).round(round)
 
 
-def round_date_strings(date, round_type="end"):
+def _round_date_strings(date, round_type="end"):
     """
     Round a date string up or down to the start or end of a given time
     period.
@@ -286,8 +286,8 @@ def load_gauge_gesla(
     if time is None:
         time = ["1800", str(datetime.datetime.now().year)]
     time = [time] if not isinstance(time, (list, tuple)) else time
-    start_time = round_date_strings(time[0], round_type="start")
-    end_time = round_date_strings(time[-1], round_type="end")
+    start_time = _round_date_strings(time[0], round_type="start")
+    end_time = _round_date_strings(time[-1], round_type="end")
 
     # Identify paths to load and nodata values for each site
     metadata_df["file_name"] = data_path + metadata_df["file_name"]

eo_tides-0.0.22.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Geoscience Australia
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.