Migrate zonal user guide off datashader

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

Nobody has claimed this yet.

Assessment

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

Research direction

Start with docs/source/user_guide/zonal.ipynb and inspect the cells importing datashader, rasterizing with Canvas().line(), and rendering with shade/stack. Replace those steps with arr.xrs.rasterize(...) and matplotlib, update the prose cells, then re-execute the notebook. Done means it runs top to bottom without a datashader import and regenerates the expected plots and preview image.

Written by the indexing model from the issue text.

Description

area:zonal documentation user-guide-example

Reason or Problem

docs/source/user_guide/zonal.ipynb imports datashader, rasterizes line segments with Canvas().line(), and renders with shade/stack and the Elevation colormap.

Proposal

  • Remove the datashader imports.
  • Replace Canvas().line() line rasterization with arr.xrs.rasterize(...).
  • Replace shade/stack and the Elevation colormap with matplotlib.
  • Update the prose cells, including the line that describes zones as "any region computable as a Datashader aggregate".
  • 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.

Dominant language
Python
Stars
972
Forks
92
Avg merge
2d 12h
Merged PRs (30d)
7

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.

More from xarray-contrib/xarray-spatial

All issues in xarray-contrib/xarray-spatial

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.