Help Documentation:

Guide to the Klamath-Trinity RBM10 Water Temperature Model

Graphical User Interface (GUI)

"Current version 1.7.6" Updated 3/5/2021

The Klamath-Trinity River Basin Model-10 (RBM10) GUI provides an intuitive interface for simulating daily-mean water temperature at user-specified locations along the Klamath and Trinity Rivers. This is a 2-reach version of the RBM10 model that combines the published Klamath River and Trinity River RBM10 models (Perry and others, 2011; Jones and others, 2016) into a single model framework. Historical meteorology and stream flow data are embedded model inputs. The domain spans temporally from 1/1/1980 to 12/31/2018, and spatially from Lewiston Dam to the Klamath River confluence on the Trinity River, and from Iron Gate Dam to the Pacific Ocean on the Klamath River. Model input and output operates on a daily time-step. Water temperature is, by default, simulated according to the historical discharge and water temperature record of Iron Gate Dam, Lewiston Dam, and tributaries. Users can also modify the historical flow and temperature inputs, and compare the effects on simulated mainstem water temperature using built-in graphical tools. Model output can be exported in comma separated (CSV) format.

*Note, buttons and interactive toggles are marked by (GREEN) text. Items with glossary definitions are marked by hyperlinks to the glossary at the end of this document. Quick definitions can be read by hovering your mouse cursor over the link.

Tab One: River Mile Selection

Region & Section Selection:

At the top-left of the viewer window is the River Mile Selection tab, which opens by default when the RBM10 GUI is launched. From this tab, the user requests the location(s) and the range of dates to be simulated. Within the two mainstem reaches there are a total of six rectangular map regions to choose from. Regions can be selected by a left-click of the mouse. When selected, the inner margin of the yellow rectangle is highlighted green. Clicking twice on a region brings up a more detailed popup map where locations can be chosen precisely.

Within the regional popup map the river is boxed into smaller sections, and three interactive buttons are presented at the bottom of the frame. The bottom-left button is a toggle that reads Use river mile mid points for each section or Manually enter a river mile for each section. The default is to "Use river mile mid points for each section," which automatically queues the mid-point river mile of each selected section. As with regions, selected river sections are highlighted green. Toggling to "Manually enter a river mile for each section" prompts a dialog box where the user can enter a specific river mile location within the selected section of river. To exit the popup dialog the user can press the Save Current Values button which applies any new selections (or de-selections) to the location queue for output, or the Cancel button which simply closes the popup window without making any changes to the location queue.

This dialog provides the name of the river section, and informs the user if and where (by mainstem river mile) any tributaries enter within the selected river section. Also displayed are the start, mid, and end river miles of the section. River miles represent the distance from the Klamath River confluence along the Trinity River, and the distance from the ocean on the Klamath River. This popup dialog automatically rounds the manually entered value to fall within the start and end point range, and prevents the entry of any matching values of the start, end, or tributary intersections; direct matches may cause the model to perform poorly. If you enter a Custom river mile then use the Use Custom River Mile button to save your value and close the dialog. The Use MidPoint of Section button will select the river mile location of the section's mid-point and close the popup dialog.

Any region that has been selected and has individual sections selected will be displayed with a yellow and green trimmed box within tab one. Regions that do not contain any selected sections are trimmed only in a yellow box. To quickly deselect an entire region click down on the wheel of your mouse while hovering over the intended region. In addition to being trimmed in green and yellow, regions and sections that are selected for the model will be displayed in the white text box to the right of the region selection map on tab one of the main application. This text window will display the current selected regions and sections along with the river mile that will be used in the model.

Within the region map there are two text controls that let you set the start and end date range you wish to model. Start Year allows you to set the first year the model will process. This is a four digit value. The model must start on January first of any given year to run correctly. That is why the user is locked to only a year value. End Date can be any date after the start year. Note that the default min and max are loaded at the startup of the application. 1980 is the first year that the model has historic data. 12/31/2014 is the last date that the model has historic data.

After you have chosen all the sections you wish to include in the model and have assigned a starting year and an ending date the model is ready to be ran on the historic data. At the bottom middle of the application there is a toggle that by default should read Historic (Can't Change) at start up. If this toggle box reads "not yet used" or any other value click on the toggle box and select the top entry "Historic (Can't Change)" This selection box will be discussed in more detail later but it's important to note that each time the river section data is changed you should run the model first on Historic (Can't Change), this will create a historic data set for comparison later. Now that your ready to run the model the Run Model (Fortran exe) button will be available. Click the button or press Ctrl-r for the shortcut to run the model. While the model is running the Run Model (Fortran exe) button will be grayed out and read Running "Please wait". When the model has successfully completed the button will read Current Sections Complete. This button will remain in this state and be locked to the user until section values have been changed.

Note: That when you have ran a model on specific sections and you change the sections all previous model runs are deleted. The application will not allow you to have date sets that have different section data at one time. Be aware that if you change the sections you need to rerun the model for the historic data set and any user profiles you had ran prior.

Tab Two: Flow or Temperature Over Time

This application has three tabs that share very similar controls for modifying graph properties. Because of this the help file will break the documentation into two parts: Shared Graphing Properties, and specific graph tab controls. We will start with the specific graph tab controls for tab two.

Specific Graph Tab Controls for Tab two: (Flow or Temperature over time)

After you have ran the model on a set of sections you are ready to review the results. Tab two is a graph of the temperature or flow over the entire time frame you selected. At the top right of the tab is a toggle box that when selected allows you to chose between Temperature or Flow. Each time you select one of the other values the graph will automatically update depending on the AutoScale settings discussed later.

Below the Temperature or Flow toggle there is a on off toggle list for each of the sections you chose to model. This toggle list allows you to turn on and off individual sections along with change the plot attributes of the graph such as color, line or point style, and many other options. Simply click on the display box to the right of one of the listed sections to bring up a myriad of options. These options will be discussed in Shared Graphing Properties along with the rest of the controls for Tab two.

Tab Three: 3D Plots

Specific Graph Tab Controls for Tab Three: (3D Plots)

The 3D plots tab is linked heavily to tab two. Graphing temperature or flow is set by the flow or temperature toggle button in tab two. The range of the X axis (time) is set by the X axis of the graph in tab two. If you are going back and forth between tab two and three it is always a good idea to click the Update Graph button on the middle right. This button will make sure that the current displayed graph represents the current data in tab two. Some changes such as running the X axis slide bar will not automatically update in the 3D plot. There are four viewing buttons at the bottom right of the graph. These buttons are quick toggles between the X,Y,Z and orbital axis views. The legend on the upper right is auto scaling based on the min and max of the current displayed data set.

There are some shortcut options within the 3D graph that allow the user to orbit, zoom, and move the graph. A simple mouse click and hold within the body of the graph will allow for free rotation based on how you move the mouse. Ctrl-Mouse will allow you to move the current graph around within the plot area. Shift-Mouse will allow you to scale the graph up or down.

There are three controls on the right of the graph that are not used. These controls are for possible future development of animating the 3D plot over time. There has not been enough interest in this option yet so no development has been completed. Depending on future interest these controls will be developed or removed.

Tab Four: Yearly Plots By Section

Specific Graph Tab Controls for Tab Four: (Yearly Plots By Section)

Tab four is a plot that standardizes all data into a single generic year (1904) This plot removes the year component from the date that way annual trends can be compared. Like tab two there is a toggle button on the upper right that allows the selection of Temperature or Flow. Depending on the AutoScale settings discussed in Shared graphing properties your graph should automatically update when you select a different value.

At the top right of the graph is an auto populating toggle box. This toggle box will auto populate with all of the individual sections you have chose to model. You can display one section at a time. The current displayed section is the current graphed section.

Like in tab two the toggle list with the check boxes allows you to turn on and off individual years. you can select individual plot styles by clicking on the small display box beside each year and setting the plot values.

There are also two buttons beside the toggle list that will turn on or off all the plot data. Turn all On will automatically turn on all years placing check marks in all boxes in the toggle list. Turn all Off will de-select all check boxes in the toggle list and turn off all plots.

Tab Five: User Modified Flow & Temp Results

Specific Graph Tab Controls for Tab Five (User Modified Flow & Temp Results):

Tab five is a special case graph that allows you to compare temperature and flow for multiple modeled scenarios at the same time. How to build User modified multiple model scenarios will be discussed in great detail later. For now we will focus on specific controls for each tab option.

Like in tab four at the top right of the graph is an auto populating toggle box that has all the current selected sections. Only one section can be displayed at a time, and the currently displayed section is the current plotted graph.

To the right of the graph is an auto populating toggle list that contains an on off check box and plot properties box for each of the plots. Two plots are created each time the model is ran for separate User modified scenarios discussed later. Each plot has either Tmp- or Flo- tags indicating if the plot is for temperature or flow. After the temperature or flow indicator is the name of the model run either Historic (Can't Change) or a value assigned by the user when the user modified model scenario was created. Note in the above image there are four items in the toggle list. The first two represent the temperature and flow data of the historic data. The third and forth represent the temperature and flow of a user modified profile called Sample +20% Irongate August. Note that the graph has both temperature displayed utilizing the right Y axis and flow over the top of flow utilizing the left Y axis.

This will be discussed later in shared graphing properties.

Shared Graphing Properties

Shared Graphing Properties:

Common controls among the graphs include: User changeable axis limits, the Cursor Movement, Zoom, and Panning tools, X axis slider (always time for this application), plot properties, and Cursors and the Cursor Legend.

The User changeable axis limits are a quick way to adjust the range of the X or Y axis. by simply clicking on the min or max of any axis you can type in a new value. For example in the image above we can see that the Y axis on the right (temperature) has a min of -10 and a max of 27. This forced the temperature plots above the flow plots so there was no visual overlap in the plotted data. Note that you can adjust more then just the min and max values of a plot and can set staggered axis ranges. This may prove confusing and it is best practice to only adjust the min and max values of a graph.

AutoScale Axis is an on off option that controls how the application will update the graphs each time data is changed and updated with each graph. By right clicking on any of the axis of the graphs you can bring up a drop down dialog that depending of if the graph is a multi axis or single axis graph will give you an AutoScale X and/or AutoScale Y option. If there is a check mark beside Either option any time the graph is updated the axis with the check marks will automatically scale the data to fit. Exactly the same as if you selected zoom all. This is the default behavior and can be beneficial when moving between flow and temperature plots. But it can also be distracting and time consuming if you are trying to focus on a certain data range and moving from one section to another. Only experience will help develop when it is appropriate or not to have the AutoScale Axis options on or off.

The three tools at the bottom left (Cursor Movement, Zoom, and Panning) are quick ways to adjust the plot view. Courser movement, the cross-hair looking icon will be discussed with Cursors & Cursor Legends. The Zoom tool consists of six options to control the visual scene of the graph area. Click on the magnifying glass icon to bring up the six options.

Zoom Tools:

Upper left—Is a regional zoom box. Select this option to draw a box around the area of the graph you wish to focus on.

Upper middle—Allows selection of an area within the graph that limits the X axis, the Y axis ratio will not be changed.

Upper Right—Allows the selection of an area with the graph that limits the Y axis, X asis ratio will not be changed.

Lower left—Zoom All. All data will be fit for the X and Y axis.

Lower middle—Zoom in, where ever your mouse is on the graph each time you click the focus will zoom in on that location.

Lower right—Zoom out, where ever your mouse is on the graph each time you click the focus will zoom out from that location.

Panning is the icon of the hand, simply select the icon and then place your mouse within the graph. click and hold the mouse and drag the image within the graph as needed to bring the aria of interest into focus.

X axis slider is a simple slider that allows you to move the displayed graph forward or backward along the X axis. The start and end of the slider always represent the min and max values of the current data sets time frame.

Plot properties are common plot attributes you can adjust for each individual plot within the graph. These attributes consist of:

Plot Properties:

Plot Visible—Same as check box, Turns plot on and off.

Common Plots—A selection of common plot styles.

Color—Common color legend to set the color of the plot.

Line Style—Dotted, dashed, or solid lines. Common line types

Line Width—Thickness of the line in the display

Anti-Aliased—You can improve the appearance of line plots in a graph or chart by using anti-aliased lines. When you enable anti-aliased line drawing, line plots appear smoother.

Bar Plots—Allows you to select a line graph or a number of bar chart formats

Fill Base Line— Will fill in the area of plot above or below the trend line based on selection.

Interpolation—Interpolation of plot: 0-None, 1-Stepwise, 2-Linear, 3-Stepwise horizontal, 4-Stepwise horizontally centered, 5-Stepwise vertically centered.

Point Style—Different symbols for data points for the plot.

X Scale—Allows the selection between different X axis. For this application there is only one X axis in units of time.

Y Scale—Allows the selection between different Y axis. Most graphs are set with only one Y axis value of either flow or temperature. Each axis is assigned programmatically for the multi axis graphs. There should never be a reason to change the axis assignments for a plot.

Export—Allows you to export the current plot data or image. Only the data points within the current view will be exported. There are more advanced export options built into the application using the Export All Data to Excel, and Export Current Graph as bit map. Discussed later in this help file.

Cursors, Cursor move tool, and the Cursor Legend are tools to create markers within the graph to specific events. Cursors can be used to mark and remember special events within the data.

Cursor Legend:

Right-click anywhere in the cursor legend, select Create Cursor, and select a cursor mode from the shortcut menu. The cursor position is defined by the cursor mode. The cursor includes the following modes:
Free—Moves the cursor freely within the plot area, regardless of plot positions.
Single-Plot—Positions the cursor only on the plot that is associated with the cursor. You can move the cursor along the associated plot. Right-click the cursor legend row and select Snap To from the shortcut menu to associate one or all plots with the cursor.
Multi-Plot—Positions the cursor only on a specific data point in the plot area. The multi-plot cursor reports values at the specified x-value for all of the plots with which the cursor is associated. You can position the cursor on any plot in the plot area. Right-click the cursor legend row and select Snap To from the shortcut menu to associate one or all plots with the cursor. This mode is only valid for mixed signal graphs.

Note You cannot change the mode of a cursor after you create it. You must delete the cursor and create another cursor.

Individual cursor properties can be set for the individual cursor. Left click on the cursor name to create a unique name for the cursor. Left click on the X value to manually enter an X value. Left click on the Y value to manually enter a Y value. Right click on any of the elements of an individual cursor to display individual properties of the cursor.

Visible Items—Allows you to turn on and off certain elements in the cursor legend such as the header information and the horizontal and vertical slide bars.

X Scale—Selects what X scale to assign the cursor to. This application only uses one X scale.

Y Scale—Selects what Y scale to assign the cursor to. Within Tab five this will be important to select either temperature or flow, based on what you with the cursor to represent.

Attributes—Set point and line color, point and line style, thickness, and other style attributes. In addition there is a toggle to turn on or off the individual cursor name within the plot.

Bring to Center—Will bring the current cursor values directly into the center of the current view.

Go to Cursor—Will focus the current view around the selected cursor.

Create Cursor—Creates a new cursor

Delete Cursor—Deletes the currently selected cursor

Cursor Movement Tool:

The Cursor Movement tool can be used to drag individual cursors around on the graph. Select the cross-hair looking icon at the bottom left of the graph, then hover the mouse over the cursors. As the mouse approaches one of the axis lines it will change to movement arrows expressing you can move the cursor. Click and hold the mouse to drag the cursor. To move the cursor in both X and Y planes at the same time you must first hover over the center of the cursor.

Note behavior of the cursor will change based on what mode you selected when the cursor was created. Single plot and multi plot cursors are bound to the data and will behave differently then a free cursor.

User Modified Multiple Model Scenarios

The primary objective of this application is to create an intuitive method to compare multiple scenarios based on the increase or decrease in temperatures and/or flows within a given period of time. This application allows for eleven individual user modified scenarios and the historic scenario. There are a couple ways to change or create user modified scenarios by either using the built in interface, or by creating and modifying a *.CSV (comma separated values file) and loading the modified template back to the model.

To create a new user modified scenario you first must tell the application where to store the data. The toggle box at the bottom middle of the application is were you choose one of the eleven scenarios. By default this box will read Historic (Can't Change) If you try to modify this scenario you will be prompted with an error message and no modifications will be made. Select one of the Not used yet scenarios.

Note It is best practice to select scenarios sequentially from top to bottom. Selecting random scenarios with unused scenarios between may become confusing and cumbersome in later actions.

When you select a scenario that has not been ran yet the graphs will update with no data. This is normal as you have not created anything yet. After you have created a more then one scenario use this toggle box to select the data set you want displayed on the graphs. You can toggle back and forth between any scenario at any time.

After you have selected the scenario you wish to create or modify, click the Edit Tributary Flow & Temperatures button. The Individual Data-Set Descriptions dialog will be opened.

Individual Data-Set Descriptions for Multiple Model Runs Dialog

The Individual Data-Set Descriptions dialog will give you basic information on how to name your scenario and what will happen next. It is best practice to try and keep your naming short, but be sure it is descriptive to the scenario you are creating.

From this dialog there are two ways to create a modified scenario. The first is to load a CSV file, the second is to use the application. First we will cover using the application. After you have properly named your scenario click the Make Changes button. This will launch the interactive Change Flow and temperature at tributaries application.

Change flow and temperature at tributaries (Three Tabs)

Tab one: Iron Gate & Lewiston Dams

Change flow and temperature at tributaries has three tabs; IronGate & Lewiston Dams, Tributaries, MedatData - UserNotes.

The first tab Iron Gate & Lewiston Dams allows you to change the flows and/or temperatures at either, or both dams using one of three methods of time selection. Some setting within this tab will set the conditions for the other two tabs.

Note Before making changes it is important to know what you're changing. When this application loads, it pulls in all values from the historic data set. Each time this application runs you will be working directly from the historic data. If you are modifying an existing scenario the modifications you made will not be carried into this data.

At the top of tab one is a time slider, this time slider automatically scales the start and end date based on the date range you selected when you made the region / section selections. Slide the slider around to see the relating temperatures and flows at each of the given dams for a given day. To the left of the slider is a text box that has the current time slider value. You can click the text box and enter any date value to auto focus the slider. The date value must be in range of your data or the slider will round the the nearest high or low value.

Just below the time slider there are two toggle boxes. These boxes set the methods for how the data will be modified within a given time frame and how to adjust the data either by a percentage or linearly. The toggle box on the left sets how the data will be adjusted over time. There are three options, each of these options will change the Start Date-Time and End Date-Time calendar controls on either side of the toggle box.

- Change all years within date range—Will limit the Start Date-Time and End Date-Time controls to only allow a month and day. All years within your scenario will be modified between the dates of Start Date-Time and End Date-Time. Values outside the date time range will not be modified.
- Limit to selected date range—Will only modify data between the Start Date-Time and End Date-Time. When this value is selected the start and end controls will change to include month day and year.
- Change all data—Will change all data from the first date on the slider to the last. when this value is selected the start and end date controls will disappear.

The toggle box on the right sets how to change the data either linearly or by a percentage.

- Change flow and temperature by % increase or decrease—Will change all the sliders to represent 100% to -100%. Adjust the individual sliders to increase or decrease the temperature or flow for either dam by the selected percentage. Both temperature and flow are limited to zero, no negative values are passed to the model.
- Change flow and temperature by linear increase or decrease—Will change the sliders to 1000 to -1000 for flow and 50 to -50 for temperature. Change the sliders to add or subtract the set value from the temperature or flow. Both temperature and flow are limited to zero, no negative values will be passed to the model.

Sliders and Dials:

Now that the date range and the method of change to the data are set, we can adjust the data. Each image of the dams has a slide bar to it's right. This slide bar adjusts flow. Above the slider is a text box that gives the current value of the slider, you can click the text box and enter a value directly into the box to quickly adjust the slider. Each image also has a color scaled dial, this dial adjusts the temperature. On the far right side of the application is a color legend for temperature. this color legend auto scales based on the highest and lowest temperatures in your data. When you adjust temperatures the legend will change to represent the new data range. Also within each image of the dams are two numeric text boxes that give the current temperature and flow at that given time on the slide bar. As you change the sliders these indicators will auto update to show the new values.

Save Current Values:

After you have set the sliders and controls to the desired values of change click the Save Current Values button at the bottom middle of the application. After clicking Save Current Values your current changes are stored, and the application is ready to make additional changes.

Revert to Historic Data:

If at any point data is saved that isn't the desired values of change, you can click the Revert to Historic Date button. This will restore the application to the default state. This will revert all the data back to the historic data set. All changes made prior will be removed and you must start over to rebuild the modified data set.

Tab Two: Tributaries

The tributaries tab allows you to adjust the temperature and/or flow of each tributary or globally adjust them all. The top two toggle boxes set the methods for how to adjust the tributaries. the left tributary control will auto populate based on your choices.

Note The tributaries tab is linked directly to the Iron Gate & Lewiston tab. The date selections that limit the date range to modify the data are applied here as well. Be sure that the date range and method are correctly set in tab one before you make and apply changes here.

The Top left toggle box has three choices. These three choices allow you to target a single reach or both.

Klamath Tributaries Only—Will only allow you to modify the Klamath tributaries.
Trinity Tributaries Only—Will only allow you to modify the Trinity tributaries.
Both Klamath and Trinity Tributaries —Will allow you to modify both the Klamath and the Trinity tributaries.

The Middle left toggle box has two choices. These choices allow you to change all the tributaries globally with one value, or allow you to set individual values of change to each tributary.

Scale Individual Tributaries—Will bring up a list of all the tributaries depending on what your selection was for the reach selection. If you selected Both Klamath & Trinity Tributaries then you will have a list of every tributary in the model that can be adjusted. If you selected only one of the reaches then your choices will be limited to only tributaries within that reach.
Scale all Tributaries Equal—Will bring up a single control on the left. Based on what reach selection choice this will globally modify all the tributaries with the same value of change.

The bottom left toggle box is the same as the one on tab one. This toggle selects how you will modify the data, either by a percentage or by a linear increase or decrease.

Change flow and temperature by % increase or decrease—Will change all the sliders to represent 100% to -100%. Adjust the individual sliders to increase or decrease the temperature or flow. Both temperature and flow are limited to zero, no negative values are passed to the model.
Change flow and temperature by linear increase or decrease—Will change the sliders to 1000 to -1000 for flow and 50 to -50 for temperature. Change the sliders to add or subtract the set value from the temperature or flow. Both temperature and flow are limited to zero, no negative values will be passed to the model.

After the three toggle boxes are set according to how you wish to change the data, the left array of controls will be populated accordingly. Find the appropriate tributary listed in the white text box. Under the text box is an orange and green slider. Slide the orange slider to adjust the flow for the given tributary. Slide the green slider to adjust the temperature for the given tributary.

Note There are text labels over each of the sliders that indicate flow CFS and Temp C°. These indicators can get in the way of selecting the slider. If the slider is under the text label and you attempt to grab it, you will not likely be able to. Select an area on the slider away from the text and while holding the mouse slide the slider under the text to the desired value.

After you have modified all the tributaries click the Save Current Values button at the bottom middle of the application. After you have saved the current values the application will store the results and be ready for the next set of modifications.

Save Changes & Close:

After you have completed all the modifications to the dams and tributaries, click the Safe Changes & Close button at the bottom right. This will close the Change Flow and Temperature at tributaries application, create the appropriate support files for the model and automatically run the modeler on your new scenario. On the main application the Run Model (Fortran exe) button will change to Running "Please wait". When the model has finished running on the new scenario the graphs will be auto populated.

Cancel:

If you do not wish to make changes or want to abandon the changes you have made click the cancel button at any time to close the Change Flow and temperature at tributaries application without making modifications. The modeler will not be ran. The name you gave to the scenario will remain though.

Creating Scenarios with CSV template Files

The second way to create User Modified Multiple Model scenarios is through the use of *.CSV files. Using CSV files a user can create a spread sheet of values by time for any of the dams or tributaries and load that file back into the modeler. There are a number of rules that need to be followed to be sure that the CSV is loaded properly back into the modeler.

Note: One of the most important things to understand is that a *.CSV file is a Comma Separated Values file. A CSV file is a way of expressing a spreadsheet as a simple text based document. When applications like excel or this one read a CSV file they look for two things. End of line carriage returns and a delimiter, in this case a Comma. The carriage returns are used to identify where a new row starts, therefor each line in the csv text file is a separate row in the spreadsheet. The comma signifies the break between columns. Therefor any data between commas on a single line become a single cell value in a spreadsheet. If a user includes extra commas in their header descriptions, or anywere within the data after the file is saved and reread the column order of the data will no longer be in proper order.

This application relies heavily on the naming of the header information. If a user adds commas into the headers the inputs will not be read correctly and the application will fail with a warning. Or worse the application will read the data and create results but the results will be blatantly wrong. DO NOT USE COMMAS IN THE CSV TEMPLATES......

The easiest way to begin creating templates is to use the application to create a starting point. From the File drop down menu select Covert ADV to CSV Format. An ADV file is a specially formatted text file that the modeler uses to understand the tributary flow and temperature data for given dates. It is a difficult format to work with so it is much simpler to allow the application to convert the file in and out of CSV format. The application will reference ADV files as that is the working format for the modeler but all user interaction for these files will be in CSV format. After you select Covert ADV to CSV format a dialog with two options will be displayed.

The two options are to convert the Current ADV file to CSV or Browse for an ADV file. Unless you have been working with the modeling code directly in Fortran then it is unlikely you will be working directly form ADV files. Select Current ADV file to CSV to prompt another dialog box.

The two options are to Use Historic ADV or to Use Currently Loaded ADV. The best practice is to create your template from the historic data by selecting Use Historic ADV. If you have already created a user modified scenario you can create a template using the Currently Loaded ADV.

Note: That the currently loaded ADV is whatever was last ran through the modeler. If you have created multiple user scenarios toggling between them doesn't change the last used ADV. Each time the modeler is ran past ADV files are overwritten.

After you make a selection a file dialog box will pop up. Name the template file appropriately in a good working location then click Save CSV file. This will create a large CSV file that contains information for the two dams and each tributary.

Open this CSV file in Excel or any other spreadsheet editing too. The first column will be Date followed by a two columns for each tributary expressing temperature and flow. From this template you can modify the values of any given tributary's flow or temperature value for any given date.

Understanding the Import process and what's expected:

Before you can load save and load the CSV back into the Trinity / Klamath River Model application you first must be sure you have formatted the data and headers correctly.

The data should only be numeric. The application will force the precision of the numbers to 2 decimal places if your data is more refined then that the precision will be lost. If it is not that precise the data will be padded with zeros.

This application relies on the header information to understand what data goes were. There must be a header with the title Date, and the data within that column must be in MM/DD/YYYY format. Failure to have the title Date or failure to have the correct format will cause the application to return and error and not load the template.

Headers for the tributaries must have at least the first four characters of the tributary. For example Lewiston must have "lewi", Rush Creek must have "rush" and so on. It is best practice to leave the entire tributary name. The header must also have one of the key words describing the condition Flow "flow" or temperature "temp" to know what the appropriate data is. In addition the data can contain measurement units such as CFS - KCFS, or C° - F°. If these values are not present the applications assumes the default units of CFS and C°. If KCFS or F° are found the the application performs the necessary conversion into the default units.

Header information can contain any additional information, is not capital sensitive, and the order of the columns doesn't matter. As long as a header contains tributary name and condition the application will know what to do.

Your templates do not need to have all columns or rows for all the data. It is mandatory to have the Date column, any combination of tributary columns can be included. You do not need to have both unit of flow and temperature for a tributary.

It is not necessary to have all date values either. Data that is not included in your template is filled from the the historic data set.

You should not have empty cells in your template. Empty cells may cause problems within the modeler. It is not best practice to allow empty data values.

After you have completed your changes to the template save the new version with an appropriate name as a CSV file.

Importing a CSV template to create a scenario:

After you have created a template CSV and are ready to import it to create a new scenario on the main application click the Edit Tributary Flow and Temperatures button. This will launch the Individual Data-Set Descriptions for Multiple Model Runs Dialog. Properly name your scenario and click the Load from a CSV File button. This will bring up a file dialog box. Navigate to the appropriate CSV file and double click the file or select Load Adv. If the CSV is formatted correctly then the

Run Model (Fortran exe) change to Running "Please wait" as the modeler runs your scenario.

Exporting Graphs and Data

There are a couple ways to export results from the application. By right clicking on certain items within a graph you can choose to export certain elements. The best way to export graphs and data are to use the two export buttons on the bottom right of the application.

Export Current Graph as Bit Map:

When you are on one of the four graph tabs when you click the Export Current Graph as Bit Map button the current graph being displayed will be exported as a bit map as it appears on your screen. A File dialog will launch. Select an appropriate location and give the file a proper name, then click save or Ok.

Export All Data to Excel:

After you have created scenarios you wish to save the data for, you can use the Export All Data to Excel button. This button will first launch a file dialog box. Pick an appropriate location and name to save the file and click Save or OK. A dialog box for Excel will be launched that will allow you to set the font and size of the incoming data. Select values that are appropriate for you. This dialog may not be on top find the dialog to complete the export. After you have selected options from the dialog Excel will automatically launch and begin populating with the data from the application. Each scenario will create a separate worksheet. After the completion of the export another dialog will be launched that asks if you wish to leave the created excel file open or close it. Select one of the values and the export process is complete.

Additional Information:

if more info to add like links to report or other papers, contact info related web sites. Maybe discuss bugs and future development.

Known Bugs & Issues:

In version 1.2 beta it was discovered that in Region 2 the section marker for "Clear" the section marker between Elk and Salmon was omitted. Without this section it caused an error in the indexing of the sections for the 4 sections down stream to the Trinity Confluence. When selecting one of these sections the application returned the previous section. For example if you selected Red Cap to Bluff the application would return Orleans to Red Cap. This issue has been addressed and the proper sections are now defined in version 1.3 beta.

Version 1.4.1: This version fixed a missing region within the map in version 1.2. It also fixed an indexing issue when calling support files that could have created inaccurate data. This version also improved error handling and some minor graphical fixes. In addition this version was given a new status window that gives the user more detailed information on what process the GUI is doing and how long it will / has taken. This version also has updated configurations and supporting data that improves the accuracy of the RBM10 model.

Version 1.5.1: This version fixed an issue with version 1.4.1 that didn't maintain the correct historic files for reference after called the first time. It also fixed a bug within the yearly comparison graph that didn't take leap years into account properly. This version also elaborated on the naming of the sections for better detail and changed the naming of certain controls and indicators to better represent there meaning and function. In addition the user interactive dialog to select river mile locations was updated to better fit the model limits of not being able to select values within certain distance from tributaries. It was also expanded to tell the user the nearest upstream and downstream tributaries, regardless if the selected section has a tributary or not. There are know known bugs in this version at this time.

Version 1.5.2 - 1.5.4: These versions were part of the beta test group and were small fixes and updates specific to user requests.

Version 1.5.5: This version fixed a series of issues that included a bug that didn't recognize certain leap years as leap years. This offset the data for leap years. In versions 1.5.3 a bug was introduced that didn’t properly break down the data for yearly plots. This has been fixed for version 1.5.5. Also in a previous version a bug was introduced through the *.ADV file that the application references, this bug created inconsistencies in the data.. The *.ADV file was updated to the best working copy for version 1.5.5. This version also includes better error handling and better response to common user actions. Also added in version 1.5.3 and maintained for 1.5.5 is a new export option that allows the user to export individual *.CSV files. This was added for users who didn’t have Excel installed on their machine. In addition there is a new dialog window in the upper right corner that gives more detailed events of what the application is doing, so the user is better informed.

Version 1.5.6: This version fixed a bug introduced in version 1.5.5 that broke the logic for the change tributary portion of the "Change flow and temperature of the tributaries" dialog. This bug did not allow the proper indexing of the tributaries and would not return the correct tributary information to the user. This bug created undesirable data. This version also changed some expectations of the application to loosen the obligation of a user to run the historic data set before running modified scenarios. It also fixed a visual bug that allowed users to set any date range within the sections tab. Now the values are automatically adjusted to the min or max allowed date within the scope of the model. Before this was done outside of the users interaction with the application.

Version 1.5.7: This version fixed a bug introduced in version 1.5.6 or 1.5.5 that changed the accuracy of the Date data field within the application, as a result the precision of the Date field was to great to match to the accuracy of the import of custom CSV scenarios. The result was that the application couldn't form proper matches based on the Date of year when a user loaded a CSV scenario. The application would return data that was the exact match to the Historic data set, but no error messages would be flagged. Version 1.5.7 fixed the accuracy issue and also included a warning to the user when no data changes where made from the historic data set when updating with a custom CSV scenario.

Version 1.6.1: This version added supporting information to expand the model through December 31 of 2017.

Version 1.6.2: This version fixes the installer to include all support files with the proper permissions. Version 1.6.1 did not include all the needed support files and could not run the model.

Version 1.6.3: This version fixes three bugs that limited the amount of data that could be utilized. Past versions were limited to about the middle of 2015 because of hard coded safety dates that made sure a user couldn't outrun the supporting information, and pre-allocated arrays that were to small to account for the increased data set sizes. An addition bug was found and fixed that when a user selected exactly 10 sections, then the indexing would fail and only a single section would be returned.

Version 1.6.4: This version added supporting information to expand the model through December 31 of 2018.

Version 1.7.1: This version added two options in the menu pull down menu. An option to create a Model Update File (*.MUF) from the current support files being utilized by the GUI application. This is not that useful for a normal users, but may come in useful for debugging. The more important addition is the ability to update the supporting model definition files from a Model Update File (*.MUF) This option will allow for future expansion of the models operational data range, without the need to update the entire application. This should allow for future updates to the model to be installed and utilized without the support of IT staff, or elevated user credentials that are often needed to update the application it's self.

Version 1.7.2: This version fixed three problems with version 1.7.1. The first was that the ADV file did not contain the right file reference to the support files in the historic version. This would make it so the model could not run after updated from the historic version. The second was that the support file were not given the right permissions when version 1.7.1 was compiled. This would not let the model run either. The third was identified that for unknown reasons the line feed / carriage return within the ADV files were somehow changed in updates to the model and the existing code did not properly recognize the end of lines so did not parse the file correctly. This prevented the user from being able to make temperature and flow adjustments in the gui. This has been updated so files are correctly parsed. It is unknown what version this error manifested.

Version 1.7.3: This version fixed another carriage return error problem found in one of the drop down file menus. In addition some modifications were made to help user performance and reliability, along with make the GUI more forgiving in terms of order of operations when performing certain tasks. Released 6/1/2020

Version 1.7.4: {Special note: This version switched from a 32-bit supported operating system to a 64-bit supported OS, This version is no longer 32-bit compatible. Even if you have installed past versions you must install the FULL version again to get the right run time engine} BE SURE TO INSTALL THE FULL VERSION IF YOU HAVE NOT INSTALLED THE FULL VERSION ON OR AFTER THIS UPDATE} Changing to a 64-bit supported version will have some performance increases to the speed and reliability of the GUI.

This version fixed an issue that caused duplicate date entries every year some time in March do to rounding inaccuracies when converting from decimal day of year to a date/time stamp. Prior versions would return two matching values for a date in March and miss the sequential day. The duplicate date should have had the missing sequential date assigned. Because of how the supporting data is created and run through the model this duplicated date could cause inaccuracies on the duplicated date and the missing data.

This version also increased the accuracy of the calculated temperatures when entering in manual river miles.

This version also now uses the supporting ADV file to set the data range for the GUI. The GUI uses a pre-defined array to keep track of all information and this array is allocated when the GUI is first started. After this array is allocated then it can't be changed unless the GUI is shut down and restarted. Note that just adding additional data will not extend the range of the model. The supporting environmental files must also be updated to reflect the additional data. If the ADV file is expanded, but not the environmental files (*.HOT files) then the model will automatically truncate the results to the date range of the HOT files. Released 10/20/2020

Version 1.7.5: Oct. 28th 2020 This version fixed a bug, or 3rd party application formatting issue that resulted from unknown reasons when trying to load a CSV file. The loaded file had to many carriage returns / line feeds and caused the model to fail.

In addition some behavior was changed that prevents the user from trying to run the model if no river sections have been selected yet. This version also opened up the ability for the user to run the model at any time. These changes should allow a more open and intuitive use of the GUI.

Current version 1.7.6: March 4th 2021 This version fixed a small bug that didn't update the indicator of the max allowed date within the first tab of the application. This did not affect the gui performance, or limit the data range, it only defaulted the indicator to the default value instead of correctly showing the working max date within the current version of the gui.

Updates:

Click Here - GUI Full Installer To get the current versions full installer, Note that the download is password protected. The password will not typically change. If you do not know the password, or if the password has been changed you will need to contact the developer team at the Columbia River Research Laboratory.

Click Here - GUI Update Only (Special note: version 1.7.4 and later have gone to 64-bit OS support, you must run the full installer to get updated runtime engine if you have not installed a full version older then 1.7.4.) You must have installed a previous version with the full installer for this update to work. This "update only" packet will be much smaller and faster to download then the full installer. You can use the full installer to update as well. If any problems with the "update only" version, then use the full installer instead.

Click Here - Model Update File (*.MUF Current update created 12/6/2020, this update extends the model out through 12/31/2018. The Model update file, or *.MUF is a file used to update the supporting data for the model. This is not an application update, it only updates the supporting *.ADV, *.INP, and *.HOT files used by the model. Use this file to expand the data range of time the model can handle, or apply updates to the historic data set. To use this file download it to your local machine where the GUI is installed. Then from within the GUI drop down file menu find update from *.MUF file. Navigate to the downloaded file and select. It should only take a couple seconds for the update to finish. After the update is done restart the GUI to be sure that the update was able to complete without errors ant that the data range of the model has been updated.

Glossary:

Reach:

Historic Data:

Historic (Can't Change);

Region:

Section:

Scenario:

Graph:

Plot:

Page updated

Google Sites

Report abuse