Model:ChannelProfiler

From CSDMS
Revision as of 09:49, 28 January 2020 by Vaga3461 (talk | contribs) (Created page with "{{Model identity |ModelFramework=LandLab |Model type=Single }} {{Start models incorporated}} {{End a table}} {{Model identity2 |ModelDomain=Terrestrial |Spatial dimensions=1D...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


ChannelProfiler


Metadata

Also known as
Model type Single
Model part of larger framework LandLab
Note on status model
Date note status model
Incorporated models or components:
Spatial dimensions 1D
Spatial extent Landscape-Scale, Regional-Scale, Watershed-Scale
Model domain Terrestrial
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:

'flow__receiver_node' 'flow__link_to_receiver_node' The ChannelProfiler can work on grids that have used route-to-one or route-to-multiple flow directing.

Keywords:

channel, profile,

Name Katy Barnhart
Type of contact Model developer
Institute / Organization
Postal address 1
Postal address 2
Town / City Boulder
Postal code 80309
State Colorado
Country United States
Email address katherine.barnhart@colorado.edu
Phone
Fax


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

Python

Other program language
Code optimized Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development 2019
Does model development still take place? No
If above answer is no, provide end year model development 2020
Code development status
When did you indicate the 'code development status'?
Model availability As code
Source code availability
(Or provide future intension) 		Through web repository
Source web address https://github.com/landlab/landlab/tree/master/landlab
Source csdms web address
Program license type BSD or MIT X11
Program license type other
Memory requirements
Typical run time


Describe input parameters grid : Landlab Model Grid instance, required 
       channel_definition_field : field name as string
           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 value of the *channel_definition_field* to define a
           watershed outlet. Default is 0.
       minimum_channel_threshold : float, optional
           Value to use for the minimum drainage area associated with a
           plotted channel segment. Default values 0.
       number_of_watersheds : int, optional
           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
           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
           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
           A valid matplotlib cmap string. Default is "viridis".
Input format ASCII
Other input format
Describe output parameters _info = { 
       "drainage_area": {
           "dtype": float,
           "intent": "in",
           "optional": True,
           "units": "m**2",
           "mapping": "node",
           "doc": "Upstream accumulated surface area contributing to the node's discharge",
       },
       "flow__link_to_receiver_node": {
           "dtype": int,
           "intent": "in",
           "optional": False,
           "units": "-",
           "mapping": "node",
           "doc": "ID of link downstream of each node, which carries the discharge",
       },
       "flow__receiver_node": {
           "dtype": int,
           "intent": "in",
           "optional": False,
           "units": "-",
           "mapping": "node",
           "doc": "Node array of receivers (node that receives flow from current node)",
       },
   }
Output format ASCII
Other output format
Pre-processing software needed? No
Describe pre-processing software
Post-processing software needed? No
Describe post-processing software
Visualization software needed? No
If above answer is yes
Other visualization software


Describe processes represented by the model
Describe key physical parameters and equations
Describe length scale and resolution constraints
Describe time scale and resolution constraints
Describe any numerical limitations and issues


Describe available calibration data sets
Upload calibration data sets if available:
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?
Is there a manual available? No
Upload manual if available:
Model website if any https://landlab.github.io
Model forum / discussion board https://github.com/landlab/landlab/issues
Comments


This part will be filled out by CSDMS staff

OpenMI compliant Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "Code openmi compliant or not" property.
BMI compliant Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "Code IRF or not" property.
WMT component Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code CMT compliant or not" property.
PyMT component Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code PyMT compliant or not" property.
Is this a data component
Can be coupled with:
Model info
Authors
Katy Barnhart
Source code
Model citations
Nr. of publications: 1
Total citations: 141
h-index: 1
m-quotient: 0.14
QR-code
Qrcode ChannelProfiler.png
Link to this page
Other models by author


Introduction

History

References



Nr. of publications: 1
Total citations: 141
h-index: 1
m-quotient: 0.14



Featured publication(s)YearModel describedType of ReferenceCitations
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


Issues

Help

Input Files

Output Files

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Model:ChannelProfiler&oldid=241716"