Untitled Document

Rapid Index Velocity Rating and Synchronization (RIVRS)


The RIVRS Field Application was developed by Travis Knight (Caribbean-Florida WSC) and Marian Domanski (Central Midwest WSC), with funding and guidance from the Observing Systems Division (OSD), Hydrologic Networks Branch. The application was developed to improve the workflow and efficiency of synchronizing water velocity, gage height, and streamflow measurement data collected at index velocity stations to allow for rating verification from the field.

The application has the following features:

  1. Aids in the grouping of transects from discharge measurements at index velocity streamgages;
  2. Interfaces with QRev software to process groupings of discharge measurements;
  3. Synchronizes gage height and velocity data from a variety of dataloggers and instruments with discharge measurements;
  4. Compares measured and rated discharge;
  5. Provides immediate feedback on whether rating shifts are indicated or check measurements should be completed based on SW Technical Memorandum 2017.03; and
  6. Interfaces with SVMAQ to document field notes during site visits.

WMA Technical Note 75: Announces the release of RIVRS.

RIVRS can be used on desktops, laptops, and tablets running 64-bit versions of the Windows operating system. RIVRS is written in Python and packaged with the current version of QRev using the Pyinstaller library. The .xml file output from RIVRS can be read by SVMAQ version 2.3.165 or later.



Installation Instructions

Bug Reporting


USGS Software Users Rights Notice

The RIVRS application and the accompanying folder structure can be downloaded as a .zip file from the RIVRS repository. To navigate to the RIVRS repository click on the version number in the table below.

Changes and Known Issues
May 2024
Testing Added:
- Add Ctrl+D shortcut to enable DarkTheme (Need to address changing font and plot color).
- RVD: Added additional filter options beyond Water Year.
- RVD: Added table pages for model tab.
- RVD: Added model type filter on model tab.
- RVD: Added horizontal splitter bars for resizing plots.
- RVD: Optimized rating analysis to reduce computation time by 77%.
- FieldTool: Added horizontal splitter bars for resizing plots.
- RVD: Added alternating row colors to tables.
- RVD: Change table selection to select entire row instead of just the clicked cell.
- RVD: Changed table scrolling from per item to per pixel.
- RVD: Updated rating development UI button locations and control locations.
- FieldTool: Added save options to allow user to limit what files are exported on save.
- Packaged with QRev 4.38
- FieldTool: Fix reading of Start/End times from FlowTracker2 files where the measurement times are inconsistent in the manufacture output.
- FieldTool: Fix save when station number is set to None.
- FieldTool: Fixed odd behavior when specifying minutes for AQTS file export.
- RVD: Fixed crash during rating analysis due to nan values in Vm dataset.
February 2024
Recommended Added:
- Added shading to PI plots.
- Added "Splitters" to allow user to adjust the size of plots and tables on the Summary, Multicell, RatingPlots, Shift Dev., and Rating info tabs.
- Added rating summary PDF export of selected rating on the Rating Info tab.
- RVD: Adjusted plot size to prevent legends from getting cut off on some displays.
- RVD: Increased legend font size.
- Packaged with QRev 4.37
- RVD: Fixed crash when plotting some MLR ratings.
- RVD: Fixed disappearing bottom PI for SLR plots when obs are hidden.
- RVD: Fixed empty shift plot caused by Rating Measurements missing Measurement numbers due to loading from legacy ExportRating output.
- FieldTool: Fix compute in QRev button signal for SonTek ADCP data.
- FieldTool: Fix crash when clicking green check to select/unselect transects.
- FieldTool: Fix zipping of sub files when no ratings exist.
- DeploymentPlanner: Fixed crash when calling QRev contour plot.
December 2023
Allowed - Packaged with QRev 4.36.
- RVD: Added ability to toggle unshifted and shifted values on/off in plots..
- RVD: Added signal to doubleclick rows in table to identify points in plots on Rating Plots tab..
- FieldTool: Fix plotting of metric units in multicell data in field tool..
- FieldTool: Change FlowTracker2 reader to read raw .ft file instead of .csv files..
- FieldTool: Changed output to create a zip for the rivrs and rivrs2 files..
- FieldTool: Added input/output of current field visits and ratings to rivrs archive..
- FieldTool: Added PDF report output..
September 2023
Allowed - Fix loading of rating.xml files where some nodes are missing or blank.
- Fix loading of rating.xml files into RVD when AreaRating number is not specified..
- Added positive UTC offsets for loading data into field tool.
- Added corrected acoustic depth to AQTS file..
- Fix rating xml export from RIVRS for 3 segment ratings where "No Third Segment" would be input for the max Vi fo the second segment..
July 2023
Allowed - Fix signals in transect grouping window of field tool
- Updated user display settings
- Added unit system choices for RVD and Fieldtool
- During new rating creation change rounding of rating number to 1 decimal place.
- Added area rating tab to RVD with ability to overlay ratings, export rating csv, and remove ratings from database.
June 2023
Allowed - Fix display of cells used in summary table when selecting new cells to use as index.
- Fix duplication of models in RVD development UI.
- Fix display of PIs in RVD where they sometimes do not plot on the correct point.
- Fix crash loading SVMAQ files due to y velocity.
May 2023
Allowed - Fix display of PIs in RVD where they sometimes do not plot on the correct point.
- Fix duplication of models in RVD development UI.
- Fix display of cells used in summary table when selecting new cells to use as index.
April 2023
Allowed - Updated ChannelMaster reader to read unit system from file header
- Updated SonTek mat reader to handle files exported from SL/IQ Utilities V3.1 and greater.
- Correct Vy vs Vm plot signal.
- Fix table update behavior where updates are sometimes needed twice to refresh the table display.
- Updated selection of chosen model when reloading ratdev file.
- Replaced plot filter buttons with a signal WY Filter button in the toolbar.
- Added discharge transect plot to transect grouping dialog in fieldtool.
- Added check for duplicate rating numbers when importing area and IV ratings.
- Added check for duplicate rating numbers in Rating Development UI.
- Added sort and filter for measurements used in Rating Development UI.
- Packaged with QRev 4.34 and AreaComp3 1.3.2
April 2023
Allowed - Added custom ADVM to deployment planner.
- Added pdf export for deployment planner.
- Added clear option for deployment planner.
- Added option to normalize contour plot in deployment planner.
- Updated beam angles deployment planner.
- Fix flipping of ADCP data for screen display.
- Added option for Surface Velocity Index Regressions.
- Fixed signals for deleting comments in RVD.
- Fixed crash on Shift Dev. tab when no measurements are left to plot.
- Added update to water year column when dates are changed.
- Added residuals by stage plot.
- Changed check box for hide rating QMs to hide only QMs and not the rating and PIs.
- Fixed crash in Rating Development UI if checkboxes are clicked before selecting cells to group.
- Fixed plot controls in Rating Development UI.
- Fix odd plot creation behavior on Group Plots tab of rating dev UI.
- Formatted strings for Cell groups in Summary options table.
- Highlighted cells in Cell Groups in summary options table that is set to None.
- Added option to change measurements used in Rating development UI.
- Added method to update VShift diagram without changing Zoom.
- Added open file name to window title for RVD UI.
- Packaged with QRev 4.34 and AreaComp3 1.3.1
January 2023
Allowed - Updated area rating CSV reader to skip all comment lines and ignore blank lines.
- Fix failure to load XML files missing a measurement scenerio.
- Fix crash when changing times multiple times in a row.
- Fix crash for MLR rating stat export.
- Linked Summary sorting to Multicell tables.
- Fix crash when loading in WinRiver data with unchecked QMs and then unchecking more transects in RIVRS.
- Fix rating extension loss when activating new rating.
- Fix mixing of MC data causing non-contiguous cell groupings.
- Added Vy/Vm and Vx/Vy options plot method to Multicell plot.
- Fix doubling of time shift on import.
- Fix crash when importing SVMAQ files with a TZ of UTC.
- Added option to modify date/time of measurements in summary.
- Fixed updating of Shift Dev. and Rating Info tab TZ display settings.
- Added ability to sort summary tables.
- Packaged with QRev 4.34 and AreaComp3 1.2.1
November 2022
Allowed - Fix errors when connecting segments from 3 segment ratings.
- Fixed reading of rating.xml files from RIVRS where number of obs is printed with 1 decimal place.
November 2022
Allowed - Packaged with AreaComp3 Version 1.2.0 - Packaged with QRev Version 4.33 - Add ADVM deployment planner for testing.
- Added ability to modify the Discharge in the QSummary table in Office Tool.
- Added ability to remove a loaded rating from the RIVRS database.
- Change table scrolling from per row to per pixel.
- Added tooltips to show original values loaded into RIVRS database in QSummary table.
- Added Vy/Vz vs Vm plot.
- Fixed Shift tab updating signals.
- Added header with SI/AI metadata to AQTS file export.
August 2022
Allowed -Fixed application of shifted velocity.
-Fixed updating of Shift Table.
August 2022
Allowed -Adds a dashboard for navigation between applications.
-Packaged with QRev V4.32.
-Packaged with AreaComp3 V1.1.0.
-Adds the RIVRS Office Tool for rating validation and development.
-Fixes reading of CLR rating files with three rating points.
-Fixes writing of measured discharge to XML files with no rating is available.
June 2022
Allowed -Packaged with QRev 4.31.
June 2022
Allowed -Packaged with QRev 4.30.
-Added IV and SA rating numbers to XML.
-Added SA rating number to rating verification tab..
-Added splash screen.
-Fixed continousdata crash for FTS files with duplicate header names.
-Fixed v shift diagram failing to render.
-Added current QMs to Vshift diagram.
December 2021
Allowed -Packaged with QRev 4.29.
December 2021
Allowed -Packaged with QRev 4.28.
November 2021
Allowed -Packaged with QRev 4.27.
-Fixed crash when loading some datalogger files containing where velocity data.
-Added support for FTS data loggers
-Fixed odd extrapolation of shifts past the upper input point on plots.
-Changed timeseries output from two separate csv files for Stage and velocity to a single csv file in Satlink Standard format.
-Added aggregation of Stage and velocity data to a user specified sampling averaging interval.
-Increased dialog font sizes to 12pt.
May 2021
Allowed -Fixes crash caused by some Sontek multicell csv files.
May 2021
Allowed -Packaged with QRev 4.26
-Now uses Multicell CSV file for Sontek 3G ADVMs to address transformation matrix accuracy issues in mat files.
-Added clear button.
-Fix loading of saved RIVRS files with AQ loaded files.
-Added manual entry of QMs.
-Changed manual stage entry to its own dialog and option to specify primary time series, acoustic depth, or manually enter stage.
-Link Final table to QM rating dialog and stage dialog.
-Added acoustic depth to stage plot.
-Added depth offset to stage plot options.
-Increased font size throughout UI.
-Fixed shrinking plot sizes
Feb 2021
Allowed -Packaged with QRev 4.23
-Fixes partial loading of previously saved RIVRS files
-Fixes delayed update of stage and velocity thresholds
Feb 2021
Allowed -Packaged with QRev 4.23
-Fixes SL3 ranged average import
-Added code to view each cell of the multicell data on the multicell plot
-Fixed xlsx summary file export for loading to IV_Rating
-Added code to export plots when saving
-Added support for Flowtracker1 and 2 import
-Added support for RDI and Sontek ADCP midsection import
-Changed code to allow non continuous cells to be chosen for index
-Added code to link time series plots to transect grouping and measurement tables
-Fixed crash caused by FV file containing empty field visits
-Allows import of mat files from IQ version 3.0
-Adds ability to specify location of RIVRS working directory
Sept. 2020
Allowed -Initial python release.
-Packaged with QRev 4.16

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. Click on the appropriate link in the "Download" table above to download a .zip file containing the latest version of RIVRS. The zip file contains 7 folders (subdirectories), Export_Rating_1.1, and an executable (Update_RIVRS.exe) used to pull the current rating information from Aquarius.
  2. Select or create a folder anywhere on your computer and unzip the downloaded file into that folder.
  3. Do not change the structure or naming of any files or subdirectories.
  4. Read the User's Manual before using the tools for instructions on initial setup.
  5. The RIVRS application can be run by double clicking the RIVRS.exe file located in the app directory.

Bug Reporting

Please submit any questions or support requests to the developers of the RIVRS Field Application by reporting a "New Issue" here.