0.10.1

What's Changed

• Only include Python code in build to reduce package size by @robbibt in #137

Full Changelog: 0.10.0...0.10.1

0.10.0

What's Changed

• Add new tag_timeseries function for tagging satellite data with external timeseries data. This function is designed to take a 1D timeseries of tide heights or water levels, and map these back to each satellite observation timestep. This can be used to tag satellite data with observed tides, instead of tides modelled using global tide models. #134

Full Changelog: 0.9.2...0.10.0

0.9.2

What's Changed

• Update validation code and notebook examples in #132

Full Changelog: 0.9.1...0.9.2

0.9.1

What's Changed

• Move STAC loading package dependencies to default requirements in #130

Full Changelog: 0.9.0...0.9.1

0.9.0

What's Changed

This release adds new functionality for loading satellite data using STAC metadata, and for ranking tide model performance based on their correlation with satell-observed patterns of inundation. For more information, see:

• https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.validation.tide_correlation
• https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.stac.stac_load
• https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.stac.load_ndwi_mpc

Jupyter Notebook example: https://geoscienceaustralia.github.io/eo-tides/notebooks/Validating_tides/#tide-correlation-model-rankings

New features

• Add NDWI-tide correlation function and STAC data loading tools in #87
• Support STAC loading data by bounding box, geopolygon, Shapely, GeoPandas, GeoJSON in #126
• Update tide correlation code, add support for masking to STAC functions by @robbibt in #128

Full Changelog: 0.8.3...0.9.0

0.8.3

What's Changed

New features

• Add support for GESLA 4 tide gauge dataset in validation.py by @robbibt in #123

Other changes

• Minor fix to validation error format by @robbibt in #121

Full Changelog: 0.8.2...0.8.3

0.8.2

What's Changed

Breaking changes

• Refactor tide_aliasing function to use constituent param name instead of c, use a list of default major tide constituents from pyTMD, remove "type" column, and set a 10 year default max on period values by @robbibt in #118

Bug fixes

• Fix bug with specifying custom list of constituents in #117 by upgrading pyTMD by @robbibt in #118

Other changes

• Add spell check to pre-commit, minor formatting updates by @robbibt in #116
• Minor updates and upgrades to tests and ruff, uv versions by @robbibt in #118

Full Changelog: 0.8.1...0.8.2

0.8.1

What's Changed

Other changes

• Add new EO satellite tide aliasing function for evaluating potential temporal biases in EO analyses in #113
• Add jupyter to notebook optional dependencies to make Jupyter Notebooks easier to run in #112

Full Changelog: 0.8.0...0.8.1

0.8.0

What's Changed

This release provides new functionality to customise tide modelling:

1. A new extra_databases parameter to model tides using models that are not natively supported by pyTMD, accepting custom tide model databases in either Python dictionary or JSON file format
2. A new constituents parameter to restrict tide modelling to a custom subset of harmonic constituents

For example, to model tides using a custom EOT20_custom tide model:

import pandas as pd
from eo_tides.model import model_tides

custom_db_dict = {
  "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"
    }
  }
}

model_tides(
    x=148,
    y=-16,
    time=pd.date_range("2022-01-01", "2023-12-31", freq="1h"),
    model=["EOT20_custom", "EOT20"],
    directory="/var/share/tide_models/",
    extra_databases=custom_db_dict,
    output_format="wide",
)

New features

• Support custom tide models by passing in extra tide model databases by @robbibt in #105
• Support customising constituents during tide modelling by @robbibt in #108

Other changes

• Major Ruff refactor by @robbibt in #108

Full Changelog: 0.7.5...0.8.0

0.7.5

What's Changed

Minor update to remove Dask pin now that Dask compatability issue has been solved in odc-stac

Documentation updates

• Fix unlinked URLs in changelog by @robbibt in #103

Other changes

• Remove dask pin to close #76 by @robbibt in #106

Full Changelog: 0.7.4...0.7.5