xarray-contrib / xarray-contrib/xarray-spatial

Migrate proximity user guide off datashader

Open
#3,454 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area:proximity documentation user-guide-example
Dominant language
Python
Stars
972
Forks
92
Avg merge
2d 12h
Merged PRs (30d)
7

Description

Reason or Problem

docs/source/user_guide/proximity.ipynb imports datashader, rasterizes points with Canvas().points(), and renders with shade/stack/dynspread.

Proposal

  • Remove the datashader imports.
  • Replace Canvas().points() point rasterization with arr.xrs.rasterize(...).
  • Replace shade/stack/dynspread and datashader colormaps with matplotlib.
  • Update the prose cells that describe the datashader workflow.
  • Re-execute the notebook so outputs and the preview image regenerate cleanly.

Done when

  • The notebook runs top to bottom with no datashader import and produces the expected plots.

Part of removing datashader as a dependency; final packaging removal is tracked in #3450.

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 docs/source/user_guide/proximity.ipynb and inspect its imports, plotting cells, and prose describing the datashader workflow. Re-execute the notebook after replacing the named rasterization and rendering steps, then verify it runs top to bottom without datashader and regenerates the expected plots and preview image.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
75/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.