Prepare for 0.4.0

GeoscienceAustralia · Dec 21, 2024 · 7f510d3 · 7f510d3
1 parent 2f13956
commit 7f510d3
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 8 deletions.
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,20 +1,31 @@
 # Changelog
 
-## v0.3.2 (upcoming)
+## v0.4.0
 
 ### New features
 
-- Publishes ensemble tide modelling code for combining multiple global ocean tide models into a single locally optimised ensemble tide model using external model ranking data (e.g. satellite altimetry or NDWI-tide correlations along the coastline)
-  - Update ensemble code to latest version that includes FES2022, GOT5.6 and TPXO10
+- Publishes ensemble tide modelling code for combining multiple global ocean tide models into a single locally optimised ensemble tide model using external model ranking data (e.g. satellite altimetry or NDWI-tide correlations along the coastline).
+
+  - Update ensemble code to latest version that includes FES2022, GOT5.6 and TPXO10 tide models
   - Make ensemble model calculation function a top level function (i.e. rename from `_ensemble_model` to `ensemble_tides`)
-  - Load tide model ranking points from external flatgeobuff format file for faster cloud access
-- Make buffer distance applied when cropping model files configurable via the `crop_buffer` param, with a default of 5 degrees
-- Reorder `model_tides` params to provide more logical flow and move more common params like `mode`, `output_format` and `output_units` higher
+  - Load tide model ranking points from external `flatgeobuf` format file for faster cloud access
+
+- Major refactor to statistics functions to standardise code across both `pixel_stats` and `tide_stats` and add support for multiple models
+
+  - `tide_stats` will now return a `pandas.Series` if one model is requested, and a `pandas.DataFrame` if multiple are requested
+  - Added a new `point_col` parameter to `tide_stats` to control the colour of plotted points. If `plot_var` is also provided, points will now be coloured differently by default.
+
+- Added a new `crop_buffer` parameter to configure buffer distance when cropping model files with `crop=True` (defaults to 5 degrees)
+- Reorder `model_tides` parameters to provide more logical flow and move more common params like `mode`, `output_format` and `output_units` higher
 
 ### Bug fixes
 
 - Fix warnings from `load_gauge_gesla` function
 
+### Breaking changes
+
+- The `plot_col` parameter from `tide_stats` has been renamed to `plot_var`
+
 ## v0.3.1 (2024-11-15)
 
 ### New features

diff --git a/docs/setup.md b/docs/setup.md
@@ -195,7 +195,7 @@ Follow the guides below for some of the most commonly used global ocean tide mod
     ### TPXO Global Tidal Models
 
     1. Visit [TPXO Registration](https://www.tpxo.net/tpxo-products-and-registration)
-    2. Follow instructions to email TPXO authors for access, providing your name, institution, your intended application/use case, and which TPXO models you need ("TPXO10-atlas-v2 netcdf" or "TPXO9-atlas-v5 netcdf" are recommended to [enable clipping](#Clipping-model-files-to-improve-performance)).
+    2. Follow instructions to email TPXO authors for access, providing your name, institution, your intended application/use case, and which TPXO models you need ("TPXO10-atlas-v2 netcdf" or "TPXO9-atlas-v5 netcdf" are recommended to [enable clipping](#clipping-model-files-to-improve-performance)).
     3. If your request is approved, you will be emailed an invite to an app.box.com folder. Open this link, then click "Download" on the top-right to download your zipped model files.
 
         ![image](assets/tpxo_download.jpg)

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.3.1"
+version = "0.4.0"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [
     { name = "Robbi Bishop-Taylor" },