pyflwdir

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

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

basins d8 hydrography hydrology ldd topography watershed

Keywords from Contributors

hydrodynamics hydrological-modelling

Last synced: about 12 hours ago
JSON representation

Repository metadata

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 (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-02-18T21:11:55.000Z (2 months ago)
• Last Synced: 2025-04-20T11:01:27.098Z (7 days ago)
• Topics: basins, d8, hydrography, hydrology, ldd, topography, watershed
• Language: Python
• Homepage: https://deltares.github.io/pyflwdir/latest
• Size: 42 MB
• Stars: 86
• Watchers: 8
• Forks: 29
• Open Issues: 11
• Releases: 11
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.txt
  • Authors: AUTHORS.txt

README.rst

          #############################################################################
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.

        

---

Owner metadata

• Name: Deltares
• Login: Deltares
• Email: [email protected]
• Kind: organization
• Description: Deltares is an independent institute for applied research in the field of water and subsurface.
• Website: https://www.deltares.nl/en/
• Location: Delft, The Netherlands
• Twitter: deltares
• Company:
• Icon url: https://avatars.githubusercontent.com/u/6613768?v=4
• Repositories: 74
• Last ynced at: 2023-03-03T19:30:55.614Z
• Profile URL: https://github.com/Deltares

---

GitHub Events

Total

• Create event: 7
• Release event: 1
• Issues event: 15
• Watch event: 13
• Delete event: 7
• Issue comment event: 13
• Push event: 20
• Pull request event: 13
• Fork event: 2

Last Year

• Create event: 7
• Release event: 1
• Issues event: 15
• Watch event: 13
• Delete event: 7
• Issue comment event: 13
• Push event: 20
• Pull request event: 13
• Fork event: 2

---

Committers metadata

Last synced: 6 days ago

Name	Email	Commits
DirkEilander	d****r@g****m	415
verseve	w****d@g****m	6
vzagorovskiy	v****y@g****m	1
Martijn Visser	m****r@g****m	1

Committer domains:

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/deltares/pyflwdir

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 3,943 last-month
• Total dependent packages: 9 (may contain duplicates)
• Total dependent repositories: 5 (may contain duplicates)
• Total versions: 51
• Total maintainers: 2

---

Dependencies

Score: 14.244752086729404