Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

HexWatershed

A mesh independent flow direction model for hydrologic models.
https://github.com/changliao1025/pyhexwatershed

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

depression-filling flow-direction flow-routing gis graph hydrology river-networks terrain-analysis unstructured-meshes visualisation watershed

Keywords from Contributors

transforms mesh archiving measur river carbon generic conversion compose observation

Last synced: about 15 hours ago
JSON representation

Repository metadata

The Python interface to HexWatershed a mesh independent flow direction model for hydrologic models

README.md

HexWatershed

DOI

HexWatershed: a mesh independent flow direction model for hydrological models.

This Python package provides a Python interface to the underlying HexWatershed model.

HexWatershed has been compiled and tested on various 64-bit Linux and Mac based platforms.

Installation

Ensure you have a c++ compiler and the cmake utility installed.

Build the HexWatershed C++ backend and place the binary under the bin path.

Install the python package using conda: conda install -c conda-forge hexwatershed

For detailed installation instruction, please refer to the documentation.

Usage

Please use this tutorial to run the examples.

Acknowledgement

This work was supported by the Earth System Model Development program areas of the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research as part of the multi-program, collaborative Integrated Coastal Modeling (ICoM) project.

License

Copyright © 2022, Battelle Memorial Institute

  1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission to any person or entity lawfully obtaining a copy of this software and associated documentation files (hereinafter “the Software”) to redistribute and use the Software in source and binary forms, with or without modification. Such person or entity may use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and may permit others to do so, subject to the following conditions:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimers.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Other than as used herein, neither the name Battelle Memorial Institute or Battelle may be used in any form whatsoever without the express written consent of Battelle.

  1. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

References

There are a number of publications that describe the algorithms used in HexWatershed in detail. If you make use of HexWatershed in your work, please consider including a reference to the following:

Scientific Publications

  • Liao, Chang, Zhou, T., Xu, D., Tan, Z., Bisht, G., Cooper, M. G., et al. (2023). Topological relationship-based flow direction modeling: Stream burning and depression filling. Journal of Advances in Modeling Earth Systems, 15, e2022MS003487. https://doi.org/10.1029/2022MS003487

  • Liao, Chang, Zhou, T., Xu, D., Cooper, M. G., Engwirda, D., Li, H.-Y., Leung, L. R. (2023). Topological relationship-based flow direction modeling: Mesh-independent river networks representation. Journal of Advances in Modeling Earth Systems, 15, e2022MS003089. https://doi.org/10.1029/2022MS003089

  • Liao, Chang, Tian Zhou, Donghui Xu, Richard Barnes, Gautam Bisht, Hong-Yi Li, Zeli Tan, et al. (02/2022AD) 2022. “Advances In Hexagon Mesh-Based Flow Direction Modeling”. Advances In Water Resources 160. Elsevier BV: 104099.
    https://doi.org/10.1016/j.advwatres.2021.104099.

  • Liao, C., Tesfa, T., Duan, Z., & Leung, L. R. (2020). Watershed delineation on a hexagonal mesh grid. Environmental Modelling & Software, 128, 104702. https://doi.org/10.1016/j.envsoft.2020.104702

Software

For a full list of references including applications of HexWatershed in other projects, please refer to the documentation.

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Liao
    given-names: Chang
    orcid: https://orcid.org/0000-0002-7348-8858
title: "HexWatershed: a mesh-independent flow direction model for hydrologic models"
version: 0.2.30
doi: 10.5281/zenodo.6425881
date-released: 2022-03-31

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 225
Total Committers: 4
Avg Commits per committer: 56.25
Development Distribution Score (DDS): 0.049

Commits in past year: 51
Committers in past year: 2
Avg Commits per committer in past year: 25.5
Development Distribution Score (DDS) in past year: 0.02

Name Email Commits
changliao1025 c****5@o****m 214
Chang Liao c****5@g****m 8
Chang Liao 2****5 2
dependabot[bot] 4****] 1

Committer domains:

Issue and Pull Request metadata

Last synced: 1 day ago

Total issues: 29
Total pull requests: 51
Average time to close issues: N/A
Average time to close pull requests: about 1 hour
Total issue authors: 1
Total pull request authors: 2
Average comments per issue: 0.38
Average comments per pull request: 0.0
Merged pull request: 51
Bot issues: 0
Bot pull requests: 1

Past year issues: 1
Past year pull requests: 1
Past year average time to close issues: N/A
Past year average time to close pull requests: less than a minute
Past year issue authors: 1
Past year pull request authors: 1
Past year average comments per issue: 0.0
Past year average comments per pull request: 0.0
Past year merged pull request: 1
Past year bot issues: 0
Past year bot pull requests: 0

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

Top Issue Authors

  • changliao1025 (29)

Top Pull Request Authors

  • changliao1025 (50)
  • dependabot[bot] (1)

Top Issue Labels

  • documentation (1)

Top Pull Request Labels

  • dependencies (1)

Package metadata

pypi.org: hexwatershed

A mesh-independent flow direction model for hydrologic models

  • Homepage: https://github.com/changliao1025/pyhexwatershed
  • Documentation: https://hexwatershed.readthedocs.io/
  • Licenses: custom
  • Latest release: 0.2.30 (published 12 months ago)
  • Last Synced: 2025-04-25T18:31:15.535Z (1 day ago)
  • Versions: 31
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 734 Last month
  • Rankings:
    • Dependent packages count: 10.126%
    • Stargazers count: 13.396%
    • Dependent repos count: 21.535%
    • Average: 22.402%
    • Forks count: 22.64%
    • Downloads: 44.311%
  • Maintainers (1)
conda-forge.org: hexwatershed

  • Homepage: https://github.com/changliao1025/pyhexwatershed
  • Licenses: BSD-3-Clause
  • Latest release: 0.1.14 (published almost 3 years ago)
  • Last Synced: 2025-04-01T03:36:23.454Z (26 days ago)
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent repos count: 34.025%
    • Average: 47.72%
    • Stargazers count: 48.31%
    • Dependent packages count: 51.175%
    • Forks count: 57.37%

Dependencies

.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
Dockerfile docker
  • continuumio/miniconda3 latest build
pyproject.toml pypi
setup.py pypi

Score: 12.030575747683317