eo-tides 0.6.4.dev5__tar.gz → 0.6.5.dev2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/PKG-INFO +1 -1
  2. eo_tides-0.6.5.dev2/paper/figures/joss_fig_list.png +0 -0
  3. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/paper.bib +25 -11
  4. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/paper.md +5 -5
  5. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/paper.pdf +0 -0
  6. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/pyproject.toml +1 -1
  7. eo_tides-0.6.4.dev5/paper/figures/joss_fig_list.png +0 -0
  8. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.editorconfig +0 -0
  9. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/ISSUE_TEMPLATE/bug_report.md +0 -0
  10. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/ISSUE_TEMPLATE/feature_request.md +0 -0
  11. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/actions/setup-python-env/action.yml +0 -0
  12. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/workflows/check-links.yml +0 -0
  13. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/workflows/main.yml +0 -0
  14. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/workflows/on-release-main.yml +0 -0
  15. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.github/workflows/paper.yml +0 -0
  16. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.gitignore +0 -0
  17. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/.pre-commit-config.yaml +0 -0
  18. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/CITATION.cff +0 -0
  19. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/CONTRIBUTING.md +0 -0
  20. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/Dockerfile +0 -0
  21. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/LICENSE +0 -0
  22. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/Makefile +0 -0
  23. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/README.md +0 -0
  24. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/codecov.yaml +0 -0
  25. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/api.md +0 -0
  26. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/dtu23_download.jpg +0 -0
  27. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eo-tides-abstract.gif +0 -0
  28. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eo-tides-logo-128.png +0 -0
  29. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eo-tides-logo-256.png +0 -0
  30. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eo-tides-logo.gif +0 -0
  31. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eo-tides-logo.png +0 -0
  32. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/eot20_download.jpg +0 -0
  33. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/fes_ftp.jpg +0 -0
  34. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/fes_myproducts.jpg +0 -0
  35. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/fes_productselection.jpg +0 -0
  36. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/fes_subscriptions.jpg +0 -0
  37. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/got_download.jpg +0 -0
  38. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/tide_models_clipped.jpg +0 -0
  39. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/assets/tpxo_download.jpg +0 -0
  40. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/changelog.md +0 -0
  41. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/credits.md +0 -0
  42. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/index.md +0 -0
  43. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/install.md +0 -0
  44. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/migration.md +0 -0
  45. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/notebooks/Case_study_intertidal.ipynb +0 -0
  46. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/notebooks/Model_tides.ipynb +0 -0
  47. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/notebooks/Satellite_data.ipynb +0 -0
  48. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/notebooks/Tide_statistics.ipynb +0 -0
  49. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/notebooks/Validating_tides.ipynb +0 -0
  50. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/setup.md +0 -0
  51. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/docs/stylesheets/extra.css +0 -0
  52. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/__init__.py +0 -0
  53. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/eo.py +0 -0
  54. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/model.py +0 -0
  55. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/stats.py +0 -0
  56. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/utils.py +0 -0
  57. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/eo_tides/validation.py +0 -0
  58. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/mkdocs.yml +0 -0
  59. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/benchmarking.ipynb +0 -0
  60. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/figures/joss_abstract.png +0 -0
  61. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/figures/joss_fig_gesla.png +0 -0
  62. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/figures/joss_fig_pixel.png +0 -0
  63. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/paper/figures/joss_fig_stats.png +0 -0
  64. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/conftest.py +0 -0
  65. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/GESLA3_ALL 2.csv +0 -0
  66. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/IDO71013_2020.csv +0 -0
  67. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/broome-62650-aus-bom +0 -0
  68. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/san_diego_ca-569a-usa-uhslc +0 -0
  69. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/sydney_fort_denison-60370-aus-bom +0 -0
  70. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/data/tide_models.tar.gz +0 -0
  71. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/test_eo.py +0 -0
  72. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/test_model.py +0 -0
  73. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/test_stats.py +0 -0
  74. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/test_utils.py +0 -0
  75. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/test_validation.py +0 -0
  76. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/tests/testing.ipynb +0 -0
  77. {eo_tides-0.6.4.dev5 → eo_tides-0.6.5.dev2}/uv.lock +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: eo-tides
3
- Version: 0.6.4.dev5
3
+ Version: 0.6.5.dev2
4
4
  Summary: Tide modelling tools for large-scale satellite earth observation analysis
5
5
  Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
6
6
  Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides
@@ -77,7 +77,8 @@
77
77
  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},
78
78
  booktitle={2022 Ocean Surface Topography Science Team Meeting},
79
79
  pages={43},
80
- year={2022}
80
+ year={2022},
81
+ doi = {10.24400/527896/a03-2022.3287}
81
82
  }
82
83
 
83
84
  @article{GESLAv3,
@@ -198,16 +199,15 @@
198
199
  url={https://doi.org/10.1016/j.coastaleng.2021.103919}
199
200
  }
200
201
 
201
- @article{vos2019coastsat,
202
- title={{CoastSat}: {A} {Google Earth Engine}-enabled {Python} toolkit to extract shorelines from publicly available satellite imagery},
203
- author={Vos, K. and Splinter, K. D. and Harley, M. D. and Simmons, J. A. and Turner, I. L.},
204
- journal={Environmental Modelling \& Software},
205
- volume={122},
206
- pages={104528},
207
- year={2019},
208
- doi={10.1016/j.envsoft.2019.104528},
209
- url={https://doi.org/10.1016/j.envsoft.2019.104528},
210
- publisher={Elsevier}
202
+ @article{vos2023benchmark,
203
+ title = {Benchmarking Satellite-Derived Shoreline Mapping Algorithms},
204
+ 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},
205
+ year = {2023},
206
+ journal = {Communications Earth \& Environment},
207
+ volume = {4},
208
+ number = {345},
209
+ publisher = {Springer US},
210
+ doi = {https://doi.org/10.1038/s43247-023-01001-2}
211
211
  }
212
212
 
213
213
  @article{sent2025time,
@@ -227,3 +227,17 @@ title = {{SpatioTemporal Asset Catalog (STAC) specification}},
227
227
  url = {https://stacspec.org},
228
228
  year = {2024}
229
229
  }
230
+
231
+ @article{fitton2021intertidal,
232
+ title = {Remotely Sensed Mapping of the Intertidal Zone: {{A Sentinel-2}} and {{Google Earth Engine}} Methodology},
233
+ author = {Fitton, James M. and Rennie, Alistair F. and Hansom, James D. and Muir, Freya M. E.},
234
+ year = {2021},
235
+ journal = {Remote Sensing Applications: Society and Environment},
236
+ volume = {22},
237
+ number = {100499},
238
+ pages = {1--12},
239
+ publisher = {Elsevier},
240
+ issn = {23529385},
241
+ doi = {10.1016/j.rsase.2021.100499}
242
+ }
243
+
@@ -40,23 +40,23 @@ The `eo-tides` package provides powerful parallelised tools for integrating sate
40
40
 
41
41
  `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.
42
42
 
43
- `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.
43
+ `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 where ocean tide model data exists.
44
44
 
45
45
  ![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)
46
46
 
47
47
  # Statement of need
48
48
 
49
- 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.
49
+ 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.
50
50
 
51
- 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).
51
+ 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].
52
52
 
53
- 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`).
53
+ 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`).
54
54
 
55
55
  # Features
56
56
 
57
57
  ## Setting up tide models
58
58
 
59
- 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.
59
+ 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.
60
60
 
61
61
  ![A `list_tides` output providing a useful summary of available and supported tide models.\label{fig:list}](figures/joss_fig_list.png)
62
62
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "eo-tides"
3
- version = "0.6.4.dev5"
3
+ version = "0.6.5.dev2"
4
4
  description = "Tide modelling tools for large-scale satellite earth observation analysis"
5
5
  authors = [
6
6
  { name = "Robbi Bishop-Taylor" },
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes