Skip to content

TopoToolbox/pytopotoolbox

Repository files navigation

pytopotoolbox Logo


GitHub Release PyPI - Version Tests GitHub License

pytopotoolbox

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 in order to support the simultaneous application of GIS-specific and other quantitative methods.

The documentation is located at https://topotoolbox.github.io/pytopotoolbox/.

This python library is based on the TopoToolbox for Matlab and uses the API provided by libtopotoolbox to compute efficiently.

Getting started

To get started head to pytopotoolbox/tutorial. If you need more examples see pytopotoolbox/examples or reference the API documentation pytopotoolbox/api.

The examples can also be downloaded as Jupyter Notebook files from docs/examples. Feel free to download and play around with them to gain a better understanding of the functionality of the TopoToolbox.

Installation

TopoToolbox is available in the Python Package Index. With Python version 3.10 or later and pip installed, you can run

pip install topotoolbox

to install the latest release from the Python Package Index. If you run into problems with installation, please open an issue.

Contributing

If you would like to contribute to pytopotoolbox, check out the Contribution Guidelines.

License

This project is licensed under the GPL-3.0 (GNU) License - see the LICENSE file for details.