eo-tides 0.6.4.dev4__tar.gz → 0.6.5.dev1__tar.gz

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: eo-tides
-Version: 0.6.4.dev4
+Version: 0.6.5.dev1
 Summary: Tide modelling tools for large-scale satellite earth observation analysis
 Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
 Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/docs/changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.6.4
+
+### New features
+
+- Updated installation documentation to improve reproducibility
+
+### Bug fixes
+
+- Temporarily pinned Dask to avoid `odc-geo` and `odc-stac` errors
+
 ## v0.6.3
 
 ### New features

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/docs/install.md

@@ -18,40 +18,54 @@ It is compatible with the following Python versions:
 
 === "Installing with `pip`"
 
-    Install `eo-tides` with essential package dependencies only:
+    Install `eo-tides`:
     ```console
-    python3 -m pip install eo-tides
+    python3 -m pip install eo-tides[notebooks]
     ```
 
-    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
+    The code above will also install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running [Jupyter Notebook code examples](notebooks/Model_tides.ipynb) (including `odc-stac` and `pystac-client` for loading satellite data).
+
+    To install `eo-tides` with only essential package dependencies:
 
     ```console
-    python3 -m pip install eo-tides[notebooks]
+    python3 -m pip install eo-tides
     ```
 
 === "Installing with `uv`"
 
     First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
 
-    Create a new virtual environment:
+    Create a new virtual environment with your chosen version of Python:
     ```console
-    uv venv
+    uv venv --python 3.13
     ```
 
     Activate your virtual environment:
+    === "Linux and macOS"
+        ```console
+        source .venv/bin/activate
+        ```
+    === "Windows"
+        ```console
+        .venv\Scripts\activate
+        ```
+
+    Install `eo-tides` into your virtual environment:
+
     ```console
-    source .venv/bin/activate
+    uv pip install eo-tides[notebooks]
     ```
 
-    Install `eo-tides` into your virtual environment, with essential package dependencies only:
+    The code above will also install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running [Jupyter Notebook code examples](notebooks/Model_tides.ipynb) (including `odc-stac` and `pystac-client` for loading satellite data).
+
+    To install `eo-tides` with only essential package dependencies:
     ```console
     uv pip install eo-tides
     ```
 
-    To install [additional package dependencies](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml#L62-L69) required for running the included Jupyter Notebook examples (including `odc-stac` and `pystac-client` for loading freely available satellite data), run:
-
+    You are now ready to run code using `eo-tides`! For example, you could launch your virtual environment with JupyterLab to run the [example Jupyter Notebooks](notebooks/Model_tides.ipynb):
     ```console
-    uv pip install eo-tides[notebooks]
+    uv run --with jupyter jupyter lab
     ```
 
 ## Unstable development pre-releases
@@ -62,33 +76,38 @@ Unstable development pre-releases of `eo-tides` are also available:
 
 === "Installing with `pip`"
 
-    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)), including additional `notebooks` dependencies:
     ```console
-    python3 -m pip install eo-tides==0.6.3.dev5
+    python3 -m pip install eo-tides[notebooks]==0.6.3.dev5
     ```
 
 === "Installing with `uv`"
 
     First, [install `uv` using the method of your choice](https://docs.astral.sh/uv/getting-started/installation/). Then:
 
-    Create a new virtual environment:
+    Create a new virtual environment with your chosen version of Python:
     ```console
-    uv venv
+    uv venv --python 3.13
     ```
 
     Activate your virtual environment:
+    === "Linux and macOS"
+        ```console
+        source .venv/bin/activate
+        ```
+    === "Windows"
+        ```console
+        .venv\Scripts\activate
+        ```
+
+    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)), including additional `notebooks` dependencies:
     ```console
-    source .venv/bin/activate
-    ```
-
-    Install an example `eo-tides` pre-release (see [full list here](https://pypi.org/project/eo-tides/#history)):
-    ```console
-    uv pip install eo-tides==0.6.3.dev5
+    uv pip install eo-tides[notebooks]==0.6.3.dev5
     ```
 
 !!! important
 
-    Unstable development pre-releases may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest stable version instead.
+    Unstable development pre-releases may contain bugs and untested new features. Unless you need access to a specific unpublished feature, we recommend installing the latest [stable version](#stable-version) instead.
 
 ### Advanced: Developing locally
 

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/paper/paper.bib

@@ -77,7 +77,8 @@
   author={Carrere, Loren and Lyard, Florent and Cancet, Mathilde and Allain, Damien and Dabat, Mei-Ling and Fouchet, Ergane and Sahuc, Etienne and Faugere, Yannice and Dibarboure, Gerald and Picot, Nicolas},
   booktitle={2022 Ocean Surface Topography Science Team Meeting},
   pages={43},
-  year={2022}
+  year={2022},
+  doi = {10.24400/527896/a03-2022.3287}
 }
 
 @article{GESLAv3,
@@ -210,6 +211,18 @@
   publisher={Elsevier}
 }
 
+@article{vos2023benchmark,
+  title = {Benchmarking Satellite-Derived Shoreline Mapping Algorithms},
+  author = {Vos, Kilian and Splinter, Kristen D. and {Palomar-V{\'a}zquez}, J. E. and {Almonacid-Caballer}, Jaime and {Cabezas-Rabad{\'a}n}, C. and Kras, Etienne C. and Luijendijk, Arjen P. and Calkoen, Floris and Almeida, Lu{\'i}s Pedro and Pais, D. and Klein, Antonio H.F. and Mao, Y. and Harris, D. and Castelle, Bruno and Buscombe, Daniel and Vitousek, Sean},
+  year = {2023},
+  journal = {Communications Earth \& Environment},
+  volume = {4},
+  number = {345},
+  publisher = {Springer US},
+  doi = {https://doi.org/10.1038/s43247-023-01001-2}
+}
+
+
 @article{sent2025time,
   title={What time is the tide? The importance of tides for ocean colour applications to estuaries},
   author={Sent, G. and Antunes, C. and Spyrakos, E. and Jackson, T. and Atwood, E. C. and Brito, A. C},
@@ -227,3 +240,17 @@ title = {{SpatioTemporal Asset Catalog (STAC) specification}},
 url = {https://stacspec.org},
 year = {2024}
 }
+
+@article{fitton2021intertidal,
+  title = {Remotely Sensed Mapping of the Intertidal Zone: {{A Sentinel-2}} and {{Google Earth Engine}} Methodology},
+  author = {Fitton, James M. and Rennie, Alistair F. and Hansom, James D. and Muir, Freya M. E.},
+  year = {2021},
+  journal = {Remote Sensing Applications: Society and Environment},
+  volume = {22},
+  number = {100499},
+  pages = {1--12},
+  publisher = {Elsevier},
+  issn = {23529385},
+  doi = {10.1016/j.rsase.2021.100499}
+}
+

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/paper/paper.md

@@ -41,24 +41,27 @@ The `eo-tides` package provides powerful parallelised tools for integrating sate
 `eo-tides` leverages advanced tide modelling functionality from the `pyTMD` tide prediction software [@pytmd], combining this capability with EO spatial analysis tools from the [Open Data Cube](https://www.opendatacube.org/) (ODC)'s `odc-geo` [@odcgeo]. This allows tides to be modelled in parallel using over 50 supported models, and returned in standardised `pandas` [@reback2020pandas; @mckinney-proc-scipy-2010] and `xarray` [@Hoyer_xarray_N-D_labeled_2017] data formats for EO analysis.
 
 `eo-tides` tools can be applied to petabytes of freely available satellite data loaded from the cloud using ODC's `odc-stac` or `datacube` packages (e.g. using [Digital Earth Australia](https://knowledge.dea.ga.gov.au/guides/setup/gis/stac/) or [Microsoft Planetary Computer's](https://planetarycomputer.microsoft.com/) STAC SpatioTemporal Asset Catalogues). Additional functionality allows users to assess potential satellite-tide biases and validate modelled tides with external tide gauge data — critical considerations for ensuring the reliability and accuracy of coastal EO workflows. These open-source tools support the efficient, scalable and robust analysis of coastal EO data for any time period or location globally.
+[//]: # (ANY is broad, more accurately any time period or location where satellite and tide data exist)
+
 
 ![A typical `eo-tides` coastal EO workflow, with tide heights modelled into every pixel in a spatio-temporal stack of satellite data (e.g. Sentinel-2 or Landsat), then combined to derive insights into dynamic coastal environments.\label{fig:abstract}](figures/joss_abstract.png)
 
 # Statement of need
 
-Satellite remote sensing offers an unparalleled resource for examining dynamic coastal environments through time or across large regions [@turner2021satellite; @vitousek2023future]. However, the highly variable influence of ocean tides can complicate analyses, making it difficult to separate the influence of changing tides from patterns of true coastal change [@vos2019coastsat]. This is a particularly challenging for large-scale coastal EO analyses, where failing to account for tide dynamics can lead to inaccurate or misleading insights into satellite-observed coastal processes.
+Satellite remote sensing offers an unparalleled resource for examining dynamic coastal environments through time or across large regions [@turner2021satellite; @vitousek2023future]. However, the highly variable influence of ocean tides can complicate analyses, making it difficult to separate the influence of changing tides from patterns of true coastal change [@vos2023benchmark]. This is a particularly challenging for large-scale coastal EO analyses, where failing to account for tide dynamics can lead to inaccurate or misleading insights into satellite-observed coastal processes.
 
-Conversely, information about ocean tides can provide unique environmental insights that can significantly enhance the value of EO data. Traditionally, satellite data dimensions include the geographic "where" and temporal "when" of acquisition. Introducing tide height as an additional analysis dimension allows data to be filtered, sorted, and analysed based on tidal dynamics, offering a transformative re-imagining of traditional multi-temporal EO analysis [@sagar2017item]. For instance, satellite data can be analysed to focus on ecologically significant tidal stages (e.g., high tide, low tide, spring or neap tides) or specific tidal processes (e.g., ebb or flow tides; @sent2025time).
+Conversely, information about ocean tides can provide unique environmental insights that can significantly enhance the value of EO data. Traditionally, satellite data dimensions include the geographic "where" and temporal "when" of acquisition. Introducing tide height as an additional analysis dimension allows data to be filtered, sorted, and analysed based on tidal dynamics, offering a transformative re-imagining of traditional multi-temporal EO analysis [@sagar2017item]. For instance, satellite data can be analysed to focus on ecologically significant tidal stages (e.g., high tide, low tide, spring or neap tides) or specific tidal processes (e.g., ebb or flow tides) [@sent2025time].
 
-This concept has been used to map coastal change at continental-scale [@bishop2021mapping], map intertidal zone extent and elevation [@murray2012continental; @sagar2017item; @bishop2019NIDEM], and creating tidally-constrained coastal image composites [@sagar2018composites]. However, these methods have traditionally relied on bespoke, closed-source, or difficult-to-install tide modelling tools, limiting their reproducibility and portability. To support the next generation of coastal EO workflows, there is a pressing need for efficient open-source tools for combining satellite data with tide modelling. `eo-tides` addresses this need through functionality offered in five main analysis modules (`utils`, `model`, `eo`, `stats`, `validation`).
+This concept has been used to map coastal change at continental-scale [@bishop2021mapping], map intertidal zone extent and elevation [@murray2012continental; @sagar2017item; @bishop2019NIDEM; @fitton2021intertidal], and creating tidally-constrained coastal image composites [@sagar2018composites]. However, these methods have traditionally relied on bespoke, closed-source, or difficult-to-install tide modelling tools, limiting their reproducibility and portability. To support the next generation of coastal EO workflows, there is a pressing need for efficient open-source tools for combining satellite data with tide modelling. `eo-tides` addresses this need through functionality offered in five main analysis modules (`utils`, `model`, `eo`, `stats`, `validation`).
 
 # Features
 
 ## Setting up tide models
 
-The [`eo_tides.utils`](https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.utils) module simplifies the setup of ocean tide models, addressing a common barrier to coastal EO workflows. Tools like `list_models` provide feedback on available and supported models (\autoref{fig:list}), while `clip_models` can significantly improve performance by clipping large high-resolution model files (e.g. FES2022) to smaller study area extents.
+The [`eo_tides.utils`](https://geoscienceaustralia.github.io/eo-tides/api/#eo_tides.utils) module simplifies the setup of ocean tide models, addressing a common barrier to coastal EO workflows. Tools like `list_models` provide feedback on available and supported models (\autoref{fig:list}), while `clip_models` can significantly improve performance by clipping large high-resolution model files (e.g. FES2022 [@carrere2022new]) to smaller study area extents.
 
 ![A `list_tides` output providing a useful summary of available and supported tide models.\label{fig:list}](figures/joss_fig_list.png)
+[//]: # (you mention FES2022 in text but FES2014 in fig, might be confusing; better to mention both as FES2014/2022, or just use FES2022 in fig)
 
 ## Modelling tides
 

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eo-tides"
-version = "0.6.4.dev4"
+version = "0.6.5.dev1"
 description = "Tide modelling tools for large-scale satellite earth observation analysis"
 authors = [
     { name = "Robbi Bishop-Taylor" },

{eo_tides-0.6.4.dev4 → eo_tides-0.6.5.dev1}/uv.lock

@@ -701,7 +701,7 @@ wheels = [
 
 [[package]]
 name = "eo-tides"
-version = "0.6.3"
+version = "0.6.4"
 source = { editable = "." }
 dependencies = [
     { name = "colorama" },
@@ -1001,7 +1001,7 @@ name = "importlib-metadata"
 version = "8.6.1"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "zipp" },
+    { name = "zipp", marker = "python_full_version < '3.12'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/33/08/c1395a292bb23fd03bdf572a1357c5a733d3eecbab877641ceacab23db6e/importlib_metadata-8.6.1.tar.gz", hash = "sha256:310b41d755445d74569f993ccfc22838295d9fe005425094fad953d7f15c8580", size = 55767 }
 wheels = [