{"id":17671520,"url":"https://github.com/giswqs/whitebox-frontends","last_synced_at":"2025-05-12T14:56:59.624Z","repository":{"id":96385997,"uuid":"216580572","full_name":"giswqs/whitebox-frontends","owner":"giswqs","description":"WhiteboxTools Frontends","archived":false,"fork":false,"pushed_at":"2020-06-09T01:30:15.000Z","size":9,"stargazers_count":20,"open_issues_count":0,"forks_count":5,"subscribers_count":5,"default_branch":"gh-pages","last_synced_at":"2025-04-20T13:36:53.675Z","etag":null,"topics":["arcgis","geomorphometry","geoprocessing","geospatial","gis","hydrology","lidar","python","r","remote-sensing","rstats","rstudio"],"latest_commit_sha":null,"homepage":"https://gishub.org/whitebox","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/giswqs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-10-21T13:52:49.000Z","updated_at":"2024-02-07T11:16:22.000Z","dependencies_parsed_at":"2023-05-16T07:30:51.846Z","dependency_job_id":null,"html_url":"https://github.com/giswqs/whitebox-frontends","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"ae46e9e040435542c29f147dc5274e27c658dd05"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fwhitebox-frontends","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fwhitebox-frontends/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fwhitebox-frontends/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giswqs%2Fwhitebox-frontends/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/giswqs","download_url":"https://codeload.github.com/giswqs/whitebox-frontends/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253760049,"owners_count":21959876,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arcgis","geomorphometry","geoprocessing","geospatial","gis","hydrology","lidar","python","r","remote-sensing","rstats","rstudio"],"created_at":"2024-10-24T03:42:45.463Z","updated_at":"2025-05-12T14:56:59.602Z","avatar_url":"https://github.com/giswqs.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# WhiteboxTools Frontends\n\n[![docs](https://img.shields.io/badge/whitebox-Docs-brightgreen.svg)](https://jblindsay.github.io/wbt_book)\n[![frontends](https://img.shields.io/badge/whitebox-Frontends-yellowgreen.svg)](https://github.com/giswqs/whitebox-frontends)\n[![Rust](https://img.shields.io/badge/whitebox-Rust-yellow.svg)](https://github.com/jblindsay/whitebox-tools)\n[![python](https://img.shields.io/badge/whitebox-Python-blue.svg)](https://github.com/giswqs/whitebox-python)\n[![R](https://img.shields.io/badge/whitebox-R-green.svg)](https://github.com/giswqs/whiteboxR)\n[![ArcGIS](https://img.shields.io/badge/whitebox-ArcGIS-brightgreen.svg)](https://github.com/giswqs/WhiteboxTools-ArcGIS)\n[![QGIS](https://img.shields.io/badge/whitebox-QGIS-orange.svg)](https://jblindsay.github.io/wbt_book/qgis_plugin.html)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![image](https://img.shields.io/twitter/follow/giswqs?style=social%20%20%20%20..%20image::%20https://readthedocs.org/projects/geemap/badge/?version=latest)](https://twitter.com/giswqs)\n\n**WhiteboxTools** is an advanced geospatial data analysis platform developed by Prof. [John Lindsay](https://github.com/jblindsay) at the University of Guelph's [Geomorphometry and Hydrogeomatics Research Group](https://jblindsay.github.io/ghrg/index.html). The **[WhiteboxTools](https://github.com/jblindsay/whitebox-tools)** library currently contains **440** 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](https://jblindsay.github.io/wbt_book/available_tools/index.html).\n\n**WhiteboxTools** can be accessed either from a [command prompt](#cmd) (i.e. terminal) or through one of the following front-ends:\n\n- [Python Package](#python)\n- [R Package](#r)\n- [ArcGIS Python Toolbox](#arcgis)\n- [QGIS Plugin](#qgis)\n- [Command-line Interface](#cmd)\n\n## Python Package \u003ca class='anchor' id='python'\u003e\u003c/a\u003e\n\n### Links\n\n- GitHub repo: \u003chttps://github.com/giswqs/whitebox-python\u003e\n- PyPI: \u003chttps://pypi.org/project/whitebox/\u003e\n- conda-forge: \u003chttps://anaconda.org/conda-forge/whitebox\u003e\n- Documentation: \u003chttps://whitebox.readthedocs.io\u003e\n- Maintainer: [Qiusheng Wu](https://wetlands.io)\n\n### Installation\n\nThe **whitebox** Python package can be installed using the following command:\n\n```python\npip install whitebox\n```\n\nThe **whitebox** Python package is also available on [conda-forge](https://anaconda.org/conda-forge/whitebox), which can be installed using the following command:\n\n```python\nconda install -c conda-forge whitebox\n```\n\n### Usage\n\nTool names in the whitebox Python package can be called using the snake_case convention (e.g. lidar_info). See below for an example Python script.\n\n```python\nimport os\nimport pkg_resources\nimport whitebox\n\nwbt = whitebox.WhiteboxTools()\nprint(wbt.version())\nprint(wbt.help())\n\n# identify the sample data directory of the package\ndata_dir = os.path.dirname(pkg_resources.resource_filename(\"whitebox\", 'testdata/'))\n\nwbt.set_working_dir(data_dir)\nwbt.verbose = False\nwbt.feature_preserving_smoothing(\"DEM.tif\", \"smoothed.tif\", filter=9)\nwbt.breach_depressions(\"smoothed.tif\", \"breached.tif\")\nwbt.d_inf_flow_accumulation(\"breached.tif\", \"flow_accum.tif\")\n```\n\n**WhiteboxTools** also provides a Graphical User Interface (GUI) - **WhiteboxTools Runner**, which can be invoked using the following Python script:\n\n```python\nimport whitebox\nwhitebox.Runner()\n```\n\n![whitebox-runner](https://wetlands.io/file/images/whitebox.png)\n\n## R Package \u003ca class='anchor' id='r'\u003e\u003c/a\u003e\n\n### Links\n\n- GitHub repo: \u003chttps://github.com/giswqs/whiteboxR\u003e\n- R-Forge: \u003chttps://r-forge.r-project.org/R/?group_id=2337\u003e\n- Documentation: \u003chttps://giswqs.github.io/whiteboxR/\u003e\n- Maintainer: [Qiusheng Wu](https://wetlands.io)\n\n### Installation\n\nThe **whitebox** R package is available on [R-Forge](https://r-forge.r-project.org/R/?group_id=2337), which can be installed using the following command:\n\n```R\ninstall.packages(\"whitebox\", repos=\"http://R-Forge.R-project.org\")\n```\n\nYou can alternatively install the development version of whitebox from [GitHub](https://github.com/giswqs/whiteboxR) as follows:\n\n```R\nif (!require(devtools)) install.packages('devtools')\ndevtools::install_github(\"giswqs/whiteboxR\")\n```\n\n### RStudio Screenshot\n\n![whiteboxR](https://wetlands.io/file/images/whiteboxR.png)\n\n### Usage\n\nTool names in the **whitebox** R package can be called using the snake_case (e.g. wbt_lidar_info). See below for an example.\n\n```R\nlibrary(whitebox)\n\n# Set input raster DEM file\ndem \u003c- system.file(\"extdata\", \"DEM.tif\", package=\"whitebox\")\n\n# Run tools\nwbt_feature_preserving_smoothing(dem, \"./smoothed.tif\", filter=9, verbose_mode = TRUE)\nwbt_breach_depressions(\"./smoothed.tif\", \"./breached.tif\")\nwbt_d_inf_flow_accumulation(dem, \"./flow_accum.tif\")\n```\n\n## ArcGIS Python Toolbox\u003ca class='anchor' id='arcgis'\u003e\u003c/a\u003e\n\n### Links\n\n- GitHub repo: \u003chttps://github.com/giswqs/WhiteboxTools-ArcGIS\u003e\n- Maintainer: [Qiusheng Wu](https://wetlands.io)\n\n### Installation\n\n#### Step 1: Download the toolbox\n\n1. Go to the [WhiteboxTools-ArcGIS GitHub repo](https://github.com/giswqs/WhiteboxTools-ArcGIS) and click the green button (**[Clone or download](https://gishub.org/whitebox-arcgis-download)**) on the upper-right corner of the page to download the toolbox as a zip file.\n\n   ![](https://i.imgur.com/2xQkxCY.png)\n\n2. Depcompress the downloaded zip file.\n\n#### Step 2: Connect to the toolbox\n\n1. Navigate to the **Folder Connections** node in the catalog window tree.\n\n2. Right-click the node and choose **Connect To Folder**.\n\n   ![](https://i.imgur.com/uKK1Yel.png)\n\n3. Type the path or navigate to the **WhiteboxTools-ArcGIS** folder and click **OK**.\n\n4. Browse into the toolbox and start using its tools.\n\n   ![](https://i.imgur.com/JcdNBnt.png)\n\n### Usage\n\nOpen any tool within the toolbox and start using it. Check out the [WhiteboxTools User Mannual](https://jblindsay.github.io/wbt_book/) for more detailed help documentation of each tool.\n\n![](https://i.imgur.com/4c9RLZY.png)\n\n### ArcGIS Pro Screenshot\n\n![ArcGISPro](https://wetlands.io/file/images/whitebox-ArcGISPro.png)\n\n### ArcMap Screenshots\n\n![Toolbox-1](https://raw.githubusercontent.com/giswqs/WhiteboxTools-ArcGIS/master/screenshots/Toolbox-1.png)\n![Toolbox-2](https://raw.githubusercontent.com/giswqs/WhiteboxTools-ArcGIS/master/screenshots/Toolbox-2.png)\n![Toolbox-3](https://raw.githubusercontent.com/giswqs/WhiteboxTools-ArcGIS/master/screenshots/Toolbox-3.png)\n\n## QGIS Plugin \u003ca class='anchor' id='qgis'\u003e\u003c/a\u003e\n\n### Links\n\n- Documentation: \u003chttps://jblindsay.github.io/wbt_book/qgis_plugin.html\u003e\n- GitHub repo: https://github.com/alexbruy/processing-wbt\n- Maintainer: [Alexander Bruy](https://wiki.osgeo.org/wiki/User:Alexbruy)\n\n### Installation\n\nPlease follow the installation guide [here](https://jblindsay.github.io/wbt_book/qgis_plugin.html).\n\n### Screenshot\n\n![QGIS](https://wetlands.io/file/images/whitebox-QGIS.png)\n\n## Command-line Interface \u003ca class='anchor' id='cmd'\u003e\u003c/a\u003e\n\n### Links\n\n- GitHub repo: \u003chttps://github.com/jblindsay/whitebox-tools\u003e\n- User Manual: \u003chttps://jblindsay.github.io/wbt_book/index.html\u003e\n- Maintainer: [John Lindsay](https://jblindsay.github.io/ghrg/index.html)\n\n### Installation\n\nYou can download a copy of the **WhiteboxTools** executable for your operating system from the [Geomorphometry and Hydrogeomatics Research Group website](https://jblindsay.github.io/ghrg/WhiteboxTools/download.html). Once you've downloaded WhiteboxTools and decompressed (unzipped) the folder, you can open a command prompt and start using it.\n\n### Usage\n\n**WhiteboxTools** is a command-line program and can be run by calling it with appropriate commands and arguments, from a terminal application. The following commands are recognized by the **WhiteboxTools** library:\n\n| Command          | Description                                                                                      |\n| ---------------- | ------------------------------------------------------------------------------------------------ |\n| --cd, --wd       | Changes the working directory; used in conjunction with --run flag.                              |\n| -h, --help       | Prints help information.                                                                         |\n| -l, --license    | Prints the whitebox-tools license.                                                               |\n| --listtools      | Lists all available tools, with tool descriptions. Keywords may also be used, --listtools slope. |\n| -r, --run        | Runs a tool; used in conjunction with --cd flag; -r=\"LidarInfo\".                                 |\n| --toolbox        | Prints the toolbox associated with a tool; --toolbox=Slope.                                      |\n| --toolhelp       | Prints the help associated with a tool; --toolhelp=\"LidarInfo\".                                  |\n| --toolparameters | Prints the parameters (in json form) for a specific tool; --toolparameters=\\\"LidarInfo\\\".        |\n| -v               | Verbose mode. Without this flag, tool outputs will not be printed.                               |\n| --viewcode       | Opens the source code of a tool in a web browser; --viewcode=\\\"LidarInfo\\\".                      |\n| --version        | Prints the version information.                                                                  |\n\nGenerally, the Unix convention is that single-letter arguments (options) use a single hyphen (e.g. -h) while word-arguments (longer, more descriptive argument names) use double hyphen (e.g. --help). The same rule is used for passing arguments to tools as well. Use the _--toolhelp_ argument to print information about a specific tool (e.g. --toolhelp=Clump). Tool names can be specified either using the snake_case or CamelCase convention (e.g. _lidar_info_ or _LidarInfo_).\n\nFor examples of how to call functions and run tools from _WhiteboxTools_, see the _whitebox_example.py_ Python script, which itself uses the _whitebox_tools.py_ script as an interface for interacting with the executable file.\n\nIn addition to direct command-line and script-based interaction, a very basic user-interface called _WB Runner_ can be used to call the tools within the _WhiteboxTools_ executable file, providing the required tool arguments.\n\n**Example command prompt:**\n\n```\n\u003e\u003e./whitebox_tools --wd='/Users/johnlindsay/Documents/data/' --run=DevFromMeanElev\n--input='DEM clipped.dep' --output='DEV raster.dep' -v\n```\n\nNotice the quotation marks (single or double) used around directories and filenames, and string tool arguments in general. Use the '-v' flag (run in verbose mode) to force the tool print output to the command prompt. Please note that the whitebox_tools executable file must have permission to be executed; on some systems, this may require setting special permissions. The '\u003e\u003e' is shorthand for the command prompt and is not intended to be typed. Also, the above example uses the forward slash character (/), the directory path separator used on unix based systems. On Windows, users should use the back slash character (\\\\) instead.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiswqs%2Fwhitebox-frontends","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiswqs%2Fwhitebox-frontends","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiswqs%2Fwhitebox-frontends/lists"}