Releases: GeoscienceAustralia/eo-tides
Releases · GeoscienceAustralia/eo-tides
0.8.1
0.8.0
What's Changed
This release provides new functionality to customise tide modelling:
- A new
extra_databases
parameter to model tides using models that are not natively supported bypyTMD
, accepting custom tide model databases in either Python dictionary or JSON file format - 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
Full Changelog: 0.7.5...0.8.0
0.7.5
0.7.4
What's Changed
New features
Documentation updates
- Fix capitalisation in JOSS paper bibliography by @robbibt in #97
- Update suggested citation to use new JOSS paper citation by @robbibt in #100
Other changes
- Update PR labelling and release template by @robbibt in #99
- Reformat code with additional
ruff
linting rules by @robbibt in #101
New Contributors
- @github-actions made their first contribution in #96
Full Changelog: 0.7.3...0.7.4
0.7.3
Changes
- Use dynamic version handling via
hatch-vcs
, add automatic changelog update action by @robbibt in #95 - Bump the python-deps group with 2 updates by @dependabot in #94
Full Changelog: 0.7.2...0.7.3
0.7.2
0.7.1
What's Changed
- Bump folium from 0.19.5 to 0.19.6 in the python-deps group by @dependabot in #92
Full Changelog: 0.7.0...0.7.1
0.7.0
What's Changed
This version corresponds to the code archived as part of Journal of Open Source Software publication. No new features introduced.
- Bump the python-deps group across 1 directory with 3 updates by @dependabot in #88
- Update ORCID by @robbibt in #90
- Version 0.7.0 release for JOSS archiving by @robbibt in #91
Full Changelog: 0.6.5...0.7.0
0.6.5
What's Changed
- Paper text and bib edits, plus comments inserted with [//]: # by @fmemuir in #81
- JOSS review updates: Minor paper changes by @robbibt in #82
- JOSS review updates: Documentation and notebook updates by @robbibt in #83
- fix doi in vos2023benchmark by @pdebuyl in #84
- Bump xarray from 2025.3.1 to 2025.4.0 in the python-deps group by @dependabot in #85
- Add support for latest pyTMD by @robbibt in #78
New Contributors
- @fmemuir made their first contribution in #81
- @pdebuyl made their first contribution in #84
- @dependabot made their first contribution in #85
Full Changelog: 0.6.4...0.6.5