WhiteboxGUI

2.3.0 verified Fri May 01 auth: no python

An interactive GUI for whitebox-tools designed for Jupyter-based environments. Current version 2.3.0 (October 2023), updates follow WhiteboxTools releases.

pip install whiteboxgui

Common errors

error ModuleNotFoundError: No module named 'whiteboxgui' ↓

cause Library not installed

fix

Run 'pip install whiteboxgui' in the environment where the Jupyter kernel runs.

error WhiteboxToolsError: The whitebox-tools executable could not be found. ↓

cause WhiteboxTools backend binary missing

fix

Ensure internet access. The GUI will attempt to download the binary automatically. Alternatively, install whitebox-tools via 'pip install whitebox' or place the executable in PATH.

Warnings

gotcha Requires whitebox-tools (WhiteboxTools) backend. The GUI will automatically download the binary if not found, but ensure internet access on first run. ↓

fix Install whitebox-tools separately via pip install whitebox or let the GUI download it automatically.

gotcha The GUI uses Voilà; in classic Jupyter Notebook, you may need to enable the cell output widget mode (e.g., jupyter nbextension enable --py widgetsnbextension). ↓

fix Install ipywidgets and enable extensions: pip install ipywidgets && jupyter nbextension enable --py widgetsnbextension

gotcha If running on Google Colab or a remote Jupyter server, the GUI may not display correctly. Use show(host='127.0.0.1', port=8081) or similar to expose locally. ↓

fix Pass appropriate host and port arguments to show().

Imports

show
```
from whiteboxgui import show
```
No common wrong import; just use the show function.

Quickstart

Launch the WhiteboxTools GUI in a Jupyter notebook cell.

from whiteboxgui import show
show()