Skip to main content

Conveniently search, download, and preprocess ArcticDEM and REMA products.

Project description

pDEMtools

Conveniently search, download, and process ArcticDEM and REMA products

conda-forge version PyPI version Documentation Status Unit Tests JOSS paper

pDEMtool provides a convenient set of functions to explore, download, and preprocess high-resolution DEMs of the polar regions from the ArcticDEM (Porter et al. 2022; 2023) and Reference Elevation Model of Antarctica (REMA; Howat et al. 2022a, b) products, courtesy of the Polar Geospatial Center (PGC).

The first aim of pDEMtools is to enable access to ArcticDEM and REMA mosaics and multitemporal strips using the search() function and load module:

  • search(): This function aims to replicate the kind of convenient catalogue searching available when querying a dynamic STAC catalogue (e.g. pystac_client), allowing users to easily find relevant ArcticDEM and REMA strips for their areas of interest.
  • load: This module provides simple one-line functions to preview and download strips and mosaics from the relevant AWS bucket to an xarray Dataset.

The second aim is to provide (pre)processing functions specific to the sort of uses that ArcticDEM and REMA users might want (e.g. a focus on ice sheet and cryosphere work), as well as the particular strengths of ArcticDEM and REMA datasets (high-resolution and multitemporal). Tools include:

  • Terrain attribute derivation (hillshade, slope, aspect, various curvatures) using a 5x5 polynomial fit suited for high-resolution data.
  • Quick geoid correction using BedMachine source data.
  • Simple coregistration for quick elevation change analysis.
  • Identifying/masking sea level and icebergs.

Rather than introducing custom classes, pDEMtools will always try and return DEM data as an xarray DataArray with geospatial metadata via the rioxarray extension. The aim is to allow the user to quickly move beyond pDEMtools into their own analysis in whatever format they desire, be that xarray, numpy or dask datasets, DEM-specific Python packages such as xdem for advanced coregistration or richdem for flow analysis, or exporting to geospatial file formats for analysis beyond Python.

Contact: thomas.r.chudley@durham.ac.uk

Quick Install

The latest release of pdemtools can installed using conda:

$ conda install pdemtools -c conda-forge

Please visit the pDEMtools readthedocs for more information on installing, using, and contributing to pDEMtools.

Cite

A software paper is being prepared for the Journal of Open Source Software. In the meantime, the use of the pDEMtools package can be cited as follows:

Chudley, T. R. and Howat, I. M. (2024) pDEMtools: conveniently search, download, and process ArcticDEM and REMA products (vX.X.X). GitHub. https://github.com/trchudley/pDEMtools

or by using bibtex:

@software{pDEMtools
   author = {Chudley, Thomas R. and Howat, Ian M.}, title = {pDEMtools: conveniently search, download, and process ArcticDEM and REMA products}, year = 2024, publisher = {GitHub}, version = {X.X.X}, url = {https://github.com/trchudley/pDEMtools} 
}

When using ArcticDEM and REMA products, please cite the datasets appropriately and acknowledge the PGC.

Several algorithms implemented in the library were developed by others. These will be highlighted in the documentation, and the original authors should be properly cited when used. For example:

We masked sea ice and melange following the method of Shiggins et al. (2023) as implemented in pDEMtools (Chudley and Howat, 2024).

Refererences

Howat, I., et al. (2022a). The Reference Elevation Model of Antarctica – Strips, Version 4.1. Harvard Dataverse https://doi.org/10.7910/DVN/X7NDNY

Howat, I., et al. (2022b). The Reference Elevation Model of Antarctica – Mosaics, Version 2, Harvard Dataverse https://doi.org/10.7910/DVN/EBW8UC

Porter, C., et al. (2022). ArcticDEM - Strips, Version 4.1. Harvard Dataverse. https://doi.org/10.7910/DVN/OHHUKH

Porter, C., et al. (2023), ArcticDEM, Version 4.1, Harvard Dataverse. https://doi.org/10.7910/DVN/3VDC4W

Acknowledgements

ArcticDEM: DEMs are provided by the Polar Geospatial Center under NSF-OPP awards 1043681, 1559691, and 1542736.

REMA: DEMs are provided by the Byrd Polar and Climate Research Center and the Polar Geospatial Center under NSF-OPP awards 1543501, 1810976, 1542736, 1559691, 1043681, 1541332, 0753663, 1548562, 1238993 and NASA award NNX10AN61G. Computer time provided through a Blue Waters Innovation Initiative. DEMs produced using data from Maxar.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdemtools-0.8.5.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

pdemtools-0.8.5-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file pdemtools-0.8.5.tar.gz.

File metadata

  • Download URL: pdemtools-0.8.5.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pdemtools-0.8.5.tar.gz
Algorithm Hash digest
SHA256 08022ff55b9737168cc742bb83f32356e00b62f6091c56a199381ca7789dd3e2
MD5 64d09f3871ab531db5bceda69b82d86c
BLAKE2b-256 c41d479d03b9ff2f03efc48afe325087b2a9a65640a74d40f0e6523892900e27

See more details on using hashes here.

File details

Details for the file pdemtools-0.8.5-py3-none-any.whl.

File metadata

  • Download URL: pdemtools-0.8.5-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for pdemtools-0.8.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f2afb0363722305cb4aedb08db8d5d9b9eae08ebd8725a1cfe07fa0302f91745
MD5 5eb3aac6d27a26b50e35275e2d3193c3
BLAKE2b-256 47e3183448aed7f24a5c0b8b59c09c16633944a3b7d9b977aef128c4b2fbcc4a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page