Skip to content

README narrative sections are outdated #1045

@brendancol

Description

@brendancol

What's wrong

Main description (line 88):
"implements common raster analysis functions using Numba" undersells a library with 100+ functions spanning surface analysis, hydrology (D8/Dinf/MFD), fire behavior, flood modeling, multispectral indices, interpolation, pathfinding, and more.

GDAL caveat (line 122):
"does not depend on GDAL / GEOS, which makes it fully extensible in Python but does limit the breadth of operations that can be covered" -- the "does limit the breadth" part is outdated. The library now includes native GeoTIFF/COG I/O, reprojection, rasterization, polygonization, and interpolation, none of which need GDAL.

Documentation note (line 124):
"Our documentation is still under construction" is stale. There are 33+ user guide notebooks, full API reference docs, and standalone examples.

Tagline bullets (lines 76-84):
No mention of GPU acceleration (CuPy/CUDA) or the 4-backend dispatch system (NumPy, CuPy, Dask+NumPy, Dask+CuPy).

Proposed fix

Rewrite the narrative paragraphs and taglines to match the library's actual scope, backend support, and documentation state. Leave the feature matrix tables alone.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions