From 914ce374133c0e66bca91c2d6798104bbdc9ae56 Mon Sep 17 00:00:00 2001 From: Robbi Bishop-Taylor Date: Tue, 1 Oct 2024 08:32:09 +0000 Subject: [PATCH] Update docs --- docs/migration.md | 4 ++++ docs/notebooks/Model_tides.ipynb | 7 ++++--- eo_tides/model.py | 1 + 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/migration.md b/docs/migration.md index 8b11c97..898b9e5 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -10,6 +10,10 @@ To migrate your code from DEA Tools to `eo-tides`, please be aware of the follow The output tide heights column generated by the `model_tides` function (when running in the default `output_format="long"` format) has been renamed from `tide_m` to `tide_height`. This more clearly describes the data, particularly when used in combination with `output_units="cm"` or `output_units="mm"` which returns tide heights in non-metre units. +- **Action:** Update references to column `tide_m` to `tide_height` + ### Tide model directory environment variable updated The `DEA_TOOLS_TIDE_MODELS` environmental variable has been renamed to `EO_TIDES_TIDE_MODELS`. + +- **Action:** Set the `EO_TIDES_TIDE_MODELS` environment variable instead of `DEA_TOOLS_TIDE_MODELS` diff --git a/docs/notebooks/Model_tides.ipynb b/docs/notebooks/Model_tides.ipynb index efc6755..890d4d0 100644 --- a/docs/notebooks/Model_tides.ipynb +++ b/docs/notebooks/Model_tides.ipynb @@ -6,6 +6,8 @@ "source": [ "# Modelling tides\n", "\n", + "To model tide heights for a specific location and set of timesteps, we can use the `eo_tides.model.model_tides` function. \n", + "\n", "## Getting started\n", "As a first step, we need to tell `eo-tides` the location of our tide model directory that contains our downloaded tide model data ([refer to the detailed setup instructions here](../setup.md) if you haven't set this up).\n", "\n", @@ -36,8 +38,7 @@ "source": [ "## Using \"model_tides\"\n", "\n", - "To model tide heights for a specific location and set of timesteps, we can use the `eo_tides.model.model_tides` function. \n", - "For example, we can model hourly tides across a one month period (January 2028):" + "In the example below, we model hourly tides for Broome in Western Australia across January 2018:" ] }, { @@ -162,7 +163,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "The resulting `pandas.DataFrame` contains a `tide_model` column containing the name of the tide model used (FES2014 by default), and modelled tide heights in the `tide_height` column above with values representing tide height in metres relative to Mean Sea Level.\n", + "The resulting `pandas.DataFrame` contains a `tide_model` column listing the tide model used (FES2014 by default), and modelled tide heights in the `tide_height` column with values representing tide height in metres relative to Mean Sea Level.\n", "\n", "We can also plot out resulting tides to view how tides changed across this month. \n", "Looking at the y-axis, we can see that tides at this macrotidal region ranged from -4 metres up to a maximum of +4 metres relative to Mean Sea Level:" diff --git a/eo_tides/model.py b/eo_tides/model.py index 60a878e..66206e9 100644 --- a/eo_tides/model.py +++ b/eo_tides/model.py @@ -411,6 +411,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`)