---
id: whitebox
version: "2.3.6"
license: MIT license
license_treatment: permissive
maintenance: aging
---

# whitebox — An advanced geospatial data analysis platform 

License: permissive · Maintenance: aging · Downloads: 123.0K/mo

## What it is and what it does

Whitebox is a Python wrapper around WhiteboxTools, an advanced geospatial analysis platform developed at the University of Guelph. It provides access to a large library of tools for processing raster data in GIS, remote sensing, hydrological, terrain, and LiDAR analysis workflows. The package is designed as an analytical backend—it performs computations on spatial data but is not a visualization or cartography tool; users typically pair it with separate GIS or plotting software.

The library supports common raster formats including GeoTIFF, ESRI ASCII, GRASS GIS, and others. Tools are callable using either snake_case or CamelCase naming conventions. A graphical interface (WhiteboxTools Runner) is also available. Installation is simple and the package has minimal dependencies, requiring only Click.

Use it for:

- Automate watershed delineation, flow accumulation, and stream network analysis for hydrological studies
- Process and classify LiDAR point clouds, generate DEMs, and perform terrain indexing (slope, curvature, wetness)
- Apply image enhancement, filtering, and k-means classification to remote sensing imagery
- Perform cost-distance analysis, buffer operations, and raster reclassification in GIS workflows
- Batch process large raster datasets using Python scripts without manual GIS GUI interaction

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Whitebox is a Python frontend to WhiteboxTools, a geospatial analysis platform that performs GIS operations, remote sensing tasks, hydrological analysis, terrain analysis, and LiDAR processing on raster data.

Yes, if you need a scriptable, lightweight backend for geospatial raster analysis. The package is well-maintained, has no known vulnerabilities, and low install friction. The aging status (537 days since last release) is a minor concern but the repository is still active. Best suited for developers who want programmatic access to GIS and terrain analysis tools rather than a full interactive GIS environment.

## Install

pip install whitebox
uv add whitebox
poetry add whitebox

## Installing whitebox

Before you install: Installation is straightforward with low friction—a pure Python wheel with only Click as a runtime dependency. The package is aging (537 days since last release) but the repository remains active with recent commits and no archived status.

License in practice: Distributed under the MIT license, a permissive open-source license that allows commercial and private use with minimal restrictions.

Quickstart:

pip install whitebox

import whitebox
wbt = whitebox.WhiteboxTools()
wbt.set_working_dir('/path/to/data')
wbt.feature_preserving_smoothing('input.tif', 'output.tif', filter=9)

On Linux, if '_tkinter' import fails, install python3-tk system package. GLIBC compatibility issues may require setting WBT_LINUX=MUSL environment variable before import.

Verify before relying:

- Whether the 518 tools mentioned in the description are all accessible and functional in version 2.3.6
- Current Python version support—classifiers list 3.4–3.6 but requires_python is unspecified
- Performance characteristics and memory requirements for large LiDAR datasets

## Package facts

- License: MIT license (permissive)
- Python support: unspecified
- Install friction: low
- Maintenance: aging
- Downloads: 123.0K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

geospatial analysis python, GIS raster processing, terrain analysis tools, LiDAR point cloud processing, hydrological watershed analysis, remote sensing image processing, DEM analysis python, geospatial, raster-analysis, gis

[View on SkillFed](https://skillfed.io/packages/whitebox) · [View on PyPI](https://pypi.org/project/whitebox/)