INTRODUCTION
The RGM HEC 2000 program provides an interactive graphical user interface to the Army Corps of Engineers HEC-1 computer program. The program operates in a Windows™ environment and uses familiar menus, controls and procedures.
The program was written to benefit engineers, hydrologists and students by maintaining the classic features of HEC-1 and providing a user-friendly environment that is compatible with Microsoft Windows. For example, various types of data from RGM HEC 2000 can be copied across applications, such as Excel or Word using the clipboard. Also, graphs produced by the program are presented in a standard graphical format for use in other software, such as word processors.
The software presumes the user has a working knowledge of HEC-1 though the software product is also intended to assist in the education of the user.
The HEC-1 program is distributed herein, in conformance with the Army Corps of Engineers stipulations that permits unlimited distribution. All of the files that are necessary to operate the program are shipped with the RGM HEC 2000 software package.
INSTALLING RGM HEC 2000
The program is installed from the Install CD by executing the Setup.exe file in the root directory. The installation instructions are presented in successive screens and are self-explanatory.
The project files may be set up in separate directories to maintain good file housekeeping. RGM HEC 2000 will operate on the project files from its own application directory.
Each INSTALL CD is coded by Version Number and a unique Serial Number. These numbers can be recalled during program operation using the About Menu.
Executing the program file RGMHEC2000.exe or the shortcut starts the program with the start-up information screen. Click the screen to proceed.
AUTHORIZING RGM HEC 2000
Upon first installation the authorization screen will appear. The user must provide a name and the authorization code as found on the CD packaging. The user name and serial number are identified with one computer user and, in that context, the program will operate without interruption.
PROGRAM OPERATION
OPEN an Existing HEC-1 Input File
Use FILE, OPEN, and then browse for the appropriate file name. For convenience, some standard HEC-1 sample files are provided on the Install CD.
If any files appear in the list at FILE, Open Recent Files Saved As: a file can be opened by clicking the file reference.
The HEC-1 input file is in text format using Fortran type columns. RGM HEC 2000 simplifies data entry using a specialized spreadsheet designed specifically for HEC-1 input.
Create a NEW Input File
Data may be entered directly into the spreadsheet. Navigation Keys are available to speed data entry. The descriptions of the specialized features of the spreadsheet are provided later in this document.
Auditing the Input Data
RGM HEC 2000 provides a simple error checker using the AUDIT DATA menu. This routine checks for obvious errors in your data, such as too many characters in a column, or lack of the ZZ card, to name two. The error(s), if any, are reported in a message box.
Run HEC-1
HEC-1 is accessed using the RUN menu. Depending on the computer speed, the results are available almost instantaneously.
The results of a HEC-1 run may be viewed in RGM HEC 2000 in several ways, as follows:
Viewing the HEC-1 Output File
The output of HEC-1 is a text file that may be read directly from RGM HEC 2000 using the VIEW HEC-1 OUTPUT menu. The program knows to read the latest HEC-1 output file.
There are screen action buttons that allow the user to navigate quickly to the bottom and top of the file as well as a right-button menu with the same features.
Data from the output file may be copied for use in another program, or the text output may be saved or printed in whole or in multiple selections. A Zoom feature is also provided since fonts are generally small to fit on a standard page width. In Zoom mode a horizontal scroll bar facilitates viewing.
Viewing Tabular Hydrograph Data
To request specific hydrographs be output from HEC-1, the user must provide a KO card with the value 21 in the five column. The KO card is typically entered after the KK card, and RGM HEC 2000 provides automation for this in the TOOLS menu.
When the program has RUN, and after the GRAPH DATA menu -- then GRAPH menu have been accessed, the user may view tabular hydrograph data in three formats:
Hydrodata - shows three decimal hydrograph ordinates for the runoff duration for each hydrograph written out using the KO card with a value of 21 in column five.
Runoff Volumes – the runoff volume of each hydrograph, obtained by directly computing the hydrograph area is written out using the KO card with a value of 21 in column 5 is presented on this Table. If the hydrograph does not close to the base axis a warning will be issued.
Tabular Peak Flows - a table of the peak hydrograph flows versus the KK station for each hydrograph written out using the KO card with a value of 21 in column five.
Viewing Hydrographs Graphically
RGM HEC 2000 contains a powerful yet simple graphing routine to allow the user to visualize hydrographs easily with a minimum of user intervention. The hydrographs that are written out are identified by inserting a KO card (with a value of 21 in column 5) after the KK card of the requested station.
To view the hydrographs access the GRAPH DATA menu then GRAPH menu. Select the KK station and Plan. Use the GRAPH menu or GRAPH button and the hydrograph will be displayed.
RGM HEC 2000 selects differing colors each time the screen is redrawn. This feature is provided to assist the user in distinguishing lines on computer monitors. Selecting the GRAPH button additional times will reset to a new palette of colors each time.
Scaling Graphs
There are four (4) sliders to adjust the plot. One may use the Y Expansion scroller along the right side, the X Expansion or the Pan Shift scroller interactively until a good representation of the plot is found. The values near each slider provide a numerical reference of the relative scales.
The Zoom slider widens the plot in increments and centers the plot.
The vertical scale tick marks are automatically adjusted by the Graph routine.
In addition, one may determine roughly the hydrograph values on the plot using the mouse. The Y value (usually cfs) and the Time value are shown on the Information screen as the mouse is moved.
Graphs may be enlarged by resizing the window, creating a higher resolution image for export.
Graph Line Width
Adjust the graphs line width using the slider. The graph will redraw on each change.
Editing the Graphs
There are four methods provided to edit the plotted hydrographs.
On-the-Fly Annotation – Left button click and select a hydrograph in the Properties list box. Right-click and drag the text box to a point on the graphing screen. Continue moving the text line using the right mouse button. Double click to “set” the text box on the screen.
Text Mode - Click the empty top line of Properties list and a user text box can be dragged to the screen. Enter text directly in the box or move with a right mouse button to another part of the screen. Final set the text by Double-Clicking the Text Box.
Erase Mode - Click the ERASE MODE button and window a portion of the screen to erase.
Graph Editor - The RGM HEC 2000 program ships with a copy of Windows paint, which is actually provided by windows to all users as a part of the operation system. Click the GRAPH EDITOR button and the hydrograph screen will be presented in Windows Paint for editing. Consult the Windows manual for instructions on the use of MSPaint, however, it is a fairly straightforward program that can be operated using the toolbars and menus. Graphs can be saved during this procedure as well as from the EXPORT GRAPH button. Any registered Windows graph editor will work though it must be OLE compatible (Windows style programs). Apple Quick Time will stall as it is not OLE compliant.
When editing is complete the user can click the FILE, EXIT AND RETURN menus to return to RGM HEC 2000. You are then asked if you want to keep the edit or discard the edit and return to the previous view. Click NO EDIT if you want to discard the changes and click KEEP EDIT if you want to keep the edited version.
Clear Graphic - clears the current screen including any floating text box labels. Generally, you can restore a cleared graphic by clicking KEEP EDIT after the GRAPH EDITOR. Of course, one can redraw the selected graphs by merely clicking GRAPH as many times as needed to achieve the desired color palette.
File operations of the Graph Routine
There are three file operations in the Graph routine.
Exporting or Saving a Graph - use EXPORT GRAPH to save the graph to a disk file. The graph is saved in Windows BMP format in the directory selected. Floating labels must be “set” before an export will proceed.
Saving a KK/Plan Scheme - occasionally the user has developed a group of hydrographs that may need to be saved as a set for future use. Click FILE, SAVE KK/PLAN SCHEME to save the set of KK stations and Plans that are currently checked.
Loading a KK/Plan Scheme - The saved set or schemes can be retrieved using menus FILE, LOAD KK/PLAN SCHEME.
RETURN to the Main screen to continue, or to revise data for another run.
Using the Graph Data
RGM HEC 2000 provides a number of useful routines that evaluate the data produced by HEC-1.
Quick Hydrographs
From the Graph Data / Hydrodata (All) / Quick Hydrograph Menus – simple graphs can be plotted using areas selected from the Hydrodata spreadsheet. These graphs may be edited for format by stretching or dragging various elements. These graphs may be exported and pasted into other applications.
RESERVOIR ROUTING OUTPUT
This routine can be used to review all hydraulic routings produced by HEC-1. For example, if there are detention basins in the output, one can review the HEC-1 output screen and scroll to the position of the sought routing. However, the Reservoir Routing Output condenses the output information into one screen. This feature can be used when iterating to a specific flood stage elevation or outflow.
When HEC-1 is run again the output screen is updated, when activated, with the new data.
This form may be kept on top of other windows or returned to a normal position by selecting the appropriate menu.
AUTO COMPARE KK PLANS
Use this feature to compare sets of KK stations. Click the first Station and it will appear on the mid-screen, then click another KK station and it will appear and be compared. If the second line value is greater than the first line value, it will be highlighted. This feature is useful when iterating to a solution between two stations where the second line values of flow must be less than or equal to the first line values, as is often the goal in storm water management when comparing existing and proposed cases.
Click on the Compared pane and the pane will be cleared. Refresh data if necessary. The user may copy data to the Clipboard during this routine, for use in other applications.
When HEC-1 is run again the screen is updated, when activated, with the new data.
This form may be kept on top of other windows or returned to a normal position by selecting the appropriate menu.
Link Peak File – To extend the ability to compare peak flows, one may Link the chart to data from earlier runs that have been saved (PEK extension) in the Tabular Peak Flow (GRAPH) routine. The linked files are maintained until the AUTO COMPARE KK PLANS routine is ended in any session.
MULTI- KK COMPARE
A series of KK comparison sets can be listed from the left pane. If the second line value is greater than the first line value, it will be highlighted. Item pairs can be removed or added one KK station at a time using the ADD and REMOVE buttons.
When HEC-1 is run again the screen is updated, when activated, with the new data.
This form may be kept on top of other windows or returned to a normal position by selecting the appropriate menu.
Link Peak File – To extend the ability to compare peak flows over several design points, one may Link the chart to data from earlier runs that have been saved (PEK extension) in the Tabular Peak Flow (GRAPH) routine. The linked files are maintained until the MULTI KK COMPARE routine is ended in any session. However, the KK comparison List may be saved for future use, and the Linked file will be saved also. The comparison List will be rebuilt on loading the KK comparison List.
PRINTING GRAPHS
Graphs may be printed in three ways:
Simple Print Graph located in the File menu in the Graph Program; permits basic printing to the default printer or selected printer and allows adjustment of the margins, and control over landscape and portrait style. Floating labels must be “set” by double clicking before printing can proceed.
Graph Editor; the users default graph editor (e.g. MS PAINT) can be accessed by the Graph Editor in the Graph Routine.
Export Graph, can be used to save the graph to a disk file for later printing by appropriate software, or inclusion as a picture file in other applications. Floating labels must be “set” to proceed.
Opening Files
FILE, OPEN will open a standard HEC-1 input file in column format.
Drag a file, will OPEN the file dragged to the main screen from another Windows application such as Explorer.
FILE, IMPORT INPUT DATA - allows the opening of another HEC-1 input file to examine or copy data.
FILE, USE FREE OR RAW DATA - allows user to open and convert a HEC-1 File that was written in free format (*FREE card was used in the file). RAW input is plain text data that one wishes to convert to HEC-1 Format.
The Free Format screen is used to enter data in free format, OPEN or PASTE a file. From the menu, CONVERT to FIXED FORMAT and review whether the convert worked sufficiently. A properly formatted HEC-1 File in FREE format should convert correctly. If there are extra spaces, tabs or commas in the FREE or RAW file, these can be removed and adjusted in the Free Format screen, then convert again. One may Save or Copy the File from the Free Format Input Screen that shows after CONVERT is pressed.
FILE, Open Recent Files Saved As: - select the file and it will be opened.
Saving Files
FILE, SAVE - saves the HEC-1 input file
FILE, SAVE AS - saves the HEC-1 input file and records the data and time in the recent file list.
Quitting the Program
FILE, QUIT PROGRAM ends the RGM HEC 2000 program and returns the user to Windows™. Appropriate screen safeguards are built in to prevent the accidental loss of data.
The Data Entry Spreadsheet
There are various features of the active spreadsheet that assist the user in important ways. These are enumerated as follows:
Cell Color Modes
Cell Color indicates five modes - the user cannot change these colors:
Light Blue - spreadsheet editing has not yet been started.
Blue - Quiet Mode: cell editing is not being performed. Use the TAB key toggle-editing mode.
Pink - Edit Mode: indication that an individual cell can be edited. This is the normal mode. Use the TAB key to toggle to quiet mode.
White - Inactive Mode: group cell selection can begin on a white cell (or a cell already selected).
Yellow - Cell Alert Mode: indicates there are too many characters in the specific cell of a column in violation of the HEC-1 standard. Remove characters in the cell to return to editing mode.
Spreadsheet Editing
Editing Comment Card (KM), ID cards, KK cards, "*" Cards - use COMMENT ENTRY or double click the left, fixed column to enter the comment card edit mode. The Edit Comments screen will appear and allow a more convenient form of text entry than entering data field by field. The user can hit ENTER or SAVE AND EXIT to save the editing line. Use ESC key to exit, or the CANCEL EDIT button.
Editing Cell Text - click into any cell to edit cell text. Editing is complete when the active cell is changed by; arrow keys, mouse moves or ENTERS. Cell editing features are available also on the right mouse button.
For the users convenience, the comment card editor will not edit the station name of the KK card, only the columns beyond that provide descriptive or comment type data.
INSERT ROW inserts a row above the current cursor position.
DELETE ROW deletes the row of the active cell.
DELETE LINES - from the RIGHT BUTTON, DELETE LINES menu or the EDIT, DELETE LINES menu deletes a selection of lines.
EDIT UNDO / REDO – unlimited levels of undo are available. The REDO command will bring the screen back to the last undo one time only. A record of the Undo level is presented on the status bar. A value of 1 indicates the system has undone all edits.
EDIT, COPY will copy a selection.
EDIT, CUT will erase or cut out a selection.
EDIT, PASTE ABOVE / INSERT LINES will insert the number of cells necessary to paste the clipboard to the spreadsheet starting at the active cell position.
EDIT, AREA PASTE OVER will overlay the clipboard contents starting at the active cell position, replacing the current contents of the cells with the pasted data.
EDIT, CLEAR CONTENTS is similar to EDIT, CUT except that the contents are not entered into the Clipboard. It is possible to use UNDO to retrieve data erased by CLEAR CONTENTS.
Spreadsheet Speed Keys
Most commands may be accessed by speed keys using the ALT key or CTRL key.
Use the ALT key and the underlined letter of the respective command to access commands located in the top menu of each screen.
Speed Keys