Skip to content

Commit

Permalink
Update migration
Browse files Browse the repository at this point in the history
  • Loading branch information
robbibt committed Oct 18, 2024
1 parent 755268f commit a8b7adc
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,21 @@ Renamed for consistency with `model_tides` and `pixel_tides`.

Update references to `tidal_tag` to `tag_tides`.

### `tag_tides` now returns an array instead of updating data in-place

The `tag_tides` function now returns an `xarray.DataArray` output containing tide heights, rather than appending tide height data to the original input dataset in-place. This change provides better consistency with `pixel_tides`, which also returns an array of tide heights.

!!! tip "Action required"

Update:
```
ds = tag_tides(ds, ...)
```
To:
```
ds["tide_height"] = tag_tides(ds, ...)
```

### `pixel_tides` only returns a single array

The `pixel_tides` function has been updated to only ever return a single array as an output: a high-resolution tide height array matching the resolution of the input `ds` by default, and a low-resolution tide height array if `resample=False`.
Expand Down

0 comments on commit a8b7adc

Please sign in to comment.