Learning Resources
WhiteboxTools User Manual
The first place to get help with WhiteboxTools should be the WhiteboxTools User Manual. Have you found the help you needed from the user manual in the past? If so, consider supporting us by purchasing WhiteboxTools today.
Whitebox Workflows for Python User Manual
The User Manual contains everything you need to know to get started using Whitebox Workflows for Python for advanced geoprocessing.
Have questions about the software? Join our Google Group
YouTube Tutorials
We have launched a YouTube channel called Whitebox Geospatial. Explore our tutorials videos to learn more about using WhiteboxTools and its suite of tools. Subscribe to our channel for all the latest updates.
Tutorials
We have created some tutorials to common questions we have received from our community of WhiteboxTools over the past couple use in regard to using and interacting with WhiteboxTools.
Interfacing with WhiteboxTools using pyton scripting
Interfacing with WhiteboxTools Through Command Line
Interpolating LiDAR dATA
How do I remove non-ground points from my LiDAR file
Interpolating many Las/zlidar files
How do i convert LAS or LAZ to zlidar?
FAQ
Most frequent questions and answers
WhiteboxTools is developed using the Rust programming language, which supports a wide variety of platforms including MS Windows, MacOS, and Linux operating systems and common chip architectures. Interestingly, Rust also supports mobile platforms, and WhiteboxTools should therefore be capable of targeting (although no testing has been completed in this regard to date). Nearly all development and testing of the software is currently carried out on MacOS and we cannot guarantee a bug-free performance on other platforms. In particularly, MS Windows is the most different from the other platforms and is therefore the most likely to encounter platform-specific bugs. If you encounter bugs in the software, please consider reporting an issue using the GitHub support for issue-tracking.
The answer to this question depends strongly on the type of analysis and data that you intend to process. However, generally we find performance to be optimal with a recommended minimum of 8-16GB of memory (RAM), a modern multi-core processor (e.g. 64-bit i5 or i7), and an solid-state-drive (SSD). It is likely that WhiteboxTools will have satisfactory performance on lower-spec systems if smaller datasets are being processed. Because WhiteboxTools reads entire raster datasets into system memory (for optimal performance, and in recognition that modern systems have increasingly larger amounts of fast RAM), this tends to be the limiting factor for the upper-end of data size successfully processed by the library. 64-bit operating systems are recommended and extensive testing has not been carried out on 32-bit OSs.
The Whitebox extensions require a software license to use the tools within that extension. Currently we have four extension products for purchase. You can download the extensions at any time but will only be able to use the tools in an extension after purchasing a software license.
The open core, WhiteboxTools does not require a software license. You can use the tools in the open-core without having the purchase a software license.
You do not need to purchase a license to use the open-core WhiteboxTools, although we do sell pre-compiled binaries on a ‘pay-what-you-can’ basis. WhiteboxTools will and will always remain open source. We are committed to developing and maintaining this open-source project now and forever.
In fact, majority of the funds that are derived from software licensing sales will go directly to maintaining, developing and updating WhiteboxTools for our community of users.
Refer to the manual here, for instructions on how to set up and use WhiteboxTools
Download a copy of the instructions on how to activate your software license here.
Whitebox Presentations
- International Society for Geomorphometry (ISG) Coffee Talk Event (Dec. 7, 2022). View PDF slides here.