Link to USGS home USGS Home
Contact USGS
Search USGS
OSW Hydroacoustics

QRev


Description

QRev is a Matlab program developed by OSW to to compute the discharge from a moving-boat ADCP measurement using data collected with any of the Teledyne RD Instrument (TRDI) or SonTek bottom tracking ADCPs. QRev improves the consistency and efficiency of processing streamflow measurements by providing:

  • Automated data quality checks with feedback to the user
  • Automated data filtering
  • Automated application of extrap, LC, and SMBA algorithms
  • Consistent processing algorithms independent of the ADCP used to collect the data
  • Improved handing of invalid data
  • An estimated uncertainty to help guide the user in rating the measurement

Because QRev uses data filters, interpolation algorithms, and computations that may be different from WinRiver II and RiverSurveyor Live, the the discharge computed with QRev using default settings may be different than discharges computed by WinRiver II and RiverSurveyor Live.

Office of Surface Water Technical Memorandum 2016.03 recommends and authorizes the use of QRev for processing discharge measurments made with an ADCP from a moving-boat.

QRev can be used on desktops, laptops, and tablets running either 32- or 64-bit versions1 of the Windows operating system. QRev should be used in the field to process measurement immediately after data collection and in the office to review measurements. The graphical user interface for QRev was designed to work on tablets, so most controls are buttons, radio buttons, and check boxes that can be easily operated by tapping on the screen. QRev is written and compiled with Matlab and requires the installation of the Matlab runtime libraries.

1NOTE: 32-bit operating systems will only be supported through about mid-2017 as Mathworks has announced that the 2015b release of Matlab is the last Matlab version that will support 32-bit operating systems.


Links

Download

Installation Instructions

Updates and Bugs

Integration with SV Mobile and NWIS

Recommended Workflow

Viewing QRev Summary without SV Mobile

User's Manual (Note: This is out of date with current software version, see User's Guide in software.)

Technical Manual

Recorded Webinar

Source Code Repository


Download

USGS Software Users Rights Notice

QRev can be downloaded by clicking on the version number in the table below. *_32 is a 32-bit verison. *_64 is a 64-bit version.

Version
Status
Changes and Known Issues
3.35_32

3.35_64

9/13/2017
Recommended

- Fixed bug causing causing crash if ADCP had no compass
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
- Known Issue: PT3 quality check for EMI generating caution messages when the probability of EMI affecting the data is extremely low.
3.34_32

3.34_64

9/11/2017
Testing

- Won't work if the ADCP has no compass
- Fixed bug causing excluded distance to be applied to RiverPro
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
3.33_32

3.33_64

9/5/2017
Testing

- Exluded distance applied incorrectly to RiverPro ADCPs - Fixes all bugs found in version 3.31.
- Legend location is now dynamic and should be optimized for the plot.
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
3.31_32

3.31_64

8/4/2017
Testing

- Fixes all identified bugs found in prior versions.
- Messages are now in a table, sorted with warnings on top, and identified with a symbol and font.
- Discharge is interpolated for ensembles that are too shallow for a valid depth cell.
- Modified interpolation algorithm when composite tracks or depths are used.
- Clicking on a message will open the associated window, same as clicking on associated button.
- Extrapolation discharge sensitivity table is now referenced to the currently selected fit, rather than to power/power 0.1667.
- Clicking a row in the extrapolation discharge sensitivity table will set the fit to those parameters.
- The compass error from the evaluation of a TRDI ADCP and if available, from RiverSurveyor G3 compass is now shown in the Compass/P/R window and check against USGS recommendations.
- The system test window now displays the total number of tests.
- The PT3 test is now decoded and the correlation in lag 3 is checked to ensure that the correlation is less than 15% of the lag 0 correlation.
- View Comments button is now accessible even when another window is open.
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
3.23_32

3.23_64

4/24/2017
Testing

- Fixes all identified bugs found in version 3.21
- Save Only Checked and Uncheck All Transects is now tablet friendly, they don't require using keyboard.
- Improved handling of illegal XML characters in mmt files.
- Added message when moving-bed tests are selected manually.
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
3.21_32

3.21_64

2/21/2017
Required Minimum as of 2/27/2017

- Fixes all identified bugs found in version 3.12
- Added EDI interface for Equal Discharge Increment sampling.
- For higher resolution screens or those with magnified display settings, some windows may need to be maximized to see all buttons and labels.
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
3.12_32

3.12_64

11/04/2016
Allowed
prior to 2/27/2017


- Fixes all identified bugs found in testing version 3.10
- Adds a minimum threshold to the automatic bottom track error velocity filter.
- For a complete list of changes and bug fixes click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
- KNOWN ISSUE: If only 2 transects are checked, the "Use" in the detail table will be highlighted Red even when there is no problem.
- KNOWN ISSUE: A change in speed of sound will result in an error when saving the XML file.
- KNOWN ISSUE: Loading transect with only 1 ensemble will cause QRev to crash. Work around: uncheck that transect in WinRiver II and load only checked transects in QRev
3.10_32

3.10_64

9/29/2016
Allowed
prior to 2/27/2017

- MAJOR UPDATE!
- Support of external heading
- RioPro now defaults to an excluded distance of 25 cm
- Only checked transects shown in filter windows
- Better support for processing tidal measurements
- GPS and Beam filters adjusted
- New and updated User's Guide
- Editing values in tables changed
- For a complete list of changes and explanation of new features click here.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
2.90_32

2.90_64

5/12/2016

Allowed
prior to 2/27/2017


- Changed the format of the *_QRev.mat file to reduce the file size. Version 2.90 can read *_QRev.mat files from previous versions but previous version will not be able to read version 2.90 *_QRev.mat files.
- Fixed issue plotting speed when no GGA data are available.
- Fixed units on manual Altitude filter.
- Fixed issue reporting number of ensembles with no gga data are available.
- Fixed GUI issue in Moving Bed Test and User windows.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
2.83_32

2.83_64

4/27/2016

Allowed
prior to 2/27/2017


- Compatible with WinRiver II 2.17
- mmt files with invalid xml characters will now load without an error
- Firmware version, station name, and station number populated from new RiverSurveyor Live Matlab file to be released soon
- Several minor fixes to xml output, none affect SVMobile input
- Fixed 5% edge discharge check to support negative discharges
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
2.81_32

2.81_64

4/11/2016

Allowed
prior to 2/27/2017


- Not compatible with new default River Depth Source in WinRiver II 2.17 (changing the River Depth Source to BT will allow processing in QRev)
- Fixed display of message when less than 3 stationary tests are used for moving-bed correction.
- Fixed bug when processing data with multiple compass calibration/evaluations.
- User rating now stored in mat and xml files (Note: user rating not used by SVMobile).
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
2.80_32

2.80_64

3/28/2016

Allowed
prior to 2/27/2017


- Fixed xml output when using User Q for edges, user temperature, and user speed of sound.
- Fixed bug in units for temperature comparisons.
- Fixed bug when accidently double clicking a button.
- Fixed bug when cancelling the Manual Speed of Sound dialog.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
2.76_32

2.76_64

3/15/2016

Allowed
prior to 2/27/2017


- Initial Release.
- xml file won't save when using User Q for edges, user temperature, and user speed of sound.
- Units in temperature window not working properly.
- Double clicking a button causes window not stay open on subsequent clicks.
- Cancelling the Manual Speed of Sound dialog result in crash.
- Requires Matlab Runtime Libraries Version 9.0, either 32-bit version or 64-bit version depending on which version of QRev you download.
- Compiled with Matlab 2015b.
- USGS Site Administrators: 32-bit and 64-bit versions of QRev and the Matlab Runtime libraries 2015b (9.0) are available via SCCM.

Software/Firmware Status Definitions

Required Minimum: Minimum version required. This version has proven stable and may contain enhancements that are significant over previous required versions

Recommended: Shown to have been reliable and contains features that result in a recommended upgrade over the required version. There could be a few specific use cases where this version may have issues that would result in some users not using this version. If so, those cases will be noted.

Allowed*: Deemed reliable during initial testing. Any issues will be noted along with improvements available over prior versions. Use of allowed versions may be desired in cases when the changes benefit a significant number of the user's conditions or equipment. For example: a new version of software is released that adds support for new hardware. If the user has this hardware, they would need to upgrade to the newer software before it becomes recommended or required. Use of these versions by experienced users will also help OSW identify any unknown issues.

Testing*: OSW is currently testing; any known issues or advantages over prior release will be noted. The use of a version that is in testing should usually be limited to advanced users that can trouble shoot potential issues and provide feedback on any irregularities or problems observed.

Do Not Use: A version either prior to the required minimum or that contains issues that significantly affect operations.

*Note: A version may remain in Allowed or Testing indefinitely. Example: A new version is released while the prior version is still in Testing. In this case the prior version may remain in Testing, while future testing efforts are placed on the newer version.


Installation Instructions

  1. Download the latest version of QRev that matches your Windows operating system (32-bit or 64-bit). Note: the 32-bit version can run on Windows 64-bit.
  2. Select or create a folder for QRev and unzip the file into that folder.
  3. Download and install the Matlab Component Runtime libary version 9.0 that matches the version of QRev you downloaded (32-bit or 64-bit). For instuctions on how to determine if you have the needed library and/or to install the library see Matlab Component Runtime Library Download and Installation
  4. Run the program by double-clicking on QRev_*.exe in Windows Explorer or My Computer. You may wish to create a shortcut to in a convenient location in the Start Menu or on the Desktop.

Updates and Bugs

In order to provide support for QRev and to provide an efficient means to communicate with users and allow users an efficient and organized means of providing suggestions and comments, you are encouraged to register for the OSW Hydroacoustic Forum. In the forum you will find a "QRev" board under Hydroacoustics Moving-Boat Deployments. Open the QRev board and click "Notify" to automatically receive emails on any bug fixes or issues identified with QRev. This is the only way of being automatically notified if there has been an identified problem or if a new version has been released. You are also encouraged to report any problems you encounter with QRev and attach the associated files so that any identified problem can be resolved. To access the OSW Hydroacoustics Forums you must be a registered user of the forums.

Register for access to OSW Hydroacoustics Forums

OSW Hydroacoustics Forums for Registered Users


Integration with SV Mobile and NWIS

The results of data processed with QRev can be efficiently loaded into NWIS through the use of SV Mobile. Saving a processed measurement in QRev automatically creates an XML file (*_QRev.xml). This xml file can be loaded into SV Mobile version 1.0.10 or later. After completing the site visit information in SV Mobile, the saved SV Mobile file can be loaded into NWIS using the normal procedures. In addition, a new stylesheet has been developed to incorporate some of the features of QRev and updates to other fields to better serve information from newer ADCPs. This new stylesheet is automatically available when using the Field Sheet Viewer. An example is shown here.

Recommended Workflow

QRev is intended to be used for both field processing and office review. Thus, QRev should be installed on both field and office computers. The recommended workflow is:
  1. Collect data using the manufacturer's software (WinRiver II or RiverSurveyor Live)
  2. Immediately after data collection process the data with QRev. Matlab output files for RiverSurveyor Live data are required.
  3. Investigate all messages and warnings provided by QRev and make any necessary changes.
  4. Use the comments feature in QRev to explain or justify warnings and changes made.
  5. If necessary, use WinRiver II or RiverSurveyor Live to review data that are not reviewable in QRev.
  6. Finalize the processing and save the QRev files. Using the default date and time in the filenames by QRev: 1) provides unique file names, 2) helps track changes to processing settings, 3) identifies the most recently processed data, and 4) helps prevents accidental overwritting of previously processed data.
  7. Import the QRev XML file into SV Mobile.
  8. Backup all files to separate media from you field computer.
  9. Follow office policy for storage and uploading of data into NWIS.

Note: The *_QRev.mat file contains all the original data and final processing settings. The *_QRev.mat file is independent of the original manufacturer files. Thus data processed with QRev should only be reviewed by loading the *_QRev.mat file. WinRiver II and RiverSurveyor Live files should be considered the original field data and not used for review or reprocessing of data previously processed in QRev. In the rare situation where a display of data in WinRiver II or RiverSurveyor Live is not available in QRev, WinRiver II or RiverSurveyor Live could be used to review that portion of the data.


Viewing QRev Summary without SV Mobile

Saving a processed measurement in QRev automatically creates an XML file (*_QRev.xml). A user friendly summary of the data in the xml file can be achieved using an XSLT style sheet. An example style sheet is available and can be downloaded and modified to meet the user's specific needs. For USGS users this example QRev stylesheet is automatically available when using the Field Sheet Viewer to view a QRev xml file.