pydata / pydata/xarray

Add an example page to the docs on geospatial filtering/indexing

Open
#1,861 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We cover standard time-series stuff pretty well in the "Toy weather data" example, but geospatial filtering/indexing questions come up all the time aren't well covered.

Topics could include:

  • How to filter out a region of interest (sel() with slice and where(..., drop=True))
  • How to align two gridded datasets in space.
  • How to sample a gridded dataset at a list of station locations
  • How to resample a dataset to a new resolution (possibly referencing xESMF)

Not all of these are as smooth as they could be, but hopefully that will clearly point to where we have room for improvement in our APIs :).

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

Start with the existing "Toy weather data" documentation example and review the listed xarray operations: sel(), where(..., drop=True), spatial alignment, station sampling, and resampling, including the xESMF reference. Done means adding a docs example page that clearly demonstrates the relevant geospatial filtering and indexing workflows.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.