Welcome to TopoToolbox’s Python Documentation!#
TopoToolbox is a Python library that provides a set of functions and classes that support the analysis of relief and flow pathways in digital elevation models (DEMs). The major aim of TopoToolbox is to offer helpful analytical GIS utilities in a non-GIS environment to support the simultaneous application of GIS-specific and other quantitative methods.
This Python library is based on the TopoToolbox for Matlab and uses the API provided by libtopotoolbox to compute efficiently.
Installing and Getting Started#
TopoToolbox is on PyPI, so you can run
pip install topotoolbox
to obtain the latest version.
Once you have the package installed, the tutorial provides a basic walkthrough of loading and displaying a digital elevation model with TopoToolbox.
Further examples of TopoToolbox functionality can be found in the example notebooks, which can also be downloaded from the GitHub repository.
API Documentation#
For further documentation regarding the functionality of this package, check out the API documentation.
Contributing#
If you would like to contribute to pytopotoolbox, refer to the Contribution Guidelines page. To get a better understanding of how we wrap functions for use in python, the How to wrap libtopotoolbox functions with the pytopotoolbox page will help.