Skip to main content

Analysis of digital elevation models (DEMs)

Project description

xDEM: robust analysis of DEMs in Python.

Documentation Status build Conda Version Conda Platforms Conda Downloads PyPI version Coverage Status

Binder Pre-Commit Formatted with black Checked with mypy Imports: isort

xDEM is an open source project to develop a core Python package for the analysis of digital elevation models (DEMs).

It aims at providing modular and robust tools for the most common analyses needed with DEMs, including both geospatial operations specific to DEMs and a wide range of 3D alignment and correction methods from published, peer-reviewed studies. The core manipulation of DEMs (e.g., vertical alignment, terrain analysis) are conveniently centered around a DEM class (that, notably, re-implements all tools of gdalDEM). More complex pipelines (e.g., 3D rigid coregistration, bias corrections, filtering) are built around modular Coreg, BiasCorr classes that easily interface between themselves. Finally, xDEM includes advanced uncertainty analysis tools based on spatial statistics of SciKit-GStat.

Additionally, xDEM inherits many convenient functionalities from GeoUtils such as implicit loading, numerical interfacing and convenient object-based geospatial methods to easily perform the most common higher-level tasks needed by geospatial users (e.g., reprojection, cropping, vector masking). Through GeoUtils, xDEM relies on Rasterio, GeoPandas and Pyproj for georeferenced calculations, and on NumPy and Xarray for numerical analysis. It allows easy access to the functionalities of these packages through interfacing or composition, and quick inter-operability through object conversion.

If you are looking for an accessible Python package to write the Python equivalent of your GDAL command lines, or of your QGIS analysis pipeline without a steep learning curve on Python GIS syntax, xDEM is perfect for you! For more advanced users, xDEM also aims at being efficient and scalable by supporting lazy loading and parallel computing (ongoing).

Documentation

For a quick start, full feature description or search through the API, see xDEM's documentation at: https://xdem.readthedocs.io.

Installation

With mamba

mamba install -c conda-forge xdem

See mamba's documentation to install mamba, which will solve your environment much faster than conda.

With pip

pip install xdem

Citing methods implemented in the package

When using a method implemented in xDEM, please cite both the package and the related study:

Citing xDEM: Zenodo

Citing the related study:

Contributing

We welcome new contributions, and will happily help you integrate your own DEM routines into xDEM!

After discussing a new feature or bug fix in an issue, you can open a PR to xDEM with the following steps:

  1. Fork the repository, make a feature branch and push changes.
  2. When ready, submit a pull request from the feature branch of your fork to GlacioHack/xdem:main.
  3. The PR will be reviewed by at least one maintainer, discussed, then merged.

More details on our contributing page.

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

xdem-0.1.5.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

xdem-0.1.5-py3-none-any.whl (168.0 kB view details)

Uploaded Python 3

File details

Details for the file xdem-0.1.5.tar.gz.

File metadata

  • Download URL: xdem-0.1.5.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for xdem-0.1.5.tar.gz
Algorithm Hash digest
SHA256 595c38c8cd586dbcf2e554068b0b13b32d1799608fd03b4231e167a95882ec2d
MD5 9b19a27ac792565ae1354f53f976b0f8
BLAKE2b-256 4a411e09dd3b2468bfb9bc0e4778c4afa57c1b3ac7a70d072a079fe7ba9da388

See more details on using hashes here.

File details

Details for the file xdem-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: xdem-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 168.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for xdem-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 23bf4faa4c4d879db999b1bf2b54a71546c269f7a2f8e62686801d4a1cd19909
MD5 04f2df443ffacee41e4302cc76d5a242
BLAKE2b-256 413a5294c1eaebde124b1fea7ff98e7b9e5a231704bc278984e2f5ce6483dece

See more details on using hashes here.

Supported by

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