pyflwdir

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

https://github.com/deltares/pyflwdir

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.0%) to scientific vocabulary

Keywords

basins d8 hydrography hydrology ldd topography watershed

Keywords from Contributors

hydrodynamics

Last synced: 6 months ago · JSON representation

Repository

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

Basic Info

Host: GitHub
Owner: Deltares
License: mit
Language: Python
Default Branch: main
Homepage: https://deltares.github.io/pyflwdir/latest
Size: 43.2 MB

Statistics

Stars: 99
Watchers: 8
Forks: 31
Open Issues: 10
Releases: 11

Topics

basins d8 hydrography hydrology ldd topography watershed

Created over 4 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Authors Zenodo

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

Name: Deltares
Login: Deltares
Kind: organization
Email: oss@deltares.nl
Location: Delft, The Netherlands

Website: https://www.deltares.nl/en/
Twitter: deltares
Repositories: 74
Profile: https://github.com/Deltares

Deltares is an independent institute for applied research in the field of water and subsurface.

GitHub Events

Total

Create event: 10
Release event: 1
Issues event: 24
Watch event: 20
Delete event: 10
Issue comment event: 23
Push event: 25
Pull request review event: 2
Pull request review comment event: 1
Pull request event: 21
Fork event: 3

Last Year

Create event: 10
Release event: 1
Issues event: 24
Watch event: 20
Delete event: 10
Issue comment event: 23
Push event: 25
Pull request review event: 2
Pull request review comment event: 1
Pull request event: 21
Fork event: 3

Committers

Last synced: 7 months ago

All Time

Total Commits: 427
Total Committers: 4
Avg Commits per committer: 106.75
Development Distribution Score (DDS): 0.019

Past Year

Commits: 12
Committers: 2
Avg Commits per committer: 6.0
Development Distribution Score (DDS): 0.083

Top Committers

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

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 41
Total pull requests: 37
Average time to close issues: 6 months
Average time to close pull requests: 22 days
Total issue authors: 15
Total pull request authors: 6
Average comments per issue: 1.98
Average comments per pull request: 0.24
Merged pull requests: 31
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 12
Pull requests: 16
Average time to close issues: about 2 months
Average time to close pull requests: 1 day
Issue authors: 4
Pull request authors: 3
Average comments per issue: 1.25
Average comments per pull request: 0.0
Merged pull requests: 12
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

DirkEilander (13)
AquaPore (8)
debpal (4)
JasonDalton (2)
schoeller (2)
Jiangchao3 (2)
MauKruisheer (2)
vzagorovskiy (1)
lotruheawea (1)
mn5hk (1)
robgpita (1)
yutabvb (1)
lj512lj512 (1)
forestbat (1)

Pull Request Authors

DirkEilander (34)
gurbuzf (2)
robgpita (2)
vzagorovskiy (2)
caiostringari (2)
verseve (1)

Top Labels

Issue Labels

enhancement (5) documentation (2) invalid (1) needs refinement (1)

Pull Request Labels

Packages

Total packages: 4
Total downloads:
- pypi 5,674 last-month

Total dependent packages: 9
(may contain duplicates)
Total dependent repositories: 4
(may contain duplicates)
Total versions: 49
Total maintainers: 1

proxy.golang.org: github.com/deltares/pyflwdir

Documentation: https://pkg.go.dev/github.com/deltares/pyflwdir#section-documentation
License: mit
Latest release: v0.5.10
published about 1 year ago

Versions: 10
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

proxy.golang.org: github.com/Deltares/pyflwdir

Documentation: https://pkg.go.dev/github.com/Deltares/pyflwdir#section-documentation
License: mit
Latest release: v0.5.10
published about 1 year ago

Versions: 10
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent packages count: 5.4%

Average: 5.6%

Dependent repos count: 5.8%

Last synced: 6 months ago

pypi.org: pyflwdir

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

Homepage: https://github.com/Deltares/pyflwdir
Documentation: https://deltares.github.io/pyflwdir
License: MIT License
Latest release: 0.5.10
published about 1 year ago

Versions: 17
Dependent Packages: 6
Dependent Repositories: 1
Downloads: 5,674 Last month

Rankings

Dependent packages count: 1.6%

Stargazers count: 9.7%

Forks count: 11.0%

Average: 11.3%

Downloads: 12.1%

Dependent repos count: 22.1%

Maintainers (1)

DirkEilander

Last synced: 6 months ago

conda-forge.org: pyflwdir

Homepage: https://github.com/deltares/pyflwdir/
License: MIT
Latest release: 0.5.6
published over 3 years ago

Versions: 12
Dependent Packages: 3
Dependent Repositories: 3

Rankings

Dependent packages count: 15.6%

Dependent repos count: 17.9%

Average: 32.2%

Stargazers count: 44.9%

Forks count: 50.4%

Last synced: 6 months ago

Dependencies

environment.yml conda

affine
cartopy
descartes
geopandas
jupyter
matplotlib
numba >=0.48
numpy
python >=3.6
rasterio
scipy
setuptools_scm

.github/workflows/docs.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite
peaceiris/actions-gh-pages v3.8.0 composite

.github/workflows/publish.yml actions

actions/checkout v3 composite
actions/checkout v2 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
pypa/gh-action-pypi-publish v1.5.1 composite

.github/workflows/test_cov.yml actions

actions/checkout v2 composite
codecov/codecov-action v1 composite
conda-incubator/setup-miniconda v2 composite

.github/workflows/tests.yml actions

actions/checkout v2 composite
conda-incubator/setup-miniconda v2 composite

pyflwdir

Science Score: 36.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.rst

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

proxy.golang.org: github.com/deltares/pyflwdir

Rankings

proxy.golang.org: github.com/Deltares/pyflwdir

Rankings

pypi.org: pyflwdir

Rankings

Maintainers (1)

conda-forge.org: pyflwdir

Rankings

Dependencies