Variants in ResSim v3.5

ResSim Variants, identified as .fits files, are different versions of the input time series information (time series, lookback data, and observed data) used by an alternative. When a model using ResSim v3.5 was imported into another application, such as CWMS, a new .fits file was created for the time series tab with a different name. This allowed the user to still access the time series that were set up for the different applications and any adjustments to the model linking at time of compute were saved to a variant .fits file. The ResSim CWMS variant format was AlternativeApplication-program_order.fits. 

Variants in ResSim v4.0

Since the the model linking editor was revised to now store the model linking information, the variant .fits file only serves as a placeholder that helps during the time of compute. In newer versions of CWMS/RTS and WAT, the pathnames and linkages are being stored in a .linkages file. For RTS, this file is within the modelLinking folder within the cavi folder. The .fits file are written to at the time of compute. When a new compute is done for the same alternative, the .fits file will be overwritten. The description in the .fits file should include information on which variant was last run. For the new design, there should be one .fits file per alternative and per application. 

This guide will walk you through 

Step 1: Opening a model in RTS v3.6 

  1. Launch HEC-RTS and open your watershed.
  2. Navigate to the Modeling tab.
  3. On the Menu bar, go to Forecast - Open.
  4. Select a forecast that has HEC-ResSim

Step 2: Reviewing Available Variants

If a model has variants, the Variants menu drop down will only appear when the user selects the Time-Series or Global Variables tab.

  1. Select your ResSim model, right-click and select Edit Alternatives
  2. Upon initially opening, the only Menu drop down that will appear is Alternative if the tab selected is not Time-Series or Global Variables.

  3. Select the Time-Series tab and a Variants menu will appear. (This will also appear if your model has Global Variables and you select the Global Variables tab).
  4. The Variants drop-down menu will include all variants known by ResSim for the current alternative in the current context. The user can choose to add or remove individual or multiple variants. Selected variants to view will have a check box next to the variant name. The user can turn on and off the variants from the submenu. The user will not be able to turn off the ResSim default from the list, so this should never appear in this list. 
  5. Add the additional Variant by selecting it from the drop down. The variants will appear as a subtab under the Time Series tab.
  6. Since the .fits file is a place holder, the data displayed for variants within the alternative editor should read only (uneditable) and thus the row should be greyed out.  If the user would like to make any changes to the variants, they will need to do so through the model linking editor in the appropriate application. With the new naming convention, the .fits model will be updated at the time of compute for the selected variant. Because of this, the .fits file will always contain the data of the last variant that was passed to it. With the new naming convention, the variant information may not be clear enough. In order for the user to know which variant is being displayed, they can hover on the variant tab and the simulation or forecast run name will show in a pop-up. In addition to the pop-up, the variant information should be saved as part of the description in the .fits file.

  7. The ResSim-Default standalone tab is editable; however, the Variants will not be editable in the Alternative Editor. Variant time series information must be updated in the Model Linking Editor.

Step 3: Deleting Variants

  1. In the Alternative Editor, select the Alternative menu and then Delete Variant... from the drop down. This option is available from any tab in the Alternative Editor.
  2. The Delete Variants menu will appear. Users can select one or multiple variants.
  3. Once you select the variants you wish to delete and press delete, a warning message will appear asking you to confirm.
     
  4. If you delete the RTS variant, it will delete all files associated with that variant (.fits, .igv, etc). If the user deletes the RTS variant, a new one will be created when a compute is run or when the user explicitly tells the MLE to save the linkages back to ResSim.