Model:Dorado

Dorado

This code has been community reviewed and published in the open access Journal of Open Source Software (JOSS)

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
Spatial extent	Watershed-Scale
Model domain	Terrestrial, Hydrology
One-line model description	A Python package for simulating passive particle transport in shallow-water flows
Extended model description	Dorado is a Python package for simulating passive Lagrangian particle transport over flow-fields from any 2D shallow-water hydrodynamic model using a weighted random walk methodology.

Keywords:	particle transport, Sediment Transport, Sediment flux, Lagrangian particle transport,

Name	Jayaram Hariharan
Type of contact	Model developer
Institute / Organization	Department of Civil, Architectural and Environmental Engineering, The University of Texas
Postal address 1
Postal address 2
Town / City	Austin
Postal code	78712
State	Texas
Country	United States
Email address	jayaram.hariharan@utexas.edu
Phone
Fax

Name	Kyle Wright
Type of contact	Model developer
Institute / Organization	Department of Civil, Architectural and Environmental Engineering, The University of Texas
Postal address 1
Postal address 2
Town / City	Austin
Postal code	78712
State	Texas
Country	United States
Email address	kyleawright@utexas.edu
Phone
Fax

Name	Paola Passalacqua
Type of contact	Project manager
Institute / Organization	Department of Civil, Architectural and Environmental Engineering, The University of Texas
Postal address 1
Postal address 2
Town / City	Austin
Postal code	78712
State	Texas
Country	United States
Email address	paola@austin.utexas.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	2020
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'?	2021
Model availability	As code
Source code availability (Or provide future intension)	Through web repository
Source web address	https://github.com/passaH2O/dorado
Source csdms web address
Program license type	BSD or MIT X11
Program license type other
Memory requirements	--
Typical run time	--

Describe input parameters	(1) the length along a square cell face (dx), (2) 2 of the following 3 arrays describing the domain: (a) the water depth (depth); (b) the water stage (stage); (c) the topography (topography), (3) either the x and y components of water velocity (u and v) or the x and y components of the water discharge (qx and qy), (4) and some optional parameters that include values related to the random walk weighting scheme, travel time calculations, and even the distance and direction assumptions related to the grid.
Input format	ASCII
Other input format
Describe output parameters	Query particle locations and travel times at a given iteration Query particle locations at a given travel time Plot the particle exposure time distributions Animate the output images of particle locations Plot the travel paths specified particles have taken Plot the particle positions for a specified iteration or travel time
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	Lagrangian particle transport. See also: https://passah2o.github.io/dorado/background/index.html
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://passah2o.github.io/dorado/index.html
Model forum / discussion board

Comments

This part will be filled out by CSDMS staff

Can be coupled with:

Model info

Authors

Passalacqua, Wright

Source code

Model citations

QR-code

Link to this page

Other models by author

Featured reference(s)	Open Access Status	Year	Type of Reference	Cited
Hariharan, Jayaram; Wright, Kyle; Moodie, Andrew; Tull, Nelson; Passalacqua, Paola; 2023. Impacts of human modifications on material transport in deltas. Earth Surface Dynamics, 11405–427. 10.5194/esurf-11-405-2023	cc-by · publishedVersion	2023	a module application description	9
Tull, Nelson; Passalacqua, Paola; Hassenruck‐Gudipati, Hima J.; Rahman, Shazzadur; Wright, Kyle; Hariharan, Jayaram; Mohrig, David; 2022. Bidirectional River‐Floodplain Connectivity During Combined Pluvial‐Fluvial Events. Water Resources Research, 58. 10.1029/2021WR030492	closed	2022	a module application description	27
Wright, Kyle; Hariharan, Jayaram; Passalacqua, Paola; Salter, Gerard; Lamb, Michael P.; 2022. From Grains to Plastics: Modeling Nourishment Patterns and Hydraulic Sorting of Fluvially Transported Materials in Deltas. Journal of Geophysical Research: Earth Surface, 127. 10.1029/2022JF006769	cc-by-nc · publishedVersion	2022	module related theory	5
Hariharan, Jayaram; Wright, Kyle; Passalacqua, Paola; 2020. dorado: A Python package for simulating passive particle transport in shallow-water flows. Journal of Open Source Software, 52585. 10.21105/joss.02585	cc-by · publishedVersion	2020	reference to source code	11