eo-tides 0.1.1__tar.gz → 0.3.0__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 (23) hide show
  1. {eo_tides-0.1.1 → eo_tides-0.3.0}/PKG-INFO +20 -10
  2. {eo_tides-0.1.1 → eo_tides-0.3.0}/README.md +15 -8
  3. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/__init__.py +7 -4
  4. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/eo.py +184 -161
  5. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/model.py +350 -366
  6. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/stats.py +74 -36
  7. eo_tides-0.3.0/eo_tides/utils.py +596 -0
  8. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/validation.py +5 -5
  9. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides.egg-info/PKG-INFO +20 -10
  10. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides.egg-info/requires.txt +2 -1
  11. {eo_tides-0.1.1 → eo_tides-0.3.0}/pyproject.toml +12 -13
  12. {eo_tides-0.1.1 → eo_tides-0.3.0}/tests/test_eo.py +7 -7
  13. {eo_tides-0.1.1 → eo_tides-0.3.0}/tests/test_model.py +112 -21
  14. {eo_tides-0.1.1 → eo_tides-0.3.0}/tests/test_stats.py +1 -1
  15. eo_tides-0.3.0/tests/test_utils.py +168 -0
  16. eo_tides-0.1.1/eo_tides/utils.py +0 -144
  17. eo_tides-0.1.1/tests/test_utils.py +0 -84
  18. {eo_tides-0.1.1 → eo_tides-0.3.0}/LICENSE +0 -0
  19. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides.egg-info/SOURCES.txt +0 -0
  20. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides.egg-info/dependency_links.txt +0 -0
  21. {eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides.egg-info/top_level.txt +0 -0
  22. {eo_tides-0.1.1 → eo_tides-0.3.0}/setup.cfg +0 -0
  23. {eo_tides-0.1.1 → eo_tides-0.3.0}/tests/test_validation.py +0 -0
{eo_tides-0.1.1 → eo_tides-0.3.0}/PKG-INFO RENAMED
@@ -1,7 +1,8 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: eo-tides
3
- Version: 0.1.1
3
+ Version: 0.3.0
4
4
  Summary: Tide modelling tools for large-scale satellite earth observation analysis
5
+ Author: Stephen Sagar, Claire Phillips, Vanessa Newey
5
6
  Author-email: Robbi Bishop-Taylor <Robbi.BishopTaylor@ga.gov.au>
6
7
  Project-URL: Homepage, https://GeoscienceAustralia.github.io/eo-tides/
7
8
  Project-URL: Repository, https://github.com/GeoscienceAustralia/eo-tides
@@ -19,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.9
19
20
  Classifier: Programming Language :: Python :: 3.10
20
21
  Classifier: Programming Language :: Python :: 3.11
21
22
  Classifier: Programming Language :: Python :: 3.12
23
+ Classifier: Programming Language :: Python :: 3.13
22
24
  Requires-Python: <4.0,>=3.9
23
25
  Description-Content-Type: text/markdown
24
26
  License-File: LICENSE
@@ -28,8 +30,9 @@ Requires-Dist: matplotlib>=3.8.0
28
30
  Requires-Dist: numpy>=1.26.0
29
31
  Requires-Dist: odc-geo>=0.4.7
30
32
  Requires-Dist: pandas>=2.2.0
33
+ Requires-Dist: psutil>=5.8.0
31
34
  Requires-Dist: pyproj>=3.6.1
32
- Requires-Dist: pyTMD==2.1.6
35
+ Requires-Dist: pyTMD==2.1.8
33
36
  Requires-Dist: scikit-learn>=1.4.0
34
37
  Requires-Dist: scipy>=1.11.2
35
38
  Requires-Dist: shapely>=2.0.6
@@ -44,16 +47,17 @@ Requires-Dist: planetary_computer>=1.0.0; extra == "notebooks"
44
47
 
45
48
  # `eo-tides`: Tide modelling tools for large-scale satellite earth observation analysis
46
49
 
47
- <img align="right" width="200" src="docs/assets/eo-tides-logo.gif" alt="eo-tides logo" style="margin-right: 40px;">
50
+ <img align="right" width="200" src="https://github.com/GeoscienceAustralia/eo-tides/blob/main/docs/assets/eo-tides-logo.gif?raw=true" alt="eo-tides logo" style="margin-right: 40px;">
48
51
 
49
52
  [![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
50
53
  [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain)
51
- ![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)
54
+ [![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
52
55
  [![codecov](https://codecov.io/gh/GeoscienceAustralia/eo-tides/branch/main/graph/badge.svg)](https://codecov.io/gh/GeoscienceAustralia/eo-tides)
53
56
  [![License](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)
54
57
 
55
- - **Github repository**: <https://github.com/GeoscienceAustralia/eo-tides/>
56
- - **Documentation** <https://GeoscienceAustralia.github.io/eo-tides/>
58
+ - ⚙️ **Github repository**: <https://github.com/GeoscienceAustralia/eo-tides/>
59
+ - 📘 **Documentation**: <https://GeoscienceAustralia.github.io/eo-tides/>
60
+ - 🐍 **PyPI**: <https://pypi.org/project/eo-tides/>
57
61
 
58
62
  > [!CAUTION]
59
63
  > This package is a work in progress, and not currently ready for operational use.
@@ -64,13 +68,13 @@ Requires-Dist: planetary_computer>=1.0.0; extra == "notebooks"
64
68
 
65
69
  These tools can be applied to petabytes of freely available satellite data (e.g. from [Digital Earth Australia](https://knowledge.dea.ga.gov.au/) or [Microsoft Planetary Computer](https://planetarycomputer.microsoft.com/)) loaded via Open Data Cube's [`odc-stac`](https://odc-stac.readthedocs.io/en/latest/) or [`datacube`](https://opendatacube.readthedocs.io/en/latest/) packages, supporting coastal and ocean earth observation analysis for any time period or location globally.
66
70
 
67
- ![eo-tides abstract showing satellite data, tide data array and tide animation](docs/assets/eo-tides-abstract.gif)
71
+ ![eo-tides abstract showing satellite data, tide data array and tide animation](https://github.com/GeoscienceAustralia/eo-tides/blob/main/docs/assets/eo-tides-abstract.gif?raw=true)
68
72
 
69
73
  ## Highlights
70
74
 
71
- - 🌊 Model tides from multiple global ocean tide models in parallel, and return tide heights in standardised `pandas.DataFrame` format for further analysis
72
- - 🛰️ "Tag" satellite data with tide height and stage based on the exact moment of image acquisition
73
- - 🌐 Model tides for every individual satellite pixel, producing three-dimensional "tide height" `xarray`-format datacubes that can be integrated with satellite data
75
+ - 🌊 Model tide heights and phases (e.g. high, low, ebb, flow) from multiple global ocean tide models in parallel, and return a `pandas.DataFrame` for further analysis
76
+ - 🛰️ "Tag" satellite data with tide heights based on the exact moment of image acquisition
77
+ - 🌐 Model tides for every individual satellite pixel through time, producing three-dimensional "tide height" `xarray`-format datacubes that can be integrated with satellite data
74
78
  - 📈 Calculate statistics describing local tide dynamics, as well as biases caused by interactions between tidal processes and satellite orbits
75
79
  - 🛠️ Validate modelled tides using measured sea levels from coastal tide gauges (e.g. [GESLA Global Extreme Sea Level Analysis](https://gesla.org/))
76
80
  <!-- - 🎯 Combine multiple tide models into a single locally-optimised "ensemble" model informed by satellite altimetry and satellite-observed patterns of tidal inundation -->
@@ -103,6 +107,12 @@ To cite `eo-tides` in your work, please use the following citation:
103
107
  Bishop-Taylor, R., Sagar, S., Phillips, C., & Newey, V. (2024). eo-tides: Tide modelling tools for large-scale satellite earth observation analysis. https://github.com/GeoscienceAustralia/eo-tides
104
108
  ```
105
109
 
110
+ In addition, please consider also citing the underlying [`pyTMD` Python package](https://pytmd.readthedocs.io/en/latest/) which powers the tide modelling functionality behind `eo-tides`:
111
+
112
+ ```
113
+ Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395
114
+ ```
115
+
106
116
  ## Acknowledgements
107
117
 
108
118
  For a full list of acknowledgements, refer to [Citations and Credits](https://geoscienceaustralia.github.io/eo-tides/credits/).
{eo_tides-0.1.1 → eo_tides-0.3.0}/README.md RENAMED
@@ -1,15 +1,16 @@
1
1
  # `eo-tides`: Tide modelling tools for large-scale satellite earth observation analysis
2
2
 
3
- <img align="right" width="200" src="docs/assets/eo-tides-logo.gif" alt="eo-tides logo" style="margin-right: 40px;">
3
+ <img align="right" width="200" src="https://github.com/GeoscienceAustralia/eo-tides/blob/main/docs/assets/eo-tides-logo.gif?raw=true" alt="eo-tides logo" style="margin-right: 40px;">
4
4
 
5
5
  [![Release](https://img.shields.io/github/v/release/GeoscienceAustralia/eo-tides)](https://pypi.org/project/eo-tides/)
6
6
  [![Build status](https://img.shields.io/github/actions/workflow/status/GeoscienceAustralia/eo-tides/main.yml?branch=main)](https://github.com/GeoscienceAustralia/eo-tides/actions/workflows/main.yml?query=branch%3Amain)
7
- ![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)
7
+ [![Python Version from PEP 621 TOML](https://img.shields.io/pypi/pyversions/eo-tides)](https://github.com/GeoscienceAustralia/eo-tides/blob/main/pyproject.toml)
8
8
  [![codecov](https://codecov.io/gh/GeoscienceAustralia/eo-tides/branch/main/graph/badge.svg)](https://codecov.io/gh/GeoscienceAustralia/eo-tides)
9
9
  [![License](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)](https://img.shields.io/github/license/GeoscienceAustralia/eo-tides)
10
10
 
11
- - **Github repository**: <https://github.com/GeoscienceAustralia/eo-tides/>
12
- - **Documentation** <https://GeoscienceAustralia.github.io/eo-tides/>
11
+ - ⚙️ **Github repository**: <https://github.com/GeoscienceAustralia/eo-tides/>
12
+ - 📘 **Documentation**: <https://GeoscienceAustralia.github.io/eo-tides/>
13
+ - 🐍 **PyPI**: <https://pypi.org/project/eo-tides/>
13
14
 
14
15
  > [!CAUTION]
15
16
  > This package is a work in progress, and not currently ready for operational use.
@@ -20,13 +21,13 @@
20
21
 
21
22
  These tools can be applied to petabytes of freely available satellite data (e.g. from [Digital Earth Australia](https://knowledge.dea.ga.gov.au/) or [Microsoft Planetary Computer](https://planetarycomputer.microsoft.com/)) loaded via Open Data Cube's [`odc-stac`](https://odc-stac.readthedocs.io/en/latest/) or [`datacube`](https://opendatacube.readthedocs.io/en/latest/) packages, supporting coastal and ocean earth observation analysis for any time period or location globally.
22
23
 
23
- ![eo-tides abstract showing satellite data, tide data array and tide animation](docs/assets/eo-tides-abstract.gif)
24
+ ![eo-tides abstract showing satellite data, tide data array and tide animation](https://github.com/GeoscienceAustralia/eo-tides/blob/main/docs/assets/eo-tides-abstract.gif?raw=true)
24
25
 
25
26
  ## Highlights
26
27
 
27
- - 🌊 Model tides from multiple global ocean tide models in parallel, and return tide heights in standardised `pandas.DataFrame` format for further analysis
28
- - 🛰️ "Tag" satellite data with tide height and stage based on the exact moment of image acquisition
29
- - 🌐 Model tides for every individual satellite pixel, producing three-dimensional "tide height" `xarray`-format datacubes that can be integrated with satellite data
28
+ - 🌊 Model tide heights and phases (e.g. high, low, ebb, flow) from multiple global ocean tide models in parallel, and return a `pandas.DataFrame` for further analysis
29
+ - 🛰️ "Tag" satellite data with tide heights based on the exact moment of image acquisition
30
+ - 🌐 Model tides for every individual satellite pixel through time, producing three-dimensional "tide height" `xarray`-format datacubes that can be integrated with satellite data
30
31
  - 📈 Calculate statistics describing local tide dynamics, as well as biases caused by interactions between tidal processes and satellite orbits
31
32
  - 🛠️ Validate modelled tides using measured sea levels from coastal tide gauges (e.g. [GESLA Global Extreme Sea Level Analysis](https://gesla.org/))
32
33
  <!-- - 🎯 Combine multiple tide models into a single locally-optimised "ensemble" model informed by satellite altimetry and satellite-observed patterns of tidal inundation -->
@@ -59,6 +60,12 @@ To cite `eo-tides` in your work, please use the following citation:
59
60
  Bishop-Taylor, R., Sagar, S., Phillips, C., & Newey, V. (2024). eo-tides: Tide modelling tools for large-scale satellite earth observation analysis. https://github.com/GeoscienceAustralia/eo-tides
60
61
  ```
61
62
 
63
+ In addition, please consider also citing the underlying [`pyTMD` Python package](https://pytmd.readthedocs.io/en/latest/) which powers the tide modelling functionality behind `eo-tides`:
64
+
65
+ ```
66
+ Sutterley, T. C., Alley, K., Brunt, K., Howard, S., Padman, L., Siegfried, M. (2017) pyTMD: Python-based tidal prediction software. 10.5281/zenodo.5555395
67
+ ```
68
+
62
69
  ## Acknowledgements
63
70
 
64
71
  For a full list of acknowledgements, refer to [Citations and Credits](https://geoscienceaustralia.github.io/eo-tides/credits/).
{eo_tides-0.1.1 → eo_tides-0.3.0}/eo_tides/__init__.py RENAMED
@@ -28,19 +28,22 @@ validation : Load observed tide gauge data to validate modelled tides
28
28
 
29
29
  # Import commonly used functions for convenience
30
30
  from .eo import pixel_tides, tag_tides
31
- from .model import list_models, model_tides
32
- from .stats import tide_stats
33
- from .utils import idw
31
+ from .model import model_phases, model_tides
32
+ from .stats import pixel_stats, tide_stats
33
+ from .utils import clip_models, idw, list_models
34
34
  from .validation import eval_metrics, load_gauge_gesla
35
35
 
36
36
  # Define what should be imported with "from eo_tides import *"
37
37
  __all__ = [
38
38
  "list_models",
39
39
  "model_tides",
40
+ "model_phases",
40
41
  "tag_tides",
41
42
  "pixel_tides",
42
43
  "tide_stats",
43
- "idw",
44
+ "pixel_stats",
44
45
  "eval_metrics",
45
46
  "load_gauge_gesla",
47
+ "clip_models",
48
+ "idw",
46
49
  ]