pdemtools 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

pdemtools/__init__.py

@@ -13,6 +13,6 @@ from . import _coreg
 from . import _geomorphometry
 from . import _utils
 
-__version__ = "1.0.0"
+__version__ = "1.1.1"
 
 __all__ = ["search", "DemAccessor"]

pdemtools/_accessor.py

@@ -647,6 +647,8 @@ class DemAccessor:
             or ("unsphericity_curvature" in attribute)
             or ("maximal_curvature" in attribute)
             or ("minimal_curvature" in attribute)
+            or ("horizontal_excess" in attribute)
+            or ("vertical_excess" in attribute)
         ):
             mean_curvature_arr = mean_curvature(p_arr, q_arr, t_arr, r_arr, s_arr)
 
@@ -655,6 +657,8 @@ class DemAccessor:
             or ("unsphericity_curvature" in attribute)
             or ("maximal_curvature" in attribute)
             or ("minimal_curvature" in attribute)
+            or ("horizontal_excess" in attribute)
+            or ("vertical_excess" in attribute)
         ):
             gaussian_curvature_arr = gaussian_curvature(
                 p_arr, q_arr, t_arr, r_arr, s_arr
@@ -664,6 +668,8 @@ class DemAccessor:
             ("unsphericity_curvature" in attribute)
             or ("maximal_curvature" in attribute)
             or ("minimal_curvature" in attribute)
+            or ("horizontal_excess" in attribute)
+            or ("vertical_excess" in attribute)
         ):
             unsphericity_curvature_arr = unsphericity_curvature(
                 mean_curvature_arr, gaussian_curvature_arr

pdemtools/data.py

@@ -39,7 +39,9 @@ def geoid_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataArray:
     geoid = rxr.open_rasterio(f"{bm_fpath}")["geoid"]
     geoid_crs = geoid.rio.crs
     geoid = geoid.squeeze().astype("float32").rio.write_crs(geoid_crs)
-    geoid = geoid.rio.reproject_match(target_rxd, Resampling.bilinear)
+    geoid = geoid.rio.reproject_match(
+        match_data_array=target_rxd, resampling=Resampling.bilinear
+    )
 
     return geoid.squeeze()
 
@@ -63,7 +65,9 @@ def geoid_from_raster(fpath: str, target_rxd: DataArray = None) -> DataArray:
     geoid = geoid.squeeze().astype("float32").rio.write_crs(geoid_crs)
 
     if target_rxd != None:
-        geoid = geoid.rio.reproject_match(target_rxd, Resampling.bilinear)
+        geoid = geoid.rio.reproject_match(
+            match_data_array=target_rxd, resampling=Resampling.bilinear
+        )
 
     return geoid.squeeze()
 
@@ -135,7 +139,9 @@ def bedrock_mask_from_bedmachine(bm_fpath: str, target_rxd: DataArray) -> DataAr
     # Reample using bilinear resampling rather than nearest neighbour, as mask
     # resolution is much larger than DEM resolution
     mask = mask.squeeze().astype("float32").rio.write_crs(mask_crs)
-    mask = mask.rio.reproject_match(target_rxd, Resampling.bilinear)
+    mask = mask.rio.reproject_match(
+        match_data_array=target_rxd, resampling=Resampling.bilinear
+    )
 
     # Set interpolated values to boolean (1/0) values again
     mask = mask.round()

pdemtools/load.py

@@ -1,5 +1,5 @@
-"""This module contains functions necessary to open an ArcticDEM/REMA strip as an 
-xarray DataArray, from either local or AWS sources. 
+"""This module contains functions necessary to open an ArcticDEM/REMA strip as an
+xarray DataArray, from either local or AWS sources.
 """
 
 import os
@@ -40,6 +40,7 @@ def from_fpath(
     bounds: Optional[Union[tuple, Polygon]] = None,
     bitmask_fpath: Optional[str] = None,
     pad: Optional[bool] = False,
+    chunks: Optional[Union[int, tuple, dict]] = None,
 ) -> DataArray:
     """Given a filepath (local or an AWS link), loads the desired ArcticDEM/REMA DEM
     strip as an ``xarray`` ``DataArray``. Option to filter to bounds and bitmask, if
@@ -59,6 +60,9 @@ def from_fpath(
     :param pad: If the DEM strip is not the full extent of the given bounds,
         pad with NaNs to match the full bounds. Defaults to False.
     :type pad: bool
+    :param chunks: Chunk size for `rioxarray.open_rasterio`, triggering `dask`
+        parallelisation and lazy evaluation/loading. Defaults to `None`.
+    :type chunks: int | tuple | dict
 
     :returns: xarray DataArray of DEM strip
     :rtype: DataArray
@@ -69,7 +73,7 @@ def from_fpath(
         raise ValueError("pad must be True or False")
 
     # Open dataarray using rioxarray
-    dem = rxr.open_rasterio(dem_fpath)
+    dem = rxr.open_rasterio(dem_fpath, chunks=chunks)
 
     # Convert shapely geometry to bounds
     if isinstance(bounds, Polygon):
@@ -169,6 +173,7 @@ def from_search(
     bounds: Optional[Union[tuple, Polygon]] = None,
     bitmask: Optional[bool] = True,
     pad: Optional[bool] = False,
+    chunks: Optional[Union[int, tuple, dict]] = None,
 ):
     """Given a row from the GeoDataFrame output of ``pdemtools.search()``, loads the 2
     m DEM strip of the desired ArcticDEM/REMA DEM strip as an xarray DataArray.
@@ -190,6 +195,9 @@ def from_search(
     :param pad: If the DEM strip is not the full extent of the given bounds,
         pad with NaNs to match the full bounds. Defaults to False.
     :type pad: bool
+    :param chunks: Chunk size for `rioxarray.open_rasterio`, triggering `dask`
+        parallelisation and lazy evaluation/loading. Defaults to `None`.
+    :type chunks: int | tuple | dict
 
     :returns: xarray DataArray of DEM strip
     :rtype: DataArray
@@ -223,6 +231,7 @@ def from_search(
         bounds,
         bitmask_url,
         pad,
+        chunks,
     )
 
 
@@ -236,6 +245,7 @@ def from_id(
     version: Optional[str] = "s2s041",
     preview: Optional[bool] = False,
     pad: Optional[bool] = False,
+    chunks: Optional[Union[int, tuple, dict]] = None,
 ) -> DataArray:
     """An alternative method of loading the selected ArcticDEM/REMA strip, which
     requires only the geocell and the dem_id (e.g. ``geocell = 'n70w051'``, ``dem_id =
@@ -270,6 +280,9 @@ def from_id(
     :param pad: If the DEM strip is not the full extent of the given bounds,
         pad with NaNs to match the full bounds. Defaults to False.
     :type pad: bool
+    :param chunks: Chunk size for `rioxarray.open_rasterio`, triggering `dask`
+        parallelisation and lazy evaluation/loading. Defaults to `None`.
+    :type chunks: int | tuple | dict
 
     :return: xarray DataArray of DEM strip
     :rtype: DataArray
@@ -309,6 +322,7 @@ def from_id(
         bounds,
         bitmask_fpath,
         pad,
+        chunks,
     )
 
 
@@ -317,6 +331,7 @@ def mosaic(
     resolution: Literal["2m", "10m", "32m"],
     bounds: Union[tuple, Polygon] = None,
     version: Optional[Literal["v2.0", "v3.0", "v4.1"]] = None,
+    chunks: Optional[Union[int, tuple, dict]] = None,
 ):
     """Given a dataset, resolution, and bounding box, downloads the ArcticDEM or REMA
     mosiac from AWS.
@@ -333,6 +348,12 @@ def mosaic(
     :param bounds: Clip to bounds [xmin, ymin, xmax, ymax], in EPSG:3413 (ArcticDEM) or
         EPSG:3031 (REMA). Will accept a shapely geometry to extract bounds from.
     :type bounds: tuple | Polygon, optional
+    :param chunks: Chunk size for `rioxarray.open_rasterio`, triggering `dask`
+        parallelisation and lazy evaluation/loading. Defaults to `None`.
+    :type chunks: int | tuple | dict
+
+    :return: xarray DataArray of DEM mosaic
+    :rtype: DataArray
     """
 
     # sanity check that datset and versioning is correct versioning is valid for selected dataset
@@ -382,7 +403,7 @@ def mosaic(
 
         if len(tiles) < 1:
             raise ValueError(
-                "No {dataset} mosaic tiles found to intersect with bounds {aoi}"
+                f"No {dataset} mosaic tiles found to intersect with bounds {aoi}"
             )
 
         # get aws filepaths from the tiles dataframe
@@ -401,13 +422,14 @@ def mosaic(
     # load dem(s)
     dems = []
     for fpath in fpaths:
-        dem = rxr.open_rasterio(fpath).rio.clip_box(*bounds)
+        dem = rxr.open_rasterio(fpath, chunks=chunks).rio.clip_box(*bounds)
         dems.append(dem)
 
     if len(fpaths) == 1:
-        dem = rxr.open_rasterio(fpaths[0]).rio.clip_box(*bounds)
+        dem = rxr.open_rasterio(fpaths[0], chunks=chunks).rio.clip_box(*bounds)
 
-    # If multiple dems, merge them
+    # If multiple dems, merge them - NB I don't know whether this breaks lazy
+    # evaluation for chunked data
     if len(dems) > 1:
         dem = merge_arrays(dems)
     else:

{pdemtools-1.0.0.dist-info → pdemtools-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: pdemtools
-Version: 1.0.0
+Version: 1.1.1
 Summary: Conveniently search, download, and preprocess ArcticDEM and REMA products.
 Author-email: Tom Chudley <thomas.r.chudley@durham.ac.uk>
 License: MIT
@@ -31,6 +31,7 @@ Requires-Dist: scipy
 Requires-Dist: numba
 Requires-Dist: pyarrow
 Requires-Dist: fiona
+Dynamic: license-file
 
 # pDEMtools
 

{pdemtools-1.0.0.dist-info → pdemtools-1.1.1.dist-info}/RECORD

@@ -1,17 +1,17 @@
-pdemtools/__init__.py,sha256=QbCIoVYggnEhM2tYlm-vXeCho7BZ5FtBjFQsoKbxhBE,368
-pdemtools/_accessor.py,sha256=zA3-snzOrQmLgvqYsthNlNlPUYmCHLRGsaCizIdgvJE,36093
+pdemtools/__init__.py,sha256=10dFofcTAy7HFiTCt-D8erAyYwU5djFiwhZI3j5mlY0,368
+pdemtools/_accessor.py,sha256=RNxts9ruziueo3-sZBruU2DmDmaZumBA7Kac9w_Zn3Y,36387
 pdemtools/_coreg.py,sha256=n6idsTsCeATzxrD4foeLJ4-QqUM-4HkfCX8OKIUDY3c,16577
 pdemtools/_geomorphometry.py,sha256=NyGb-z2_ZrEuiwi37zjI7z-J0Zr-Wnt2KMkiVP1NxAw,8739
 pdemtools/_index_search.py,sha256=KLbU1GIezrumL4nMaLe0C074uKThbnprdDnPw2yYLfk,20180
 pdemtools/_utils.py,sha256=Bym7p9yKOy3lHpGGaMEdYxD8dvpZ8CO_MCWXCuc4CRk,2280
-pdemtools/data.py,sha256=9lEDN8K-zTjD8mArDpE3bwfjkQmHiIOYzqHrWYCAC4E,13831
-pdemtools/load.py,sha256=I-KlFcMS9q3nJ9GUa_NqMXokk7pPiOrmJvtb54NyAlQ,17288
+pdemtools/data.py,sha256=6peONDu-qAQtz5KAFd2m3AaLeM8FNMWVQfuYcDNydAU,13965
+pdemtools/load.py,sha256=73RHYuoo9fsY2SST4zDQTHOt2cWx8KWdyVQZqjnAoLQ,18480
 pdemtools/mosaic_index/ArcticDEM_Mosaic_Index_v3_gpkg.gpkg,sha256=15f2IEo0mnz8LAamm_UG_x_2e0q7k8HnVd_dUSg_O3Y,8540160
 pdemtools/mosaic_index/ArcticDEM_Mosaic_Index_v4_1_gpkg.gpkg,sha256=vDrBdlLtmy0dcKYvaORCOWTkWzYtwK5B3JnQiCThL8s,8552448
 pdemtools/mosaic_index/REMA_Mosaic_Index_v2_gpkg.gpkg,sha256=HrRKp5lWpbCOmpHwANHSVc_eO0qo11J42CGuQEmmUQc,5177344
 pdemtools/test_data/test_arcticdem_index_kiv_steenstrup.parquet,sha256=Nzg3HXPbef4VgrnZXiAAa8RxmhBcFoqMNiFpm3_u99Y,91756
-pdemtools-1.0.0.dist-info/LICENSE.md,sha256=JbOkncS9jKLCvDWUpTApk8QhBLtfy-pRs74Gw6mVVPk,1068
-pdemtools-1.0.0.dist-info/METADATA,sha256=U_elv80gKuPzyFLbFs1SvtQ556HdZ7DmELdhkgQYVB0,7192
-pdemtools-1.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-pdemtools-1.0.0.dist-info/top_level.txt,sha256=nTm0PsXQSEKsrI9f5XKoiQor9c_pLGgxuuWt5l425GM,10
-pdemtools-1.0.0.dist-info/RECORD,,
+pdemtools-1.1.1.dist-info/licenses/LICENSE.md,sha256=JbOkncS9jKLCvDWUpTApk8QhBLtfy-pRs74Gw6mVVPk,1068
+pdemtools-1.1.1.dist-info/METADATA,sha256=mitTlWdyex6MrlxDjs5XXgv5okRKhs66xAOaDnZJtt8,7214
+pdemtools-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pdemtools-1.1.1.dist-info/top_level.txt,sha256=nTm0PsXQSEKsrI9f5XKoiQor9c_pLGgxuuWt5l425GM,10
+pdemtools-1.1.1.dist-info/RECORD,,

{pdemtools-1.0.0.dist-info → pdemtools-1.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any