dea-tools 0.3.5.dev23__tar.gz → 0.3.6.dev25__tar.gz

{dea_tools-0.3.5.dev23/dea_tools.egg-info → dea_tools-0.3.6.dev25}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dea-tools
-Version: 0.3.5.dev23
+Version: 0.3.6.dev25
 Summary: Functions and algorithms for analysing Digital Earth Australia data.
 Home-page: https://github.com/GeoscienceAustralia/dea-notebooks
 Author: Geoscience Australia
@@ -44,7 +44,7 @@ Requires-Dist: pyproj
 Requires-Dist: pystac-client
 Requires-Dist: planetary-computer
 Requires-Dist: python-dateutil
-Requires-Dist: pyTMD<=2.1.6
+Requires-Dist: pyTMD!=2.1.7
 Requires-Dist: pytz
 Requires-Dist: rasterio
 Requires-Dist: rasterstats
@@ -65,6 +65,17 @@ Provides-Extra: dask-gateway
 Requires-Dist: dask_gateway; extra == "dask-gateway"
 Provides-Extra: otps
 Requires-Dist: otps; extra == "otps"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 
 dea-tools package

{dea_tools-0.3.5.dev23 → dea_tools-0.3.6.dev25}/dea_tools/coastal.py

@@ -738,6 +738,10 @@ def model_tides(
     **ensemble_kwargs,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Compute tides at multiple points and times using tidal harmonics.
 
     This function supports all tidal models supported by `pyTMD`,
@@ -887,6 +891,14 @@ def model_tides(
     combination of time and point coordinates.
 
     """
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     # Set tide modelling files directory. If no custom path is provided,
     # first try global environmental var, then "/var/share/tide_models"
     if directory is None:
@@ -1169,6 +1181,10 @@ def pixel_tides(
     **model_tides_kwargs,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Obtain tide heights for each pixel in a dataset by modelling
     tides into a low-resolution grid surrounding the dataset,
     then (optionally) spatially resample this low-res data back
@@ -1271,6 +1287,14 @@ def pixel_tides(
     import odc.geo.xr
     from odc.geo.geobox import GeoBox
 
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     # First test if no time dimension and nothing passed to `times`
     if ("time" not in ds.dims) & (times is None):
         raise ValueError(
@@ -1449,6 +1473,10 @@ def tidal_tag(
     **model_tides_kwargs,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Takes an xarray.Dataset and returns the same dataset with a new
     `tide_m` variable giving the height of the tide at the exact
     moment of each satellite acquisition.
@@ -1501,6 +1529,14 @@ def tidal_tag(
 
     import odc.geo.xr
 
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     # If custom tide modelling locations are not provided, use the
     # dataset centroid
     if not tidepost_lat or not tidepost_lon:
@@ -1593,6 +1629,10 @@ def tidal_stats(
     **model_tides_kwargs,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Takes an xarray.Dataset and statistically compares the tides
     modelled for each satellite observation against the full modelled
     tidal range. This comparison can be used to evaluate whether the
@@ -1679,6 +1719,13 @@ def tidal_stats(
                   all available tide heights and time
 
     """
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
 
     # Model tides for each observation in the supplied xarray object
     ds_tides, tidepost_lon, tidepost_lat = tidal_tag(
@@ -1861,6 +1908,10 @@ def tidal_tag_otps(
     return_tideposts=False,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Takes an xarray.Dataset and returns the same dataset with a new
     `tide_m` variable giving the height of the tide at the exact
     moment of each satellite acquisition.
@@ -1904,6 +1955,13 @@ def tidal_tag_otps(
     location used in the analysis).
 
     """
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
 
     # Load tide modelling functions from either OTPS for pyfes
     try:
@@ -2002,6 +2060,10 @@ def tidal_stats_otps(
     round_stats=3,
 ):
     """
+    DEPRECATED: This function has been moved to the `eo-tides` Python package,
+    and will be retired in a future release. Please migrate your code to use
+    `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/
+
     Takes an xarray.Dataset and statistically compares the tides
     modelled for each satellite observation against the full modelled
     tidal range. This comparison can be used to evaluate whether the
@@ -2082,6 +2144,13 @@ def tidal_stats_otps(
                   all available tide heights and time
 
     """
+    warnings.warn(
+        "This function has been moved to the `eo-tides` Python package, "
+        "and will be retired in a future release. Please migrate your code "
+        "to use `eo-tides` instead: https://geoscienceaustralia.github.io/eo-tides/migration/",
+        DeprecationWarning,
+        stacklevel=2,
+    )
 
     # Load tide modelling functions from either OTPS for pyfes
     try:

{dea_tools-0.3.5.dev23 → dea_tools-0.3.6.dev25}/dea_tools/datahandling.py

@@ -17,7 +17,7 @@ here: https://gis.stackexchange.com/questions/tagged/open-data-cube).
 If you would like to report an issue with this script, you can file one
 on GitHub (https://github.com/GeoscienceAustralia/dea-notebooks/issues/new).
 
-Last modified: Feb 2024
+Last modified: February 2025
 """
 
 import datetime
@@ -112,7 +112,7 @@ def load_ard(
 ):
     """
     Load multiple Geoscience Australia Landsat or Sentinel 2
-    Collection 3 products (e.g. Landsat 5, 7, 8, 9; Sentinel 2A and 2B),
+    Collection 3  Analysis Ready Data products (e.g. Landsat 5, 7, 8, 9; Sentinel 2A, 2B, 2C),
     optionally apply pixel quality/cloud masking and contiguity masks,
     and drop time steps that contain greater than a minimum proportion
     of good quality (e.g. non-cloudy or shadowed) pixels.
@@ -126,13 +126,14 @@ def load_ard(
     And Sentinel-2 products:
         * ga_s2am_ard_3
         * ga_s2bm_ard_3
+        * ga_s2cm_ard_3
 
     Cloud masking can be performed using the Fmask (Function of Mask)
     cloud mask for Landsat and Sentinel-2, and the s2cloudless
     (Sentinel Hub cloud detector for Sentinel-2 imagery) cloud mask for
     Sentinel-2.
 
-    Last modified: June 2023
+    Last modified: February 2025
 
     Parameters
     ----------
@@ -142,7 +143,8 @@ def load_ard(
     products : list
         A list of product names to load. Valid options are
         ['ga_ls5t_ard_3', 'ga_ls7e_ard_3', 'ga_ls8c_ard_3', 'ga_ls9c_ard_3']
-        for Landsat, ['ga_s2am_ard_3', 'ga_s2bm_ard_3'] for Sentinel 2.
+        for Landsat, ['ga_s2am_ard_3', 'ga_s2bm_ard_3', 'ga_s2cm_ard_3']
+        for Sentinel 2.
     cloud_mask : string, optional
         The cloud mask used by the function. This is used for both
         masking out poor quality pixels (e.g. clouds) if
@@ -256,21 +258,27 @@ def load_ard(
     # Setup #
     #########
 
+    # Convert products to a list if it is passed as a string
+    products = [products] if isinstance(products, str) else products
+
+    # Valid Landsat products
+    valid_ls = ["ga_ls5t_ard_3", "ga_ls7e_ard_3", "ga_ls8c_ard_3", "ga_ls9c_ard_3"]
+    valid_s2 = ["ga_s2am_ard_3", "ga_s2bm_ard_3", "ga_s2cm_ard_3"]
+
     # Verify that products were provided
     if not products:
         raise ValueError(
-            "Please provide a list of product names to load data from. "
-            "Valid options are: ['ga_ls5t_ard_3', 'ga_ls7e_ard_3', "
-            "'ga_ls8c_ard_3', 'ga_ls9c_ard_3'] for Landsat, and "
-            "['ga_s2am_ard_3', 'ga_s2bm_ard_3'] for Sentinel 2."
+            f"Please provide a list of Landsat or Sentinel-2 Analysis Ready Data "
+            f"product names to load data from. Valid options are: "
+            f"{valid_ls + valid_s2}."
         )
 
     # Determine whether products are all Landsat, all S2, or mixed
-    elif all(["ls" in product for product in products]):
+    elif all([product in valid_ls for product in products]):
         product_type = "ls"
-    elif all(["s2" in product for product in products]):
+    elif all([product in valid_s2 for product in products]):
         product_type = "s2"
-    else:
+    elif all([product in valid_s2 + valid_ls for product in products]):
         product_type = "mixed"
 
         warnings.warn(
@@ -280,6 +288,16 @@ def load_ard(
             "(e.g. Landsat and Sentinel-2's 'nbart_swir_2'); use with "
             "caution."
         )
+    else:
+        # If an invalid product is passed, raise error
+        invalid_products = [
+            product for product in products if product not in valid_s2 + valid_ls
+        ]
+        raise ValueError(
+            f"The `load_ard` function only supports Landsat and "
+            f"Sentinel-2 Analysis Ready Data products; {invalid_products} is not supported. "
+            f"Valid options are: {valid_ls + valid_s2}."
+        )
 
     # Set contiguity band depending on `mask_contiguity`;
     # "oa_nbart_contiguity" if True, False or "nbart",

{dea_tools-0.3.5.dev23 → dea_tools-0.3.6.dev25/dea_tools.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dea-tools
-Version: 0.3.5.dev23
+Version: 0.3.6.dev25
 Summary: Functions and algorithms for analysing Digital Earth Australia data.
 Home-page: https://github.com/GeoscienceAustralia/dea-notebooks
 Author: Geoscience Australia
@@ -44,7 +44,7 @@ Requires-Dist: pyproj
 Requires-Dist: pystac-client
 Requires-Dist: planetary-computer
 Requires-Dist: python-dateutil
-Requires-Dist: pyTMD<=2.1.6
+Requires-Dist: pyTMD!=2.1.7
 Requires-Dist: pytz
 Requires-Dist: rasterio
 Requires-Dist: rasterstats
@@ -65,6 +65,17 @@ Provides-Extra: dask-gateway
 Requires-Dist: dask_gateway; extra == "dask-gateway"
 Provides-Extra: otps
 Requires-Dist: otps; extra == "otps"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 
 dea-tools package

{dea_tools-0.3.5.dev23 → dea_tools-0.3.6.dev25}/dea_tools.egg-info/requires.txt

@@ -26,7 +26,7 @@ pyproj
 pystac-client
 planetary-computer
 python-dateutil
-pyTMD<=2.1.6
+pyTMD!=2.1.7
 pytz
 rasterio
 rasterstats

{dea_tools-0.3.5.dev23 → dea_tools-0.3.6.dev25}/setup.py

@@ -56,7 +56,7 @@ REQUIRED = [
     'pystac-client',
     'planetary-computer',
     'python-dateutil',
-    'pyTMD<=2.1.6',    
+    'pyTMD!=2.1.7',    
     'pytz',
     'rasterio',
     'rasterstats',