WinRiver Quick Start Guide

Size: px

Start display at page:

Download "WinRiver Quick Start Guide"

Clarissa McBride
5 years ago
Views:

WinRiver Quick Start Guide P/N 957-6203-00

1 WinRiver Quick Start Guide P/N (October 2003) RD Instruments Acoustic Doppler Solutions

3 Table of Contents... 1 Introduction...1 Overview...1 Hardware Overview...2 ADCP Requirements...2 ADCP Mounting Requirements...2 Software Overview...3 Installing the Software...4 Communications Setup... 5 Changing Communications Setting...7 Customizing WinRiver... 8 General Preferences...8 Creating Workspaces...9 User Options...10 Collecting River Discharge Data Run the Configuration Wizard...14 Mark Transect Start and End Points...16 Transects...18 Viewing Data with WinRiver Using the WinRiver Discharge Measurement Wizard...21 File Naming Conventions WinRiver Shortcut Keys Where to Find More Information... 25

4 NOTES

5 Acoustic Doppler Solutions Introduction Thank you for purchasing the WinRiver software for your WorkHorse ADCP. This Quick Start Guide will lead you through the steps required for a successful river discharge measurement. Please read the entire guide, and then follow the instructions in the order they are presented. Additional information can be found in the WinRiver User s Guide that is supplied on CD-ROM. NOTE. To purchase a printed copy of the WinRiver User s Guide, contact our Customer Service department at rdifs@rdinstruments.com or call (858) and order the WinRiver User s Guide P/N (International Version) or (USGS Version). Overview The first step is to familiarize yourself with the hardware and software that comes with the WorkHorse. This Section Covers: Hardware Overview Software Overview Installing the Software P/N (October 2003) page 1

6 Hardware Overview Take a moment to familiarize yourself with the requirements for a River Discharge deployment. ADCP Requirements In order to use WinRiver, your Workhorse ADCP must meet the following criteria. WorkHorse Rio Grande ADCP or The WorkHorse ADCP must have the Bottom Track upgrade installed NOTE. The Bottom Track upgrade is available for WorkHorse Monitor and Sentinel ADCPs. This guide assumes you will be using a WorkHorse Rio Grande ADCP. ADCP Mounting Requirements The ADCP must be mounted as follows. Over the side or through the hull mounted Downward facing Within 5 degrees of vertical RDI recommends using a fixed mount to achieve the best performance (see the WorkHorse Installation Guide for recommended sources of mounts). page 2 RD Instruments

7 Software Overview You will use two software programs to test and collect data with the WorkHorse ADCP. BBTalk Main Screen BBTalk is a terminal emulator that allows your computer to communicate with the WorkHorse via RS422 or RS232. This guide does not go into detail about the operation of BBTalk. For more information see the RDI Tools User s Guide. WinRiver Main Screen WinRiver may be configured to display the windows arranged and sized, as you prefer. See Creating Workspace, page 9 for more information. P/N (October 2003) page 3

8 Installing the Software You will be installing two software packages. These will be required for testing and deployments. The WorkHorse software requires the following: Windows 95, Windows 98, Windows NT 4.0 with Service Pack 4 installed, Windows 2000, or Windows XP Pentium class PC 233 MHz (350 MHz or higher recommended) 32 megabytes of RAM (64 MB RAM recommended) 6 MB Free Disk Space (20 MB recommended) One Serial Port (two High Speed UART Serial Ports recommended) Minimum display resolution of 800 x 600, 256 color (1024 x 768 recommended) Software Installation a. Insert the compact disc into your CD- ROM drive and then follow the browser instructions on your screen. If the browser does not appear, complete Steps "b" through "d." b. On the Windows task bar, click the Start button, and then click Run. c. Type <drive>:launch. For example, if your CD-ROM drive is drive D, type d:launch. d. Follow the browser instructions on your screen page 4 RD Instruments

Communications Setup When WinRiver is first started in the Acquire mode, you must set up the communications with the ADCP, GPS (if used), External Heading (if used), and Depth

COMPUTER WinRiver Connect and power up the ADCP as shown in the appropriate ADCP User's Guide.

9 Communications Setup When WinRiver is first started in the Acquire mode, you must set up the communications with the ADCP, GPS (if used), External Heading (if used), and Depth Sounder (if used). Once setup, WinRiver will remember the settings and use them each time the program is started. COMPUTER WinRiver Connect and power up the ADCP as shown in the appropriate ADCP User's Guide. ADCP I/O CABLE WorkHorse Rio Grande Shown 12 VDC BATTERY Start WinRiver in the Acquire mode. If you are in the Playback mode, click File, Acquire Mode. To open the Communications Settings dialog box, click Settings, Communications. Press the Add button. Select the device you want to setup and press Next. P/N (October 2003) page 5

Select the COM port that the device is connected to. Only the communication ports installed and available on your system will be displayed. If you are unsure of the setting, use Auto Detect.

WinRiver will connect to the device and confirm the communication setting. Once setup, WinRiver will remember the settings and use them each time the program is started.

10 Select the COM port that the device is connected to. Only the communication ports installed and available on your system will be displayed. If you are unsure of the setting, use Auto Detect. Press Next to continue. Select the baud rate, parity, and stop bits. If you are unsure of the settings, use Auto Detect. Click Next to continue. WinRiver will connect to the device and confirm the communication setting. Once setup, WinRiver will remember the settings and use them each time the program is started. If desired, select the Use Software Breaks box to use the "===" string instead of a break. If desired, click the Inactive box to temporally inactive the device. Click Finish. NOTE. Only Rio Grande firmware and above accepts the software break option. page 6 RD Instruments

11 Changing Communications Setting Once setup, WinRiver will remember the settings and use them each time the program is started. If you want to change the settings, click the Settings menu, Communications and use the following options. Change Communication Settings If you want to change the Com Port selection, use the Remove button and then Add the port back in. If you want to change the baud rate or other properties, click the Properties button. Inactive a Device To temporally inactive a device, click on the device to be inactivated and click the Properties, General tab. Select the Inactive box. The device would not be used during data collection, but its parameters would be remembered. Software Breaks On the Properties, General tab there is another option for the ADCP to use the "===" string instead of a break. NOTE. Only Rio Grande firmware and above accepts this option. P/N (October 2003) page 7

Customizing WinRiver WinRiver can be customized to look and act as you prefer.

widow and selecting Show Toolbar. Right click on the widow and select Properties to change the size of the fonts.

You can change the size of the fonts in tabular plots by right clicking on the widow and selecting Properties.

12 Customizing WinRiver WinRiver can be customized to look and act as you prefer. General Preferences Contour and Stick Ship Track Plots have a tool bar that can be turned on by right clicking on the widow and selecting Show Toolbar. Right click on the widow and select Properties to change the size of the fonts. Choose the font for labels and data. You can change the size of the fonts in tabular plots by right clicking on the widow and selecting Properties. Choose the font for labels and data. On the Settings menu, click Units. You can switch the displays between SI (metric) and English units. On the Settings menu, click Reference. Select the desired reference: Bottom Track, GPS (GGA), GPS (VTG), or None (Boat Speed = 0). If the wrong reference is selected during Playback, data may not display. For example, if you select GPS (GGA) as the reference during Playback and this was not collected when the data file was created, no data will display. page 8 RD Instruments

13 Creating Workspaces A Workspace is a collection of windows arranged and sized, as you prefer. To create a Workspace file, use the View menu to open all the windows you want to see during data collection. A check mark next to the menu item indicates it is being displayed. Arrange the views you are interested in. When you have the displays set up the way you prefer, on the File menu, click Save Workspace File As. You will need to do this step for both Playback and Acquire modes. To return to the default workspace, on the File menu, click Open New Workspace. P/N (October 2003) page 9

Acquire Mode Options Enter the path to your terminal program (normally BBTalk.exe).

14 User Options On the Settings menu, click User Options. The User Options menu sets how WinRiver behaves in the Acquire and Playback modes. Acquire Mode Options Enter the path to your terminal program (normally BBTalk.exe). Use the Browse button to enter the path. This will allow you to call the terminal program in the Acquire mode. Display Options The default settings are shown. page 10 RD Instruments

15 General Options The default settings are shown. Expert Options The default settings are shown. P/N (October 2003) page 11

Collecting River Discharge Data This section has simple instructions for a typical discharge measurement using the ADCP only (no GPS, External Heading or Depth Sounder).

16 Collecting River Discharge Data This section has simple instructions for a typical discharge measurement using the ADCP only (no GPS, External Heading or Depth Sounder). Connect the ADCP and computer as shown in your ADCP User's Guide. Mount the ADCP on the boat at the desired depth (see the WorkHorse Installation Guide). Start WinRiver in the Acquire mode. If you are in the Playback mode, click File, Acquire Mode. page 12 RD Instruments

On the Acquire menu, click Execute Terminal Program to start BBTalk and verify the ADCP is functioning properly (see the RDI Tools User's Guide for details on how to test the

17 On the Acquire menu, click Execute Terminal Program to start BBTalk and verify the ADCP is functioning properly (see the RDI Tools User's Guide for details on how to test the ADCP). On the Acquire menu, click Set ADCP Clock to set the ADCP s time to the PC s time. If necessary, first set the PC's clock first. P/N (October 2003) page 13

Run the Configuration Wizard Configuration Wizard The Configuration Wizard will create a configuration file and enter

On the Settings menu, click Configuration Wizard. 1. Enter your choices for the Recording section.

Use the Output Directory field to select where the data file will be stored. 2.

Shore Ensembles These extra ensembles are recorded to the raw data file during the stationary period at the shore

18 Run the Configuration Wizard Configuration Wizard The Configuration Wizard will create a configuration file and enter the most important information needed for data collection and display during Acquire mode. On the Settings menu, click Configuration Wizard. 1. Enter your choices for the Recording section. WinRiver uses the Filename Prefix to create the data file names made during data collection. Use the Output Directory field to select where the data file will be stored. 2. Enter your choices or accept the defaults for the Discharge section. Shore Ensembles These extra ensembles are recorded to the raw data file during the stationary period at the shore edge help to ensure that you have a good starting ensemble for estimation of the side discharge. 3. Enter your choices or accept the defaults for the ADCP Configuration section. Based on the entered information, the wizard will generate the ADCP commands. page 14 RD Instruments

Enter your choices or accept the defaults for the Devices section. 6. Click the Run Wizard button.

19 4. Enter your choices or accept the defaults for the Offsets section. Use the Transducer Depth field to set the depth from the water surface to the ADCP transducer faces. 5. Enter your choices or accept the defaults for the Devices section. 6. Click the Run Wizard button. If any error messages appear in the Configuration Wizard Warnings box, correct the error and click the Run Wizard button again to verify the configuration file. Click OK to save the configuration file or Save As to save the configuration file as a new file. P/N (October 2003) page 15

Start Pinging On the Acquire menu click Start Pinging (you can customize WinRiver to automatically start pinging when the Acquire mode is started).

20 Mark Transect Start and End Points You must determine the transect start and stop points prior to beginning data collection. Typically, shore ensembles are taken as close to the shoreline as can be measured and still read valid data. Ensembles that contain a minimum of two good depth cells are considered valid data. Start Pinging On the Acquire menu click Start Pinging (you can customize WinRiver to automatically start pinging when the Acquire mode is started). WinRiver will send the commands generated by the configuration wizard to the ADCP. View the Command Log to see if any error occurs. On the View menu, select Tabular Views, Discharge Standard Tabular if this window is not visible. Move out from the shore until the water is deep enough to show Good Bins of two or greater. Values of 0.0 are acceptable, but bad values are invalid. Mark this position (with a float). This is the starting/stopping position for this shore. You will later start/stop data file recording at this location depending on the direction of your transect. page 16 RD Instruments

Move out from the shore traveling slowly with the bow of the boat pointed upstream. Use the Velocity Magnitude Contour display to see how the water depth changes as you make your transect.

21 Move out from the shore traveling slowly with the bow of the boat pointed upstream. Use the Velocity Magnitude Contour display to see how the water depth changes as you make your transect. Note regions where the bottom depth changes quickly. When you approach the other shore, mark the closest distance to shore where two depth cells show discharge values. This will be the start/stopping point for this shore. P/N (October 2003) page 17

Transects Best practices encourage a minimum of four high quality transects be collected that agree with each other to within 5% of the mean of all the samples.

Acquire Data Start Shore Starting at one of the edge positions determined in Mark Transect Start and End Points, page 16, on the Acquire menu click Start Transect (F5) to begin recording.

22 Transects Best practices encourage a minimum of four high quality transects be collected that agree with each other to within 5% of the mean of all the samples. The following sequence must be repeated for every transect taken over the water body. Acquire Data Start Shore Starting at one of the edge positions determined in Mark Transect Start and End Points, page 16, on the Acquire menu click Start Transect (F5) to begin recording. When prompted, enter the beginning distance to the bank and define if this is the left or right bank. When facing downstream, the left bank is on your left side. The edge distance parameters will be saved to the configuration file (*w.000) associated with the raw ADCP data file recorded. Hold this start position and view the Standard Tabular or Composite Tabular display. Check if the Ens. # minus any Bad Ens. is more (or equal) to the number of shore ensembles (the default is 10 shore ensembles). NOTE. If you made a false start, click F5 to stop recording. Restart at the edge by clicking F5 to record to a new file. The Left/Right bank toggles at the end of each transect. Click F5 once more to stop recording. When ready to begin the transect, click F5 again to start recording. Be sure the bank is entered to the correct left/right side. page 18 RD Instruments

Move across the river as slowly as possible. For the best measurement results, the boat s speed over the bottom should be no greater than the water speed of the river.

Continue across the river until you reach the stop position determined in Mark Transect Start and End Points, page 16.

When prompted, enter the ending distance to the bank. That parameter will be saved to the configuration file (*w.000).

23 Move across the river as slowly as possible. For the best measurement results, the boat s speed over the bottom should be no greater than the water speed of the river. Pointing the bow of the boat upstream and slowly crabbing across the river will help to maintain a transect path that is perpendicular to the flow. Continue across the river until you reach the stop position determined in Mark Transect Start and End Points, page 16. You should have discharge values in only the top two depth cells. Stop at this position and wait for the Shore Ensembles measurements to be recorded. Press F5 to stop recording. When prompted, enter the ending distance to the bank. That parameter will be saved to the configuration file (*w.000). Repeat these steps as many times as required for your application. An even number of at least four transects are recommended. When you are finished acquiring the data, press F4 to stop the ADCP pinging. Turn off the power to the ADCP and disconnect the cable. Remember to replace the dummy plug to protect the connector. P/N (October 2003) page 19

Viewing Data with WinRiver The Playback mode of WinRiver is used for post-processing data to get a total discharge value for the channel.

If any of the transects are outside of the tolerance, additional transects should be measured. Start WinRiver in the Playback mode. If you are in the Acquire mode, click File, Playback Mode.

The playback tool bar has functions to start, stop, rewind, and go to the end of the data file. Play back the individual data files with their associated configuration files in the Playback mode.

24 Viewing Data with WinRiver The Playback mode of WinRiver is used for post-processing data to get a total discharge value for the channel. After collecting four transects for each station on the water body, each file must be verified to be within 5% of the mean discharge calculated for the set. If any of the transects are outside of the tolerance, additional transects should be measured. Start WinRiver in the Playback mode. If you are in the Acquire mode, click File, Playback Mode. On the File menu click Open ADCP Raw Data File and select the file to be played. On the Playback menu, click Play to start playing the data. To quickly process the data select Last Ensemble. The playback tool bar has functions to start, stop, rewind, and go to the end of the data file. Play back the individual data files with their associated configuration files in the Playback mode. After playing through the data file, press View, Tabular Views, Discharge Tabular Views, Discharge History Tabular to obtain the total discharge for each measurement. As each data file is played in the Playback mode, the file is added to the Discharge History Tabular screen. The Discharge History Tabular display will automatically calculate the average and other statistics useful in determining the discharge value. NOTE. To remove a file from the table, double-click the file name. You will be prompted to clear only the selected file or the entire table. page 20 RD Instruments

Using the WinRiver Discharge Measurement Wizard The Discharge Measurement Wizard lets you enter station information (station number, station name, gage height, etc.

25 Using the WinRiver Discharge Measurement Wizard The Discharge Measurement Wizard lets you enter station information (station number, station name, gage height, etc.) and creates a summary of the measurement that can be printed and/or saved to a file. To use the wizard, do the following. Start WinRiver in the Playback mode. If you are in the Acquire mode, click File, Playback Mode. On the File menu, click Q Measurements Wizard. On the Q Measurements Wizard screen, enter the General Information, Rating Information, Support Files and Remarks information. Each of these fields will be included on the summary file. Click the Select/Process Files button. On the Select All Files For Processing screen, hold the Ctrl key and click to select each data file. Click Select to begin the processing. When you see the Files Processed Successfully message, click OK to return to the wizard screen. P/N (October 2003) page 21

On the Q Measurements Wizard screen, click Print to print a copy of

26 On the Q Measurements Wizard screen, click Save As to save the information on the wizard screen to a *.dmw file. On the Q Measurements Wizard screen, click Print to print a copy of the discharge summary. Figure 1. WinRiver Discharge Measurement Wizard Printout page 22 RD Instruments

27 File Naming Conventions There are several files associated with the WinRiver software. These files are: Data Files (*r.nnn) These files contain all data sent from the ADCP and other devices during data collection. Refer to the ADCP Technical Manual for a complete description of the format of raw ADCP data files. For any specific deployment, raw data files contain the most information and are usually the largest. Data for this file type is collected through WinRiver s Acquire mode. WinRiver s Playback mode accepts raw ADCP data files for display or reprocessing. Configuration Files (*.wrc, *w.000, *w.001) These ASCII files contain userspecified setup and deployment information. This file shares information between the different WinRiver modes. You can create different configuration files to suit specific applications through the Settings menu, Configuration Settings. Workspace Files (*.wrw) Binary file that contains information about open views, their size, and position. Normally, Acquire will have different window selections and sizes than the Playback mode. Discharge Measurement Wizard Files (*.dmw) These ASCII files contain userspecified information entered in the Discharge Measurement Wizard screen. Navigation Files (*n.nnn) These files contain ASCII data collected from an external navigation device during data acquisition. WinRiver reads the navigation data from a user-specified serial port. Depth Sounder Files (*d.nnn) These files contain ASCII data collected from an external Depth Sounder device during data acquisition. WinRiver reads the depth data from a user-specified serial port. External Heading Files (*h.nnn) (WinRiver International version only) These files contain ASCII data collected from an External Heading device during data acquisition. WinRiver reads the heading data from a user-specified serial port. ASCII-Out Files (*t.nnn) These files contain a fixed format of ASCII text that you can create during post-processing. During playback, you can subsection, average, scale, and process data. You also can write this data to an ASCII file. You can then use these files in other programs (spreadsheets, databases, and word processors). Summary Files (*.sum) These files contain ASCII information about the whole transect. The information is written at the end of the file or subsection. P/N (October 2003) page 23

28 WinRiver Shortcut Keys Key F1 F3 F4 F5 F6 F7 F8 F9 F11 F12 Ctrl-A Ctrl-B Ctrl-C Ctrl-G Ctrl-L Ctrl-L Ctrl-M Ctrl-N Ctrl-O Ctrl-P Ctrl-Q Ctrl-S Ctrl-R Shift-F2 Shift-F4 Shift-F6 Shift-F7 Shift-F8 Shift-F9 Minus Space Ctrl-Space Ctrl-Home Home End Z Description Help Configuration Setting menu Acquire mode = Start/Stop Pinging, Playback mode = Start/Stop Play Acquire mode = Start/Stop Transect, Playback mode = Next Data File File subsection (Playback mode only) User Options Configuration Items Toggle Ensemble Header Tabular view (on/off) Swap Composite Tabular view and Discharge Detail Tabular Toggle Discharge History Tabular view Output ASCII data file (Playback mode only) Bottom Track Reference Copy GPS (GGA) Reference View Command Log (Acquire mode only) Lock/Unlock Configuration File (Playback mode only) Switch to Acquire/Playback mode New Configuration File Open ADCP Raw Data File (Playback mode only) Print (Playback mode only) Discharge Measurement Wizard (Playback mode only) Save Configuration File The Unfreeze button unfreezes all frozen items (blue text). Set PC clock (Acquire mode only) Set ADCP Clock (Acquire mode only) Run Configuration Wizard (Acquire mode only) Start Terminal Program Start Test Program Start Pressure Sensor Program Previous Ensemble (Playback mode only) Next Ensemble (Playback mode only) Several Ensembles (Playback mode only) Go to Ensemble (Playback mode only) First Ensemble (Playback mode only) Last Ensemble (Playback mode only) Zoom to Data page 24 RD Instruments

29 Where to Find More Information Congratulations! You have completed the Quick Start Guide. For more detailed information, see the following sections in the WinRiver User s Guide. Using the Configuration Wizard This section covers how to create a configuration file using the Configuration Wizard and a detailed explanation of each tab in the Settings menu, Configuration Settings. Acquiring Discharge Data This section is a more detailed explanation of the steps covered in the Quick Start Guide. Post-Processing of Discharge Data This sections covers data playback, processing, and the Discharge Measurement Wizard. Integrating Depth Sounder, External Heading, and GPS Data Use this section to integrate External heading, GPS data, and depth sounder data into your real-time discharge calculations. These devices are used when environmental conditions make it difficult to get unbiased boat velocity and/or depth using bottom tracking. ADCP Commands Use this section for a description of each command and guidelines for setting these commands to acquire reliable discharge data. Water Profiling Modes This section explains all of the water-profiling modes available for the WorkHorse Rio Grande, Mariner ADCPs, and WorkHorse ADCPs with the high-resolution water profiling upgrade installed. For each mode, we provide a general description, an explanation of the best place to use this mode, specifics about the mode, and any setup considerations. P/N (October 2003) page 25

30 NOTES page 26 RD Instruments

WinH-ADCP User s Guide

WinH-ADCP User s Guide P/N 95B-6000-00 (January 2005) RD Instruments Acoustic Doppler Solutions Table of Contents 1 Introduction... 1 1.1 System Requirements...1 1.2 Software Installation...2 1.3 Conventions