Model:HexWatershed: Difference between revisions

From CSDMS
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
{{Model identity2
{{Model identity2
|ModelDomain=Terrestrial, Hydrology, Coastal, Ecosystems, Cryosphere
|ModelDomain=Terrestrial, Hydrology, Coastal, Ecosystems, Cryosphere
|Spatial dimensions=2D
|Spatial dimensions=2D, 3D
|Spatialscale=Global, Continental, Regional-Scale, Landscape-Scale, Watershed-Scale
|Spatialscale=Global, Continental, Regional-Scale, Landscape-Scale, Watershed-Scale
|One-line model description=A watershed delineation model based on hexagonal mesh grid
|One-line model description=A mesh independent flow direction model for hydrologic models
|Extended model description=HexWatershed is a C++ program to define flow direction and other watershed characteristics at regional to global scale. The unique feature of HexWatershed is that it uses a hexagon and hexagon-alike unstructured mesh. Because of that, it have many advantages:
|Extended model description=HexWatershed is a mesh independent flow direction model for hydrologic models. It can be run at both regional and global scales. The unique feature of HexWatershed is that it supports both structured and unstructured meshes.
* It can represent adjacency uniformly
* It eliminates ``island'' effect due to the differences in D4 and D8 neighbor definitions
* It can effectively represent a spherical topology such as Earth
}}
}}
{{Start model keyword table}}
{{Start model keyword table}}
Line 41: Line 38:
|State=Washington
|State=Washington
|Email address=chang.liao@pnnl.gov
|Email address=chang.liao@pnnl.gov
}}
{{Additional modeler information
|Additional first name=Tian
|Additional last name=Zhou
|Additional type of contact=Project manager
|Additional institute / Organization=Pacific Northwest National Laboratory
|Additional town / City=Richland
|Additional postal code=99354
|Additional country=United States
|Additional state=Washington
|Additional email address=tian.zhou@pnnl.gov
}}
}}
{{Model technical information
{{Model technical information
|Supported platforms=Unix, Linux, Mac OS
|Supported platforms=Unix, Linux, Mac OS, Windows
|Programming language=C++
|Programming language=C++, Python
|Code optimized=Single Processor, Multiple Processors
|Code optimized=Single Processor, Multiple Processors
|Multiple processors implemented=Shared memory
|Multiple processors implemented=Shared memory
Line 51: Line 59:
|Does model development still take place?=Yes
|Does model development still take place?=Yes
|DevelopmentCode=Active
|DevelopmentCode=Active
|DevelopmentCodeYearChecked=2020
|DevelopmentCodeYearChecked=2022
|Model availability=As code, As teaching tool
|Model availability=As code, As teaching tool
|Source code availability=Through web repository
|Source code availability=Through web repository
|Source web address=https://github.com/pnnl/hexwatershed
|Source web address=https://github.com/changliao1025/pyhexwatershed
|Program license type=GPL v3
|Program license type=BSD or MIT X11
|Memory requirements=Depend on study domain and spatial resolution
|Memory requirements=Depend on study domain and spatial resolution
|Typical run time=Depend on study domain and spatial resolution, a few minutes for a typical watershed.
|Typical run time=Depend on study domain and spatial resolution, a few minutes for a typical watershed.
Line 61: Line 69:
{{Input - Output description
{{Input - Output description
|Describe input parameters=DEM raster and Hexagon shapefile, stream segment threshold
|Describe input parameters=DEM raster and Hexagon shapefile, stream segment threshold
|Input format=ASCII
|Input format=ASCII, Binary
|Other input format=Input and output workspace, etc.
|Other input format=Input and output workspace, etc.
|Describe output parameters=Hexagon DEM, flow direction, flow accumulation, stream grid, stream segment, stream order, stream confluence, subbasin, watershed boundary, etc.
|Describe output parameters=Hexagon DEM, flow direction, flow accumulation, stream grid, stream segment, stream order, stream confluence, subbasin, watershed boundary, etc.
|Output format=ASCII, Binary
|Output format=ASCII
|Other output format=NetCDF and VTK
|Other output format=JSON and VTK
|Pre-processing software needed?=Yes
|Pre-processing software needed?=Yes
|Describe pre-processing software=QGIS may be needed to generate the hexagon mesh grid shapfile.
|Describe pre-processing software=QGIS may be needed to preprocessing some files.
|Post-processing software needed?=No
|Post-processing software needed?=No
|Visualization software needed?=Yes
|Visualization software needed?=Yes
|If above answer is yes=ESRI
|If above answer is yes=ESRI
|Other visualization software=VisIt if use the version 2.0
|Other visualization software=VisIt or QGIS
}}
}}
{{Process description model
{{Process description model
Line 81: Line 89:
One equation is the resolution of a hexagon can be estimated using its area instead of edge length.
One equation is the resolution of a hexagon can be estimated using its area instead of edge length.
|Describe length scale and resolution constraints=It is best performance for high resolution (<100m) simulation.
|Describe length scale and resolution constraints=It is best performance for high resolution (<100m) simulation.
With the version 2.0, coarser resolution is supported through stream burning feature.
With the version 3.0, coarser resolution is supported through stream burning feature.
|Describe time scale and resolution constraints=None
|Describe time scale and resolution constraints=None
}}
}}
Line 89: Line 97:
}}
}}
{{Users groups model
{{Users groups model
|Do you have current or future plans for collaborating with other researchers?=Yes, I plan to use this model with other hydrology models, both regional and global scale.
|Do you have current or future plans for collaborating with other researchers?=Yes, I plan to use this model with other hydrologic models, both regional and global scale.
}}
}}
{{Documentation model
{{Documentation model
|Manual model available=Yes
|Manual model available=Yes
|Model manual=The manual will soon available online
|Model manual=https://hexwatershed.readthedocs.io/
|Model website if any=https://www.hexwatershed.org
|Model website if any=https://www.hexwatershed.org
|Model forum=We currently use Github issue for discussion.
|Model forum=We currently use Github issue for discussion.
https://github.com/pnnl/hexwatershed
https://github.com/changliao1025/pyhexwatershed
}}
}}
{{Additional comments model}}
{{Additional comments model}}
{{CSDMS staff part}}
{{CSDMS staff part}}
{{DOI information}}
{{Start coupled table}}
{{Start coupled table}}
{{End a table}}
{{End a table}}

Latest revision as of 13:27, 24 May 2022



HexWatershed


Metadata

Also known as
Model type Single
Model part of larger framework
Note on status model
Date note status model
Incorporated models or components:
Spatial dimensions 2D, 3D
Spatial extent Global, Continental, Regional-Scale, Landscape-Scale, Watershed-Scale
Model domain Terrestrial, Hydrology, Coastal, Ecosystems, Cryosphere
One-line model description A mesh independent flow direction model for hydrologic models
Extended model description HexWatershed is a mesh independent flow direction model for hydrologic models. It can be run at both regional and global scales. The unique feature of HexWatershed is that it supports both structured and unstructured meshes.
Keywords:

Watershed delineation, Unstructured, hydrology, flow routing, Hexagon,

Name Chang Liao
Type of contact Model developer
Institute / Organization Pacific Northwest National Laboratory
Postal address 1
Postal address 2
Town / City Richland
Postal code 99354
State Washington
Country United States
Email address chang.liao@pnnl.gov
Phone
Fax


Name Tian Zhou
Type of contact Project manager
Institute / Organization Pacific Northwest National Laboratory
Postal address 1
Postal address 2
Town / City Richland
Postal code 99354
State Washington
Country United States
Email address tian.zhou@pnnl.gov
Phone
Fax


Supported platforms
Unix, Linux, Mac OS, Windows
Other platform
Programming language

C++, Python

Other program language
Code optimized Single Processor, Multiple Processors
Multiple processors implemented Shared memory
Nr of distributed processors
Nr of shared processors 20
Start year development 2017
Does model development still take place? Yes
If above answer is no, provide end year model development
Code development status Active
When did you indicate the 'code development status'? 2022
Model availability As code, As teaching tool
Source code availability
(Or provide future intension)
Through web repository
Source web address https://github.com/changliao1025/pyhexwatershed
Source csdms web address
Program license type BSD or MIT X11
Program license type other
Memory requirements Depend on study domain and spatial resolution
Typical run time Depend on study domain and spatial resolution, a few minutes for a typical watershed.


Describe input parameters DEM raster and Hexagon shapefile, stream segment threshold
Input format ASCII, Binary
Other input format Input and output workspace, etc.
Describe output parameters Hexagon DEM, flow direction, flow accumulation, stream grid, stream segment, stream order, stream confluence, subbasin, watershed boundary, etc.
Output format ASCII
Other output format JSON and VTK
Pre-processing software needed? Yes
Describe pre-processing software QGIS may be needed to preprocessing some files.
Post-processing software needed? No
Describe post-processing software
Visualization software needed? Yes
If above answer is yes ESRI
Other visualization software VisIt or QGIS


Describe processes represented by the model DEM resampling;

Depression filling; Flow direction; Flow accumulation;

Describe key physical parameters and equations Terrain analysis.

One equation is the resolution of a hexagon can be estimated using its area instead of edge length.

Describe length scale and resolution constraints It is best performance for high resolution (<100m) simulation.

With the version 3.0, coarser resolution is supported through stream burning feature.

Describe time scale and resolution constraints None
Describe any numerical limitations and issues


Describe available calibration data sets National Hydrography Dataset (NHD) flowline datasets were used to evaluated the model.
Upload calibration data sets if available: Media:Please refer to the paper
Describe available test data sets
Upload test data sets if available:
Describe ideal data for testing


Do you have current or future plans for collaborating with other researchers? Yes, I plan to use this model with other hydrologic models, both regional and global scale.
Is there a manual available? Yes
Upload manual if available: Media:https://hexwatershed.readthedocs.io/
Model website if any https://www.hexwatershed.org
Model forum / discussion board We currently use Github issue for discussion.

https://github.com/changliao1025/pyhexwatershed

Comments


This part will be filled out by CSDMS staff

OpenMI compliant
BMI compliant
WMT component
PyMT component
Is this a data component
DOI model
For model version
Year version submitted
Link to file
Can be coupled with:
Model info
Nr. of publications: 1
Total citations: 12
h-index: 1
m-quotient: 0.25



Introduction

History

References




Nr. of publications: 1
Total citations: 12
h-index: 1
m-quotient: 0.25



Featured publication(s)YearModel describedType of ReferenceCitations
Liao, Chang; Tesfa, Teklu; Duan, Zhuoran; Leung, L. Ruby; 2020. Watershed delineation on a hexagonal mesh grid. Environmental Modelling &amp; Software, 128, 104702. 10.1016/j.envsoft.2020.104702
(View/edit entry)
2020 HexWatershed
Model overview 12
See more publications of HexWatershed


Issues

Help

Input Files

Output Files