pydata / pydata/xarray

New Xarray accessor for DEMs through xDEM

Open
#8,040 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

community contrib-good-first-issue topic-documentation
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

Hi all,

(Co-opening in rioxarray due to the raster nature of the accessor: https://github.com/corteva/rioxarray/issues/687)

Following what is asked in the doc, I'm letting you know that we intend to write an xarray accessor to enable functions specific to digital elevation models in our package xDEM! 🙂

The accessor would mirror all the functionalities we have (and future ones):

  • Vertical CRS transformation (not yet supported by rasterio so built on top of pyproj directly, would build on top of rioxarray in the accessor),
  • Terrain attributes (I see a bit of overlap with xarray-spatial in "Surface": https://xarray-spatial.org/user_guide/surface.html for some of these; we have more published versions which can be parametrized, so I guess that's OK? I could start a discussion there to coordinate future development),
  • 3D registration,
  • Terrain corrections,
  • Error estimation and propagation (may be moved to GeoUtils as not specific to DEMs but all rasters, see https://github.com/pydata/xarray/issues/8041; eventually using ObsArray).

I was thinking of using the accessor name dem, e.g.: ds.dem.to_vcrs(), ds.dem.profile_curvature() or ds.dem.coregister(). I didn't catch any overlap with other efforts. Would that work fine?

Thanks! (and for the great work on xarray!)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin with the linked rioxarray issue and the proposed xDEM functionality list, including vertical CRS transformation, terrain attributes, registration, and corrections. Done would require an agreed accessor scope and API for xarray, but this issue names no implementation files or tests and remains a broad design proposal.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.