https://github.com/deltares/pyflwdir

Fast methods to work with hydro- and topography data in pure Python.
https://github.com/deltares/pyflwdir

basins d8 hydrography hydrology ldd topography watershed

Last synced: 2 days ago
JSON representation

Fast methods to work with hydro- and topography data in pure Python.

• Host: GitHub
• URL: https://github.com/deltares/pyflwdir
• Owner: Deltares
• License: mit
• Created: 2021-09-24T07:22:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T10:34:23.000Z (5 months ago)
• Last Synced: 2024-12-17T22:37:56.895Z (5 days ago)
• Topics: basins, d8, hydrography, hydrology, ldd, topography, watershed
• Language: Python
• Homepage: https://deltares.github.io/pyflwdir/latest
• Size: 30.4 MB
• Stars: 79
• Watchers: 9
• Forks: 29
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.txt
  • Authors: AUTHORS.txt

Awesome Lists containing this project

README

        
#############################################################################

PyFlwDir: Fast methods to work with hydro- and topography data in pure Python

#############################################################################

.. image:: https://codecov.io/gh/Deltares/PyFlwDir/branch/main/graph/badge.svg?token=N4VMHJJAV3

    :target: https://codecov.io/gh/Deltares/PyFlwDir

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg

    :target: https://deltares.github.io/pyflwdir/latest

    :alt: Latest docs

.. image:: https://mybinder.org/badge_logo.svg

    :alt: Binder

    :target: https://mybinder.org/v2/gh/Deltares/pyflwdir/main?urlpath=lab/tree/examples

.. image:: https://badge.fury.io/py/PyFlwDir.svg

    :target: https://pypi.org/project/PyFlwDir/

    :alt: Latest PyPI version

.. image:: https://anaconda.org/conda-forge/PyFlwDir/badges/version.svg

    :target: https://anaconda.org/conda-forge/PyFlwDir

.. image:: https://zenodo.org/badge/409871473.svg

   :target: https://zenodo.org/badge/latestdoi/409871473

.. image:: https://img.shields.io/github/license/Deltares/pyflwdir?style=flat

    :alt: License

    :target: https://github.com/Deltares/pyflwdir/blob/main/LICENSE

Intro

-----

PyFlwDir contains a series of methods to work with gridded DEM and flow direction

datasets, which are key to many workflows in many earth sciences.

PyFlwDir supports several flow direction data conventions and can easily be extended to include more.

The package contains some unique methods such as Iterative Hydrography Upscaling (IHU)

method to upscale flow directions from high resolution data to coarser model resolution.

PyFlwDir is in pure python and powered by `numba `_ to keep it fast.

Featured methods

----------------

- flow directions from elevation data using a steepest gradient algorithm

- strahler stream order

- flow direction upscaling

- (sub)basin delineation

- pfafstetter subbasins delineation

- classic stream order

- height above nearest drainage (HAND)

- geomorphic floodplain delineation

- up- and downstream tracing and arithmetics

- hydrologically adjusting elevation

- upstream accumulation

- vectorizing streams

- many more!

.. image:: https://raw.githubusercontent.com/Deltares/pyflwdir/main/docs/_static/pyflwdir.png

  :width: 100%

Installation

------------

See `installation guide `_

Quickstart

----------

See `user guide `_

Reference API

-------------

See `reference API `_

Development and Testing

-----------------------

Welcome to the PyFlwDir project. All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

See `Contributing to PyFlwDir `__ for how we work.