User Manual

[ Introduction | Installation | Getting Started | Detailed Instruction | Glossary ]


Detailed Instruction

[ Detailed Explanation of the GUI | Command Line Syntax | Default Values ]


The Java GUI Detailed Explantion

File Tab

File Pane

This tab allows the user to specify the input files that will be used in the simulation. It gives the user a number of ways to select the appropriate files. Unlike most other options in the user interface, the WorldFile does not have a default value, and therefore, must be specified. The TEC file and FlowPaths file are not required, and can be left blank.

The following are the options provided to specify the input files:

The WorldFile can be specified in a variety of ways by:

The TEC file can also be specified in a variety of ways by:

The FlowPaths file can also be specified in a variety of ways by:

Choose a file from the file chooser


Optional Start and End dates for the simulation can also be specifed via the textboxes at the bottom of the screen. If these are specified, they will overide the start and end dates specified in the WorldFile.

The Start Simulation button at the bottom of the screen causes the simulation to begin. It connects with the server, and passes it the start options specified in the interface. If all the options are valid, the simulation is started. When the simulation starts, two windows displaying STDERR and STDOUT messages will be displayed.

The Stop Simulation button to the right of the Start Simulation button aborts the simulation.


Output Options Tab

Output Options Pane

This tab allows the user to specify the output options for the simulation, and to specify a prefix for the output files to be produced. Output can be requested in a separate file corresponding to a level in the object hierarchy. Output files are created for annual, monthly, daily and hourly state variables.

The default option is NO OUTPUT.

There are 6 checkboxes, corresponding to the types of output that a user can specify. Clicking on any of the checkboxes will bring up an input dialog for the output option. The user can choose to specify "All" or to input specific IDs in the dialog. For example, click on "Basin Output -b" will bring up the input dialog. In the dialog, the user can specify to use all basins for specific basins with the provided basin ID.

The first option is for Basin output. The default for this is NO OUTPUT. If the user selects the checkbox, a dialog will open up, allowing the user to specify whether to produce output for all basins, or for a single basin.

Output Option Pane with a dialog for the -b option

The default output file for this option is world_basin.<time_step>

The second option is for Stratum output. Like the Basin output option, its default is NO Output. If the checkbox is selected, a similar dialog to the that appears for the Basins is displayed. The default output file for this option is world_stratum. <time_step>.

The options for Hillslope, Zone, and Patch output are similar to the first two options. The default output files for the three are: world_hillslope.<time_step>, world_zone.<time_step>, and world_patch.<time_step>, respectively.

The Output Prefix text field is where a prefix can be specified for the output files. For example, entering the prefix "boreas", will produce output files with names like "boreas_patch.monthly" and "boreas_zone.yearly".


Control Options Tab

Control Options Pane

This tab allows the user to specify to control options for the simulation.

First, a combo box allows for the specification of the detail level of status reports that will be produced by the model. The following are the various levels that can be selected:

The second option indicates that the input specification files with appropri$ been provided in the input files. Additionally, selecting the checkbox will cause all output to include "grow" parameters as well.

The third option is Sensitivity Analysis and Calibration Option. There are two parameters for this option.


Command Line Tab

Command Line Pane

Experienced users should only use this screen!

Clicking on the button "Build Command Line From Input" displays the command line corresponding to the input specified in the previous screens of the interface.

Selecting the option, "Override Command Line", overrides all of the options specified in the File, Ouput Options, and Control Options Tabs.  If this option is checked, then the user can specify their own command line in the Text Area labeled "Command Line".

If the user chooses to specify their own command line, then they must follow the syntax specified by the rhessys model. The syntax, taken from "main.c" of the source code, is presented in the command line syntax section.


Output Variable Tab

Output Variable Pane

User can choose up to 4 output variables for visualization output. The default is NO VISUALIZATION

To choose to use one or more output variables, click on one or more of the checkboxes corresponding to each output variable. Once the user chooses 1 or more output variables, he must supply the variable name, start time, end time, and time interval (step) for each variable to be plotted on a line graph.

This functionality is not yet implemented in this version of Rhesyss.