{"id":24831,"library":"whiteboxgui","title":"WhiteboxGUI","description":"An interactive GUI for whitebox-tools designed for Jupyter-based environments. Current version 2.3.0 (October 2023), updates follow WhiteboxTools releases.","status":"active","version":"2.3.0","language":"python","source_language":"en","source_url":"https://github.com/giswqs/whiteboxgui","tags":["whitebox-tools","geospatial","gui","jupyter"],"install":[{"cmd":"pip install whiteboxgui","lang":"bash","label":"PyPI installation"}],"dependencies":[],"imports":[{"note":"No common wrong import; just use the show function.","symbol":"show","correct":"from whiteboxgui import show"}],"quickstart":{"code":"from whiteboxgui import show\nshow()","lang":"python","description":"Launch the WhiteboxTools GUI in a Jupyter notebook cell."},"warnings":[{"fix":"Install whitebox-tools separately via pip install whitebox or let the GUI download it automatically.","message":"Requires whitebox-tools (WhiteboxTools) backend. The GUI will automatically download the binary if not found, but ensure internet access on first run.","severity":"gotcha","affected_versions":"all"},{"fix":"Install ipywidgets and enable extensions: pip install ipywidgets && jupyter nbextension enable --py widgetsnbextension","message":"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).","severity":"gotcha","affected_versions":"all"},{"fix":"Pass appropriate host and port arguments to show().","message":"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.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install whiteboxgui' in the environment where the Jupyter kernel runs.","cause":"Library not installed","error":"ModuleNotFoundError: No module named 'whiteboxgui'"},{"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.","cause":"WhiteboxTools backend binary missing","error":"WhiteboxToolsError: The whitebox-tools executable could not be found."}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}