.. image:: https://colab.research.google.com/assets/colab-badge.svg :target: https://gishub.org/whitebox-colab
.. image:: https://mybinder.org/badge_logo.svg :target: https://gishub.org/whitebox-cloud
.. image:: https://img.shields.io/pypi/v/whitebox.svg :target: https://pypi.python.org/pypi/whitebox
.. image:: https://pepy.tech/badge/whitebox :target: https://pepy.tech/project/whitebox
.. image:: https://anaconda.org/conda-forge/whitebox/badges/version.svg :target: https://anaconda.org/conda-forge/whitebox
.. image:: https://readthedocs.org/projects/whitebox/badge/?version=latest :target: https://whitebox.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg :target: https://opensource.org/licenses/MIT
.. image:: https://img.shields.io/badge/Donate-Buy%20me%20a%20coffee-yellowgreen.svg :target: https://www.buymeacoffee.com/opengeos
.. image:: https://i.imgur.com/Ic8BA7C.png
This repository is related to the WhiteboxTools Python Frontend only. You can report issues to this repo if you have problems installing this Python package. If you encounter any tool functioning specific errors, please open an issue_ on Dr. John Lindsay's WhiteboxTools_ repo.
Links
MIT license_Contents
Description_Installation_whitebox Tutorials_whitebox GUI_Available Tools_Supported Data Formats_Contributing_License_Reporting Bugs_Credits_The whitebox Python package is built on WhiteboxTools, an advanced geospatial data analysis platform developed by Prof. John Lindsay (webpage_; jblindsay_) at the University of Guelph's Geomorphometry and Hydrogeomatics Research Group_. WhiteboxTools can be used to perform common geographical information systems (GIS) analysis operations, such as cost-distance analysis, distance buffering, and raster reclassification. Remote sensing and image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), and common image transformations. WhiteboxTools also contains advanced tooling for spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices such as slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), and LiDAR data processing. LiDAR point clouds can be interrogated (LidarInfo, LidarHistogram), segmented, tiled and joined, analyized for outliers, interpolated to rasters (DEMs, intensity images), and ground-points can be classified or filtered. WhiteboxTools is not a cartographic or spatial data visualization package; instead it is meant to serve as an analytical backend for other data visualization software, mainly GIS.
whitebox supports a variety of platforms, including Microsoft Windows, macOS, and Linux operating systems. Note that you will need to have Python 3.x installed. Python 2.x is not supported. The whitebox Python package can be installed using the following command:
.. code:: python
pip install whitebox
If you have installed whitebox Python package before and want to upgrade to the latest version, you can use the following command:
.. code:: python
pip install whitebox -U
It is recommended that you use a Python virtual environment (e.g., conda) to test the whitebox package. Please follow the conda user guide_ to install conda if necessary. Once you have conda installed, you can use Terminal or an Anaconda Prompt to create a Python virtual environment. Check managing Python environment_ for more information.
.. code:: python
conda create -n wbt python source activate wbt conda install whitebox -c conda-forge
If you encounter an GLIBC errors when installing the whitebox package, you can try the following command:
.. code:: python
import whitebox whitebox.download_wbt(linux_musl=True, reset=True)
Alternatively, you can set the environment variable WBT_LINUX to MUSL before installing the whitebox package. It will automatically download the MUSL version of WhiteboxTools.
.. code:: python
import os os.environ["WBT_LINUX"] = "MUSL"
Launch the whitebox tutorial notebook directly with mybinder.org now:
.. image:: https://mybinder.org/badge_logo.svg :target: https://gishub.org/whitebox-cloud
Tool names in the whitebox Python package can be called either using the snake_case or CamelCase convention (e.g. lidar_info or LidarInfo). See below for an example Python script (example.py_). If you are interested in using the WhiteboxTools command-line program, check WhiteboxTools Usage_.
.. code:: python
import os
import pkg_resources
import whitebox
wbt = whitebox.WhiteboxTools()
print(wbt.version())
print(wbt.help())
# identify the sample data directory of the package
data_dir = os.path.dirname(pkg_resources.resource_filename("whitebox", 'testdata/'))
wbt.set_working_dir(data_dir)
wbt.verbose = False
wbt.feature_preserving_smoothing("DEM.tif", "smoothed.tif", filter=9)
wbt.breach_depressions("smoothed.tif", "breached.tif")
wbt.d_inf_flow_accumulation("breached.tif", "flow_accum.tif")
This tutorial can be accessed in three ways:
Launch this tutorial as an interactive Jupyter Notebook on the cloud - https://gishub.org/whitebox-cloud.
.. image:: https://i.imgur.com/LF4UE1j.gif
WhiteboxTools also provides a Graphical User Interface (GUI) - WhiteboxTools Runner, which can be invoked using the following Python script:
.. code:: python
import whitebox whitebox.Runner()
.. image:: https://wetlands.io/file/images/whitebox.png
When using import whitebox, if you get an error that says No module named '_tkinter', please install the python3-tk package, you can try the following solution:
sudo apt-get install python3-tksudo pacman -S tkThe library currently contains 518 tools, which are each grouped based on their main function into one of the following categories: Data Tools, GIS Analysis, Hydrological Analysis, Image Analysis, LiDAR Analysis, Mathematical and Statistical Analysis, Stream Network Analysis, and Terrain Analysis. For a listing of available tools, complete with documentation and usage details, please see the WhiteboxTools User Manual_.
The WhiteboxTools library currently supports read/writing raster data in Whitebox GAT, GeoTIFF, ESRI (ArcGIS) ASCII and binary (.flt & .hdr), GRASS GIS, Idrisi, SAGA GIS (binary and ASCII), and Surfer 7 data formats. At present, there is limited ability in WhiteboxTools to read vector geospatial data. Support for Shapefile (and other common vector formats) will be enhanced within the library soon.
If you would like to contribute to the project as a developer, follow these instructions to get started:
The whitebox package is distributed under the MIT license_, a permissive open-source (free software) license.
Report bugs at https://github.com/opengeos/whitebox-python/issues.
If you are reporting a bug, please include:
This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage
.. _example.py: https://github.com/opengeos/whitebox-python/blob/master/whitebox/example.py
.. _WhiteboxTools: https://github.com/jblindsay/whitebox-tools
.. _webpage: https://jblindsay.github.io/ghrg/index.html
.. _jblindsay: https://github.com/jblindsay
.. _Geomorphometry and Hydrogeomatics Research Group: https://jblindsay.github.io/ghrg/index.html
.. _conda user guide: https://conda.io/docs/user-guide/install/index.html
.. _managing Python environment: https://conda.io/docs/user-guide/tasks/manage-environments.html
.. _WhiteboxTools Usage: https://github.com/jblindsay/whitebox-tools#3-usage
.. _MIT license: https://opensource.org/licenses/MIT
.. _open an issue: https://github.com/jblindsay/whitebox-tools/issues
.. _WhiteboxTools User Manual: https://www.whiteboxgeo.com/manual/wbt_book/intro.html
FAQs
An advanced geospatial data analysis platform
We found that whitebox demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.