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

pDEMtools 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 allow users to easily query the PGC STAC API to 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 for pdemtools is published in the Journal of Open Source Software, and can be cited as follows:

Chudley, T. R., and Howat, I. M. (2024). pDEMtools: conveniently search, download, and process ArcticDEM and REMA products. Journal of Open Source Software, 9(102), 7149, doi.org/10.21105/joss.07149

or by using bibtex:

@article{Chudley2024,
  title = {pDEMtools: conveniently search,  download,  and process ArcticDEM and REMA products},
  volume = {9},
  ISSN = {2475-9066},
  url = {http://dx.doi.org/10.21105/joss.07149},
  DOI = {10.21105/joss.07149},
  number = {102},
  journal = {Journal of Open Source Software},
  publisher = {The Open Journal},
  author = {Chudley,  Thomas R. and Howat,  Ian M.},
  year = {2024},
  pages = {7149}
}

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-1.2.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pdemtools-1.2.0.tar.gz
Algorithm Hash digest
SHA256 e6d9a64fd707a33318fb19b123d23127894d2caf851a4aff814395bf130e5ba5
MD5 17c7578cf3e39ec64adcf91f767501e5
BLAKE2b-256 7de30afb5487c24919f94559a45d3bffb75ec4e716e2d94bc3dbe7147b1c5c80

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pdemtools-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 031349857e01d8496d79c45ff7a10d9628a20dcf3211da493277fd88aa995afc
MD5 064579f9d862e9e1fce61f28010c351a
BLAKE2b-256 7b9a0178f640a7e0400c1e43f9b00253c3d29f85525b544af7292174e2f85e49

See more details on using hashes here.

Supported by

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