Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

mizuRoute

A tool that takes runoff data from a hydrologic or land surface model to compute streamflow in a user-defined catchment-based river network.
https://github.com/escomp/mizuroute

Category: Hydrosphere
Sub Category: Freshwater and Hydrology

Keywords

climate hydrology river

Keywords from Contributors

earth-system-model climate-model datamodeling cesm clm ecosystem land land-surface-model ncar snl-applications

Last synced: about 5 hours ago
JSON representation

Repository metadata

Reach-based river routing model

README.md

DOI
Documentation Status
License

mizuRoute

MizuRoute is a tool that takes runoff data from a hydrologic or land surface model to compute streamflow in a user-defined catchment-based (vector) river network.
A user can add Lakes into the river network, allowing the model to simulate discharge and volume in rivers and lakes (natural lakes or reservoir).

MizuRoute uses Message Passing Interface (MPI) for parallel computing to work on multi-decdal to a century simulation over large river networks (e.g., the river network over the contiguous United States).

MizuRoute can be run in two ways:

  1. Stand-alone mode - users needs provides their own runoff time series as a model input.
  2. CESM coupled model - MizuRoute runs as a river model component in Community Earth System Model (CESM).
    Currently, mizuRoute is coupled to Community Terrestrial Systems Model (CTSM), the land-model component of CESM.

To get started for a stand-alone mode

  1. Obtaining mizuRoute package. Just to use the tool, download the package by clicking “Download Zip” button on right column.

  2. To compile the codes, and prepare for the input data, please refer to User's Guide

  3. A user is encouraged to start with example data to get familiarize the process. Link to testCase data are given in testCase data in User's Guide.

To get started for ctsm coupling mode

User interested in using mizuRoute with CTSM is referred to CESM's user guide. Here, quick guide is provided.

  1. Obtain CTSM code from github

  2. Create the case

    cd cime/scripts

    ./create_newcase --case <testcase> --mach derecho --res f09_f09_rHDMAlk_mg17 -compset I2000Clm60SpMizGs

    (./create_newcase -help -- to get help on the script)

  3. Setup the case

    cd <testcase>

    ./xmlchange id1=val1,id2=val2  # to make changes to any settings in the env_*.xml files
./case.setup

    (./case.setup -help -- to get help on the script)

  4. Add any namelist changes to the user_nl_* files

    $EDITOR user_nl_*

  5. Compile the code

    ./case.build

  6. Submit the run

    ./case.submit

Prerequisite

  1. Linux commands.
  2. Geographic Information System to develop and visualize river network data
  3. python or similar other languages to analyze/visualize data, prepare for the input
  4. Fortran (if a user desires to change the codes)

Funding

  • U.S. Army Corps of Engineers
  • Bureau of Reclamation
  • NASA’s Advanced Information Systems Technology program
  • National Science Foundation

LICENSE

mizuRoute is licensed under Apache 2.0

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 1,599
Total Committers: 18
Avg Commits per committer: 88.833
Development Distribution Score (DDS): 0.381

Commits in past year: 225
Committers in past year: 6
Avg Commits per committer in past year: 37.5
Development Distribution Score (DDS) in past year: 0.093

Name Email Commits
Naoki Mizukami m****i@u****u 990
Erik Kluzek e****k@u****u 263
mizukami m****i@h****u 70
ShervanGharari s****6@g****t 59
ShervanGharari s****i@g****m 54
Martyn Clark m****k@u****u 52
ShervanGharari s****6@g****t 44
ShervanGharari s****6@g****t 43
ivanderkelen i****n@v****e 10
Naoki Mizukami m****i@u****u 5
James Edwards j****s@u****u 2
Bill Sacks s****s@u****u 1
Bart Nijssen n****n@u****u 1
Brian Dobbins b****s@g****m 1
Wouter Knoben w****n@u****a 1
Naoki Mizukami m****i@g****t 1
Hongli Liu h****u@H****l 1
kdraeder r****r@u****u 1

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 104
Total pull requests: 121
Average time to close issues: 8 months
Average time to close pull requests: 11 days
Total issue authors: 13
Total pull request authors: 7
Average comments per issue: 3.13
Average comments per pull request: 0.78
Merged pull request: 90
Bot issues: 0
Bot pull requests: 4

Past year issues: 12
Past year pull requests: 23
Past year average time to close issues: 17 days
Past year average time to close pull requests: 3 days
Past year issue authors: 5
Past year pull request authors: 5
Past year average comments per issue: 1.08
Past year average comments per pull request: 0.3
Past year merged pull request: 8
Past year bot issues: 0
Past year bot pull requests: 1

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

Top Issue Authors

  • ekluzek (61)
  • nmizukami (23)
  • ShervanGharari (5)
  • PrateekSharma99 (4)
  • BernardoTeufel (3)
  • shuihou (1)
  • h294liu (1)
  • DIPESHSINGHCHUPHAL (1)
  • rogerzzl (1)
  • AlaBahrami (1)
  • wknoben (1)
  • kasra-keshavarz (1)
  • csun15 (1)

Top Pull Request Authors

  • nmizukami (100)
  • ShervanGharari (7)
  • ekluzek (6)
  • dependabot[bot] (4)
  • jedwards4b (2)
  • kdraeder (1)
  • briandobbins (1)

Top Issue Labels

  • cesm-coupling (50)
  • bug (34)
  • enhancement (27)
  • standalone (15)
  • science (7)
  • high priority (6)
  • cleanup (6)
  • discussions (5)
  • infrastructure (5)
  • question (4)
  • bugfix (3)
  • new features (3)
  • help wanted (2)
  • no answer change (1)
  • low priority (1)
  • wontfix (1)
  • documentation (1)

Top Pull Request Labels

  • standalone (60)
  • cesm-coupling (58)
  • bugfix (31)
  • new features (25)
  • enhancement (24)
  • cleanup (20)
  • science (16)
  • documentation (10)
  • infrastructure (5)
  • no answer change (5)
  • dependencies (4)
  • WIP [DO NOT MERGE] (2)
  • python (1)

Score: 7.5251007461258