Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Joe Hamman committed Mar 16, 2014
1 parent d150d8b commit 46e94f5
Showing 1 changed file with 4 additions and 23 deletions.
27 changes: 4 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,13 @@
The RVIC Streamflow Routing model is a simple source to sink routing model. The model represents each grid cell by a node in the channel network. Unit hydrographs are developed that described the time distribution of flow from each source grid cell to a corresponding sink grid cell. The development of the unit hydrographs is done as a pre process step (i.e. `make_parameters.py`). The final step is the convolution of the unit hydrographs with fluxes from a land surface model, typically VIC (i.e. `rvic_model.py`).

### Usage
Examples of all configuration files can be found in RVIC/config/ directory

#### Make domain file from arcinfo fraction file

`./fraction2domain.bash fraction_file.asc`

#### Make rvic parameter file from existing uhs files
*** note that only C program format files are currently supported

`./uhs2paramfile.py config_file.cfg`

#### Make rvic parameter file from pour points

`./make_parameters.py config_file.cfg -np $N_PROCESSORS`

where `$N_PROCESSORS` is the number of processors to be used. This uses the Python [multiprocessing](http://docs.python.org/2/library/multiprocessing.html) module.

#### Run the rvic model convolution
`./rvic_model.py config_file.cfg`
See the RVIC Wiki Page](https://github.com/jhamman/RVIC/wiki/RVIC-Wiki)

### Development History
1. Based on the initial model of Lohmann, et al., 1996, Tellus, 48(A), 708-721
2. Currently being coupled as a componenet model in the Comunity Earth System Model (RASM) as part of the Regional Arctic System Model Project.

### Upcoming Development
1. Write core convolution routine in C for speed.
2. History file restarts to further support short model runs.
3. Possible distributed application to support full grid routing (rather than source to sink only).
4. Plans to couple directly to VIC.
1. History file restarts to further support short model runs.
2. Possible distributed application to support full grid routing (rather than source to sink only).
3. Plans to couple directly to VIC.

0 comments on commit 46e94f5

Please sign in to comment.