Model:ChannelProfiler: Difference between revisions
From CSDMS
No edit summary |
m (Text replacement - "{{End headertab}}" to "{{End headertab}} {{{{PAGENAME}}_autokeywords}}") |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 10: | Line 10: | ||
|Spatialscale=Landscape-Scale, Regional-Scale, Watershed-Scale | |Spatialscale=Landscape-Scale, Regional-Scale, Watershed-Scale | ||
|One-line model description=The ChannelProfiler extracts and plots channel networks from a landlab grid. | |One-line model description=The ChannelProfiler extracts and plots channel networks from a landlab grid. | ||
|Extended model description=In order to extract channel networks, the flow connectivity across the grid must already be identified. This is typically done with the FlowAccumulator component. However, this component does not require that the FlowAccumulator was used. Instead it expects that the following at-node grid fields will be present: | |Extended model description=In order to extract channel networks, the flow connectivity across the grid must already be identified. This is typically done with the FlowAccumulator component. However, this component does not require that the FlowAccumulator was used. Instead it expects that the following at-node grid fields will be present:<br> | ||
'flow__receiver_node' | 'flow__receiver_node'<br> | ||
'flow__link_to_receiver_node' | 'flow__link_to_receiver_node'<br> | ||
The ChannelProfiler can work on grids that have used route-to-one or route-to-multiple flow directing. | The ChannelProfiler can work on grids that have used route-to-one or route-to-multiple flow directing. | ||
}} | }} | ||
Line 46: | Line 46: | ||
}} | }} | ||
{{Input - Output description | {{Input - Output description | ||
|Describe input parameters=grid : Landlab Model Grid instance, required | |Describe input parameters=grid : Landlab Model Grid instance, required<br><br> | ||
channel_definition_field : field name as string | channel_definition_field : field name as string<br> | ||
Name of field used to identify the outlet and headwater nodes of the channel network. Default is "drainage_area". | Name of field used to identify the outlet and headwater nodes of the channel network. Default is "drainage_area". | ||
minimum_outlet_threshold : float, optional | minimum_outlet_threshold : float, optional<br> | ||
Minimum value of the *channel_definition_field* to define a watershed outlet. Default is 0. | Minimum value of the *channel_definition_field* to define a watershed outlet. Default is 0. | ||
minimum_channel_threshold : float, optional | minimum_channel_threshold : float, optional<br> | ||
Value to use for the minimum drainage area associated with a plotted channel segment. Default values 0. | Value to use for the minimum drainage area associated with a plotted channel segment. Default values 0. | ||
number_of_watersheds : int, optional | number_of_watersheds : int, optional<br> | ||
Total number of watersheds to plot. Default value is 1. If value is greater than 1 and outlet_nodes is not specified, then the number_of_watersheds largest watersheds is based on the drainage area at the model grid boundary. If given as None, then all grid cells on the domain boundary with a stopping field (typically drainage area) greater than the minimum_outlet_threshold in area are used. | Total number of watersheds to plot. Default value is 1. If value is greater than 1 and outlet_nodes is not specified, then the number_of_watersheds largest watersheds is based on the drainage area at the model grid boundary. If given as None, then all grid cells on the domain boundary with a stopping field (typically drainage area) greater than the minimum_outlet_threshold in area are used. | ||
main_channel_only : Boolean, optional | main_channel_only : Boolean, optional<br> | ||
Flag to determine if only the main channel should be plotted, or if all stream segments with drainage area less than threshold should be plotted. Default value is True. | Flag to determine if only the main channel should be plotted, or if all stream segments with drainage area less than threshold should be plotted. Default value is True. | ||
outlet_nodes : length number_of_watersheds iterable, optional | outlet_nodes : length number_of_watersheds iterable, optional<br> | ||
Length number_of_watersheds iterable containing the node IDs of nodes to start the channel profiles from. If not provided, the default is the number_of_watersheds node IDs on the model grid boundary with the largest terminal drainage area. | Length number_of_watersheds iterable containing the node IDs of nodes to start the channel profiles from. If not provided, the default is the number_of_watersheds node IDs on the model grid boundary with the largest terminal drainage area. | ||
cmap : str | cmap : str<br> | ||
A valid matplotlib cmap string. Default is "viridis". | A valid matplotlib cmap string. Default is "viridis". | ||
|Input format=ASCII | |Input format=ASCII | ||
|Describe output parameters= | |Describe output parameters="drainage_area": | ||
"drainage_area": | |||
{ | { | ||
"dtype": float, | "dtype": float, | ||
Line 100: | Line 97: | ||
"mapping": "node", | "mapping": "node", | ||
"doc": "Node array of receivers (node that receives flow from current node)", | "doc": "Node array of receivers (node that receives flow from current node)", | ||
} | } | ||
|Output format=ASCII | |Output format=ASCII | ||
Line 126: | Line 121: | ||
{{End a table}} | {{End a table}} | ||
{{End headertab}} | {{End headertab}} | ||
{{{{PAGENAME}}_autokeywords}} | |||
<!-- PLEASE USE THE "EDIT WITH FORM" BUTTON TO EDIT ABOVE CONTENTS; CONTINUE TO EDIT BELOW THIS LINE --> | <!-- PLEASE USE THE "EDIT WITH FORM" BUTTON TO EDIT ABOVE CONTENTS; CONTINUE TO EDIT BELOW THIS LINE --> | ||
{{#ifexist:Template:{{#sub:{{PAGENAME}}|0|1}}{{#sub:{{lc:{{PAGENAME}}}}|1}} download stats | ==Download statistics== | {{#ifexist:Template:{{#sub:{{PAGENAME}}|0|1}}{{#sub:{{lc:{{PAGENAME}}}}|1}} download stats | ==Download statistics== |
Latest revision as of 20:14, 16 September 2020
ChannelProfiler
Metadata
|
|
Introduction
History
References
Nr. of publications: | 1 |
Total citations: | 141 |
h-index: | 1 |
m-quotient: | 0.14 |
Featured publication(s) | Year | Model described | Type of Reference | Citations |
---|---|---|---|---|
Hobley, Daniel E. J.; Adams, Jordan M.; Nudurupati, Sai Siddhartha; Hutton, Eric W. H.; Gasparini, Nicole M.; Istanbulluoglu, Erkan; Tucker, Gregory E.; 2017. Creative computing with Landlab: an open-source toolkit for building, coupling, and exploring two-dimensional numerical models of Earth-surface dynamics. Earth Surface Dynamics, 5, 21–46. 10.5194/esurf-5-21-2017 (View/edit entry) | 2017 | ChannelProfiler DepthDependentTaylorDiffuser Landlab LinearDiffuser |
Model overview | 141 |
See more publications of ChannelProfiler |