Command line options

IN BRIEF

-b Basin output option. Print out response variables for

specified basins.

-c Canopy stratum output option. Print out response variables for specified strata.

-g Grow option. Try to read in dynamic bgc input data and

output dynamic bgc parameters.

-h Hillslope output option. Print out response variables

for specified hillslopes.

-p Patch output option. Print out response variables for

specified patches.

-r Routing option. Gives name of flow_table to define explicit routing

connectivity. Also trigger use of explicit routing over TOPMODEL approach

-c Stratum output option. Print out response variables for

specified strata.

-t Name of the temporal event control file.

-v Verbose option.

none or 0 = most basic reporting

1 = interim results reporting (daily only)

2 = code debugging reporting (daily only)

3 = code debugging reporting (daily and hourly)

-w Name of world file.

-z Zone output option. Print out response variables for

specified zones.

-pre Give a particular output prefix.

-st start date (optional over-ride of worldfile)

-ed end date (optional over-ride of worldfile)

 

DETAIL

The default output is NO OUTPUT.

Output can be requested in a separate file corresponding

to a certain level of the modelling object heirarchy:

basins, hillslopes, zones, intervals, patches.

If no arguements follow an output flag ALL of the objects

defined at the selected level of the heirarchy will be

printed to the appropriate SINGLE output file.

ID's at selected level in option structure

are set to -999 to indicate this conditions

One can also opt to print out only one those objects attached

to one BRANCH of the modelling object heirarchy. To do

this one should specify valid ID numbers defining the connection

from the world object to the branch requested.

Verification of the fact that the connection between the

world object and the branch requested does in fact exist will

be performed.

In all cases output files will be created for annual,

monthly, daily and hourly state variables as defined

in the source code which handles the output for the

selected level of the hierarchy and selected time step.

The -b option produces one output data file per time step.

The output file gives the response of each basin for each

model time step output data is requested.

The output file has a default name world_basin.<time_step>.

The -h option produces one output data file per time step.

The output file gives the response of each hillslope in the

basin for each model time step output is requested.

The output file has a default name world_hillslope.<time_step>.

The -z option produces one output data file per time step.

The output file gives the response of each zone in the

basin for each model time step output is requested.

The output file has a default name world_zone.<time_step>.

The -p option produces one output data file per time step.

The output file gives the response of each patch in the

basin for each model time step output is requested.

The output file has a default name world_patch.<time_step>.

The -c option produces one output data file per time step.

The output file gives the response of each stratum in the

basin for each model time step output is requested.

The output file has a default name world_stratum.<time_step>.

The -pre option followed by a character string will add a

prefix to each output file.

The -s option produces one output data file per time step.

The output file gives the response of each patch in the

basin for each model time step output is requested.

The output file has a default name world_patch.<time_step>.

CONTROL OPTIONS

The -g option implies that the user has provided input

specifiction files which have appropriate "grow" parameters

required by dynamic bgc. In addition, all output will also

include grow parameters. The "grow" parameters are ignored

and dynamicgc does not execute many rountines if -g is not

used.

The -v option will result in various status reports being

sent to stdout. Lines of verbose output have a date stamp

and a stamp identifying what part of the source code they

are from.

The -w option followed by a valid world file name specifies

the world file to use with the simulation run.

The -t option allows the user to specify the time duration

over which the response variables for the selected output

mapping unit will be printed. If the -t option is not

used the time interval is defaulted as the range specified

by startday and endday in the "world.ini" file.

The -t option requires the user to have already created an

ASCII time event control (tec) file with the format:

<start of file>

start_out_date end_out_date

start_out_date end_out_date

start_out_date end_out_date

.

.

.

start_out_date end_out_date

<end of file>

The additional constraints placed upon the TEC file are:

1. All of the dates must match entries in

all the base station clim files for each time step.

2. The days must be listed in non-decreasing order from

the first to nth entry pair.

3. There must be both a start and end date for every entry.

To implement this file we have had to also enforce that

all clim files have dates which increase sequentially and

cover the requested intervals.

EXAMPLES

1. Run the simulation using the world file "sobs.world"

with the TEC file "sobs.tec" and get output for each basin

present. Use the prefix "boreas" for the output files:

%rhessys -w sobs.world -t sobs.tec -p -pre boreas

This will result in a four output files called

"boreas_patch.yearly", "boreas_patch.monthly",

"boreas_patch.daily", and "boreas_patch.hourly"

which will contain response at the

patch level for each patch specified in the sobs.world file

for the time durations specified in sobs.tec.

Each line in the output files will have a date stamp and

will uniquely identify the patch the line corresponds to.

2. Repeat example 1. but only get output for the basin specified

by patch ID 1111 found in basin ID 1 , hillslope ID 11 and

zone 111 (note that the ID's used here are arbitrary and

no world ID is required as only a single world object is

permitted):

%rhessys -w boreas.ini -t ndvi.tec -p 1 11 111 1111 -pre boreas

The output files will have the same name

as in example 1.

3. Run the simulation using the world file "tlw.world" with the

TEC file "tlw.tec" and get output for:

- the basin with basinID = 1

- all hillslopes in the basin with basinID = 2

- stratum 2 in patch 5 of zone 2 of hillslope 1 of basin 1

%rhessys -w boreas.ini -t century.tec -b 1 -h 2 -p 1 1 2 5 2

 

NOTES

The -b, -h, -z, -i and -p output options can be used in

parallel.

We have purposely avoided the ability for separate -t files

for separate mapping units.

We have purposely avoided the ability for being able to

specify output without traversing down a branch in the

modelling object heirarchy (e.g. no asking for zone 1 for

all hillslopes for basin 1 ; but you can ask for all zones

for all hillslopes for basin 1).

PROGRAMMERS NOTES

The -v verbose option results in responses being directed

to stdout. Any additional -v responses added later should

follow this convention OR make a wholesale change on

all -v responses.