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)

LICENSE

mizuRoute is licensed under Apache 2.0