~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
              GUI Hydrological Research Tool (XRT) Quick Start
             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

~~~~~~~~~~~~~~~~~~~~~~~~~~~
How To Start 
~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Type "xrt" on the command prompt will start the GUI.


~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Main Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The main menu include:
1) File  --- Open, Create New, Save HLRMS input deck
2) Edit  --- View current input deck
3) HLRMS --- Run HLRMS using current input deck
4) Time Series --- Time series display
5) Grid --- XMRG Gridded data display


~~~~~~~~~~~~~~~~~~~~~~~~~~~
The File Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The File Menu contains:
1) New Deck --- Create a new deck
2) Open Deck --- Open an existing deck
3) Save Deck --- Save deck, Save current Deck to disk
4) Open Project --- Open an existing project (under development)
5) Save Project --- Save current project to disk (under development)

~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Input Deck Dialog
~~~~~~~~~~~~~~~~~~~~~~~~~~~
File --> New Deck
or
File --> Open Deck

opens an Input deck dialog.

1) On tab page "Time"
   1. set simulation period --- begin and end time
   2. Set simulation time step
   3. set runoff and routing states output interval in number of time steps
2) On tab page "Model"
   1. Select water balance model type, parameter grid number, parameter number
      and state number
   2. Select snow model type,  parameter grid number, parameter number and 
      state number
   3. Select output directory
   4. Select parameter directory
   5. Select XMRG precipitation directory
   6. Select number of year digits in the XMRG filename
   7. Specify precipitation type (lumped or distributed)
   8. Specify XMRG file endian (big endian or little endian)
3) On tab page "Frozen Ground"
   1. Select frozen ground model type, parameter grid number, parameter number
      and state number
4) On tab page "Basin/Region"
   1. Select run with/without connectivity
      a) run with connectivity
         a. Select routing model, routing parameter grid number, routing
            parameter number, and state number
         b. Select connectivity file
         c. Display basin connectivity and set parameters, states, other data
            for each basin,
            * left click select a single basin
            * Ctrl + left click select multiple basins
            * Right click open a dialog to set values for each parameter, 
              state for each selected basin
      b) run without connectivity
         a. Set the simulation window
         b. Set subregions within the simulation window
         c. Push Edit Factors button to set values for each parameter, state
            for the simulation window

~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Edit Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1) Deck --- Open the current input deck. If no current deck, do nothing
2) Undo --- Currently under development
3) Redo --- Currently under development

~~~~~~~~~~~~~~~~~~~~~~~~~~~
The HLRMS Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1) Run --- Run HLRMS using current input deck. If no current deck, it is 
           disabled.
           When HLRMS is finished, the time series dialog pops up and 
           the hydrographs, precipitation, and state time series for each
           basin are display

~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Time Series Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1) Plot --- Opens the time series dialog. The time series dialog can have
            multipanes. Each panel, a legend on the left, a main window 
            for drawing, and a control area on the right. There is also 
            a status bar on the bottom of the dialog.
   File --> Add pane --- add a new pane
   File --> Remove pane --- remove panes
   File --> Close --- Close the time series dialog

   Mouse right click while the mouse pointer is on the main window pops up a 
          pop-up menu with 3 items:
   1) Add time series --- add a time series to this pane
   2) Remove time series --- Remove a time series to this pane
   3) Save as image --- under development

   Mouse left click zoom in, Mouse middle click zoom out

   The Control area:
   1) Turn on the Zoom Vertical toggle button, time series display will
      zoom in/out vertically in addition horizontally  
   2) Turn on the Log Scale toggle button, the time series plot Y axis will
      be in log scale

   The scroll bar just above the status bar scrolls the time series left and 
   right

~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Grid Menu
~~~~~~~~~~~~~~~~~~~~~~~~~~~
The grid display uses the main window of the xrt. 
1) There is a status bar at the bottom which displays pixel values, latlon, 
   and HRAP coordinates when the mouse pointer moves over the grid display.
2) Just above the status bar is the legend.
3) Left of the main window is the control to turn on/off XMRG Grid display
4) The main window displays XMRG grid

Grid --> Open --- opens an XMRG Grid
     --> Remove --- Remove XMRG Grids from the display
     --> Animation --- under development
     --> 3D view --- under development
     --> Contour View --- under development

Mouse operations:

Mouse --> Move --- display values, latlon and HRAP coordinates on the status
                   bar
      --> Left click --- zoom in
      --> Middle click --- zoom out
      --> Hold Left button while drag --- draw a rubber band rectangle and 
                                          zoom in to the area defined by 
                                          the rectangle

      --> Right click --- pops up a popup menu
      
         Popup Menu --> Full Extent --- Zoom to full extent
                        Current Extent --- Zoom to current extent
                        Zoom In --- Zoom in to center point
                        Zoom Out --- Zoom out to center point


~~~~~~~~~~~~~~~~~~~~~~~~~~~
Bugs
~~~~~~~~~~~~~~~~~~~~~~~~~~~
     Good bug reports make us serve you better. Please send bug reports and
     comments to Zhengtao.Cui@noaa.gov.