User interface reference

Introduction

This chapter describes the function of commands in each menu, sub-menu and toolbar and is a good reference point when you become familiar with Source. In addition to presenting a Source view of each command, it provides a brief description of what that command does.

Menus

The menu bar for Source is shown in Figure 1. The remainder of this section describes the function of the commands in each menu.

Figure 1. Menu bar

Figure 2. File menu

Creates a new, empty project. Opens the New Project dialog where you can name your project, provide a brief description of its purpose and choose the type of scenario you wish to create.

Attaches a new, empty scenario to the current project. Opens the Create a Scenario Creation dialog which offers a choice of a Geographic wizard or River Manager schematic scenarios. Select the type which is appropriate to your needs. Name your scenario and provide a brief description of its purpose and click OK. This command is a synonym for New Scenario (by menu) on the Project Explorer toolbar.

Opens an existing project using the standard Windows™ open dialog. Synonym for Open Project on the File toolbar. Source projects use the ".rsproj" or ".rsproj.xml" extensions but can also open legacy project types ".e2proj" and ".mdb".

Closes the current project. Prompts to save your work. Click Yes to save your work, No to discard any changes, or Cancel to return to Source.

Saves the current project, overwriting the existing file. Synonym for Save Project on the File toolbar. Implies File » Save As... if the project has never been saved.

Opens a standard Windows™ save dialog which allows you both to enter a name for your project and determine where the file will be saved. Source projects use the ".rsproj" or ".rsproj.xml" extensions.

This command is currently disabled. However, the Print (Schematic Editor grid toolbar) button on the Schematic Editor grid toolbar may be used to print scenario schematics.

This command is currently disabled. However, the Print (Schematic Editor grid toolbar) button on the Schematic Editor grid toolbar may be used to print scenario schematics. Clicking that button also provides a preview.

This area contains a list of recently-saved projects. You can re-open any project by choosing its name from the list in this area. Note that this assumes that the associated project file has not been moved from the location where it was saved, or renamed, or deleted from your hard disk.

Quit Source. You are asked to confirm your intention and reminded to save any unsaved work.

Figure 3. Edit menu

Opens the Edit Scenario Configuration modal dialog where you can assign rainfall runoff models to functional units in various sub-catchments. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can assign inputs (time series) to rainfall runoff models. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can adjust the parameters for rainfall runoff models. This dialog is only available when a catchments scenario is active.

Opens the Configure Constituents modal dialog.

Opens the Edit Scenario Configuration modal dialog where you can assign the constituent generation models in each functional unit. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can adjust the parameters for constituent generation models. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can assign the constituent filtering models in each functional unit. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can adjust the parameters for constituent filtering models. Note that you must assign at least one model before you can open this dialog. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can assign both a routing model and one or more constituent models to specific links. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can adjust the parameters for both the routing model and constituent models associated with specific links. This dialog is only available when a catchments scenario is active. Note that at least one of the links in your model must have a routing model other than straight-through applied before you can open this dialog.

Opens the Edit Scenario Configuration modal dialog where you can inspect the list of existing functional units. You can also use this dialog to add new functional units or delete functional units that are no longer required. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can associate sub-catchments with functional units. This dialog is only available when a catchments scenario is active.

Opens the Edit Scenario Configuration modal dialog where you can assign constituent models at the whole catchment level. This dialog is only available when a catchments scenario is active.

Opens the Restriction Curves Explorer window.

Opens the Ownership Setup window.

Opens the Resource Assessment Explorer window.

Opens the Configure Ordering Algorithm modal dialog.

Opens the Cost Functions modal dialog.

Opens the Configure Crop Parameters dialog.

Opens the Forecasting Scenarios dialog. This is only available in the River Operator scenario when a scenario run has been completed.

Opens the Wetland Configuration dialog.

Opens the Input Sets model dialog.

Figure 3. View menu

Many of the commands in this menu control whether a window is visible on your screen. The commands act as toggles:

If a window is visible when the command is chosen, the window will be hidden.
If a window is hidden when the command is chosen, it will become visible.

The commands remember the location of a window while it is hidden:

If a window is docked before being hidden, it will remain docked in the same location when it is again made visible. Other docked windows within the main window will expand or shrink accordingly.
If a window is undocked before being hidden, it will remain undocked in the same location when it is again made visible.

Toggles whether the Project Explorer is visible on screen. Synonym for Project Explorer on the Project toolbar.

Toggles whether the Data Sources tab is visible on screen. Synonym for Data Sources on the Project toolbar.

Toggles whether the Recording Manager is visible on screen. Synonym for Recording Manager on the Project toolbar.

Toggles whether the Log Reporter is visible on screen. Synonym for Log Reporter on the Project toolbar.

Toggles whether the Chart Recording tab is visible on screen. Synonym for Chart Recording Manager on the Project toolbar.

Toggles whether the Geographic View is visible on screen. Synonym for Geographic Editor on the Scenario toolbar.

Toggles whether the Layer Manager is visible on screen. Synonym for Layer Manager on the Scenario toolbar.

Toggles whether the Location Control is visible on screen. Synonym for Location Control on the Scenario toolbar. You can use this window to set geolocation coordinates and elevations for nodes, and elevations for reaches. While it is not essential, it is conventional to set elevations with respect to Australian Height Datum (AHD). You can enter negative numbers for components that are below sea level, such as the lower lakes of the Murray. The elevation of a component is the zero point for that component. For example, the zero point for a storage is the lowest point in the storage.

View » Node Palette

Toggles whether the Node Palette is visible on screen. Synonym for Node Palette on the Scenario toolbar.

Toggles whether the Geographic Editor, Schematic Editor and Tabular Editor tabs are visible on screen. Synonym for Schematic Editor on the Scenario toolbar.

Toggles whether the Tabular Editor tab is visible on screen. Synonym for Tabular Editor on the Scenario toolbar.

Restores the default arrangement of Source windows. Requires an active scenario. Affects the Node Palette, and the Geographic, Schematic and Tabular editors. If an affected window is undocked, it will be re-docked. If an affected window was auto-hidden, that feature will be turned off. Any affected window that has been moved will be restored to its default location.

Opens the Data Mappings Viewer.

Opens the Audit Logs Viewer.

Opens the Expression List Viewer.

Figure 4. Run menu

Selects the type of analysis to be performed. Synonym for Select Analysis Type on the Simulation toolbar. See Running scenarios and Forecasting.

Opens a configuration window for the selected analysis type where you can set parameters to control the run (eg. date-range). Synonym for Configure on the Simulation toolbar. See Running scenarios and Forecasting.

Performs the selected analysis. Synonym for Begin Analysis (Run) on the Simulation toolbar.

Opens the Run Multiple Scenarios window.

Figure 5. Tools menu

Displays a spatial map of the constituent loads per sub-catchment. See Mapping Analysis window.

Converts data from one unit type to another.

Launches the calibration wizard for catchments. Synonym for clicking Configure on the Simulation toolbar (or choosing Run » Configure...) when Select Analysis Type is set to RR Calibration Analysis. See also Calibration Wizard for catchments.

Opens the recordable element selection panel of the calibration wizard for catchments. This panel should be treated as read-only.

Opens the period definition panel of the calibration wizard for catchments. This panel should be treated as read-only.

Opens the metaparameter definition panel of the calibration wizard for catchments. This panel should be treated as read-only.

Opens the optimisation function configuration panel of the calibration wizard for catchments. This panel should be treated as read-only.

Opens the optimisation results window. This window is populated by a run of the calibration wizard for catchments. See also Inspecting calibration results.

Opens the Scenario Test Builder dialog.

Opens the Data Calculator dialog.

Opens the Data Modification Tool dialog.

Opens the Metaparameter Explorer dialog.

Opens the Find dialog. See Searching for nodes and links.

Opens a standard file-save dialog where you can export an XML representation of your project. For best results, use Internet Explorer 9 or above, or Firefox 5 or above. These will open XML in a browser.

Allows access to some of the plugins added using the Plugin Manager.

Allows you to add and remove plugins in Source.

Opens the Units Preferences window (see Unit preferences).

Opens the Options dialog. The available options include:

- A compression slider. The default is low compression but there is no reason not to set the slider to its maximum value. This results in the most compact project files for almost no penalty in file load or save times;
- Settings that enable you to control the number of decimal places that are used in various Source windows. Use the Editable Decimal Places field to adjust the number of decimal places shown in fields that you can edit. The Visible Decimals field controls the number of decimal places displayed in fields that you cannot edit. Neither of these settings has any effect unless the Enable rounding checkbox is turned on. Clicking Restore default values resets both decimal place fields to their default values and clears the Enable rounding checkbox; and
- Settings that enable you to limit the number of columns displayed in the Tabular Editor. Use the Maximum Columns to Display field to limit the number of columns. Restricting the number of columns can improve performance. Click Restore default value to re-apply the system default of 1000 columns.

Opens the Set Recording Defaults dialog. See also Recording Manager defaults.

Opens the Graph Settings dialog. This is a global setting allowing you to customise charts before they are produced. To customise an individual chart, access the Edit graph properties button from the toolbar on the chart itself.

Opens the Edit Tabular Formatting Settings dialog. Refer to the chapter on User preferences.

Figure 6. Help menu

Opens the User guide.

Opens a flyer where you can obtain information about Source training.

Opens the Guidelines for Water Management Modelling. See also Guidelines for water management modelling.

Opens the Source Scientific Reference Guide.

Launches your browser with a URL to the eWater web site where you can report a bug.

Opens the Welcome to Source screen. You can use this window to:

- Create new projects and scenarios. The commands found here are synonyms for File » New » Project... and File » New » Scenario..., and New Scenario on the File toolbar;
- Open recent projects. You can also find a list of recent projects at File » [recent documents];
- Find more information about Source capabilities, news and release notes; and
- Access user guides and links to online training and other useful materials.

You can use this command to turn on the Show page on startup checkbox if you have turned it off.

Contains links to related information accessible via the World Wide Web.

Opens a window containing product information.

Toolbars

Toolbars in the main window offer shortcuts to their equivalent menu commands.

Figure 7. Data Sources toolbar

New Data Source

Creates a new data source. The available options are:

- Scenario Data Source - use the output of a scenario as a data source; or
- File Data Source - use a specified file to enter data

New Folder

Creates a new data folder within the data source

Expand All

Expands the file hierarchy

Collapse All

Collapses the file hierarchy

Reload all time series

Reloads all time series when Reload on Run is selected

Filter

Filters out all data items with incompatible units

Figure 8. File toolbar

New Scenario

Creates a new, empty scenario. Synonym for both File » New » Scenario... and New Scenario (by menu) on the Project Explorer toolbar.

Open Project

Opens an existing project. Synonym for File » Open...

Save Project

Saves the current project, overwriting the existing file. Synonym for File » Save. Implies File » Save As... if the project has never been saved.

Figure 9. Geographic Editor toolbar

Print (Geographic Editor toolbar)

This button formats the Geographic Editor for printing and opens the Print preview dialog. At present, the entire schematic is scaled to fit within a single A4 page in portrait mode.

Save as image (Geographic Editor toolbar)

This button prepares the Geographic Editor for saving in JPEG format. The command opens a standard file dialog box so that you can choose where to save the image. At present, the entire schematic is scaled to fit within a single A4 page in portrait mode.

Track (Geographic Editor toolbar)

This button controls whether the Geographic Editor always scrolls to show components as they are selected in the Project Hierarchy.

The default state of this button is off. In this mode, Source leaves the Geographic Editor window unchanged, regardless of any selections you may make in the Project Hierarchy.

If you turn Track on, the Geographic Editor window will scroll to bring into view any node or link that you select in the Project Hierarchy. You can use this feature to locate components in large models.

Node labels (Geographic Editor toolbar)

This button controls whether the names of nodes are shown in the Geographic Editor.

Link labels (Geographic Editor toolbar)

This button controls whether the names of li are shown in the Geographic Editor.

The buttons and pop-up menus accessible from the Graph tab toolbar are explained in more detail in the chapter on Using the Charting Tool. See Graph viewing options.

Figure 10. Graph tab toolbar

Drag to overlay

Used to overlay one graph onto another.

Lasso Zoom

Enables zooming (when used in conjunction with Zoom Control).

Zoom Control

A pop-up menu affecting zooming behaviour (when used in conjunction with Lasso Zoom).

Logarithmic graph

Recomputes the Y-axis of the graph for different logarithmic scales.

Grid Options

A pop-up menu affecting the behaviour of grid lines.

Hint

Toggles display for the x and y coordinates of the tracing points.

Units

A pop-up menu allowing you to recompute the Y-axis using different units.

Chart type

A pop-up menu which allows you to obtain alternative views of multiple data sets as well as recompute the chart as probability distributions.

Hide/show legend

Toggles display of the legend.

Toggle preview chart

Toggles display of the preview chart.

Edit graph properties

Opens a panel where chart settings (eg. colours) can be adjusted.

Save options

A pop-up menu offering a number of ways in which data can be exported from the Charting Tool.

Print options

A pop-up menu providing access to printing tools.

Figure 11. Layer Manager toolbar

Add layer

Allows the addition of a new layer to the geographic view.

Move layer up

Moves the layer selected in the Layer Manager higher up in the layer appearance order.

Move layer down

Moves the layer selected in the Layer Manager lower down in the layer appearance order.

Remove Layer

Removes the layer currently selected in the Layer Manager from the geographic view.

Figure 12. Ordering toolbar

Configure Ordering

A pop-up menu with two options:

- Algorithm... opens the Configure Ordering Algorithm modal dialog. Synonym for Edit » Ordering » Algorithm...
- Network Costs... opens the Cost Functions modal dialog. Synonym for Edit » Ordering » Network Costs...

Project Explorer

Toggles whether the Project Explorer is visible on screen. Synonym for View » Project Explorer.

Data Sources

Toggles whether the Data Sources is visible on screen. Synonym for View » Data Sources.

Recording Manager

Toggles whether the Recording Manager is visible on screen. Synonym for View » Recording Manager.

Log Reporter

Toggles whether the Log Reporter is visible on screen. Synonym for View » Log Reporter.

Chart Recording Manager

Toggles whether the Chart Recorder is visible on screen. Synonym for View » Chart Recording Manager.

Figure 13. Project Explorer toolbar

New Scenario (by menu)

Attaches a new, empty scenario to the current project. Synonym for both File » New » Scenario... and New Scenario on the File toolbar. The available scenario options are:

River Manager Schematic Scenario - a blank management scenario with no predefined elements; and
Geographic Wizard - creates a scenario based on choices made through a wizard containing predefined elements.

Copy Scenario

Makes a copy of (clones) the scenario that is selected in the Project Hierarchy. You are prompted to select a new name for the copied scenario. The new scenario will be a duplicate of the original at the time of the copy. All scenario names must be unique.

Delete Scenario

Removes the scenario that is selected in the Project Hierarchy. You are prompted to confirm the deletion. Deletions cannot be undone.

Recording Options

Allows you to change the state of all recordable parameters for the object that is selected in the Project Hierarchy. The choice will be applied to the selected element and all elements below it in the hierarchy. The choices are:

- Record All - records all of the parameters under this level of the hierarchy when the model is run. The recorded results will be visible in the Recording Manager window. See Running scenarios;
- Record None - records none of the parameters under this level of the hierarchy when the model is run; and
- The Recording Defaults... option opens the Set Recording Defaults dialog where you can define a set of recording options that will be applied to all of your Source projects by default.

Sort Categorised

Sorts the components of each scenario according to the type of component (eg. all links sort together, all nodes sort together, etc) and, within each component grouping, according to component sub-type (eg. all Inflow nodes sort together).

Sort Alphabetical

Sorts the components of each scenario into alphabetical order according to the names of the components in your scenario.

View Type

This pop-up menu offers three choices:

Parameter View which changes the Project Hierarchy so that it is classified according to the kind of recordable parameter;
Source Catchments view, which is not relevant to Source; and
River Manager (Default) view which changes the Project Hierarchy so that it is classified according to the kind of recordable component.

Figure 14. Recording Manager toolbar

Save Run Results

Exports time-series data from the currently-selected run to either a .CSV or tab-separated-value file.

Open Run Results in Excel

Exports the collected results data to Excel as a single time-aligned spreadsheet. The left-most column of the spreadsheet contains a time-stamp. Each of the remaining columns contains observations from one of your recordable parameters, in the same order as the results appear in the Recording Manager.

Open Run Results

Not enabled.

Delete Run Results

Clears the currently selected run. You are not prompted to confirm the action and it can not be undone.

Sort Run Results

This button lists the run results based on the network run order – leaf nodes to outlet node. Note that this is the default order of run results. It can be used to reset the results after other sorting methods (such as column headings) have been used.

Figure 15. Scenario toolbar

Geographic Editor

Toggles the state of the Geographic View tab. Synonym for View » Chart Recording Manager.

Layer Manager

Toggles the state of the Layer Manager window. Synonym for View » Layer Manager.

Location Control

Toggles the state of the Location Control dockable window.

Node Palette

Toggles the state of the Node Palette. Synonym for View » Node Palette.

Schematic Editor

Toggles the state of the Schematic Editor tab. Synonym for View » Schematic Editor.

Tabular Editor

Toggles the state of the Tabular Editor tab. Synonym for View » Tabular Editor.

Figure 16. Schematic Editor grid toolbar

Display Grid

Controls whether the Schematic Editor displays a grid on the drawing canvas.

Snap to Grid

Controls whether nodes are aligned with the underlying grid in the Schematic Editor.

Set Grid Size

The value in this field determines the frequency of grid lines in the Schematic Editor. The units are in pixels.

Print (Schematic Editor grid toolbar)

Formats the Schematic Editor for printing and opens the Print preview dialog.

Save as Image (Schematic Editor grid toolbar)

Prepares the Schematic Editor for saving in JPEG format.

Figure 17. Schematic Editor options toolbar

Allow Link Dragged

Enabling this button allows you to disconnect the downstream end of a link from the node to which it is attached, and then re-connect that link to the upstream inlet of another node. You can use this feature to insert new nodes into a schematic without losing the configuration of existing links.

Straight Lines

This button controls the representation of links. Source defaults to drawing links using orthogonal (elbow) lines. Click Straight Lines to change the default representation to straight lines.

The representation of any link can be controlled independently using the contextual menu in the Schematic Editor. Right-click the link and choose one of the options in the Link Type sub-menu.

Each line has one control point which you can adjust to route the line around obstacles. The control point for an orthogonal line can only be moved in the vertical dimension whereas the control point for a straight line has no restrictions on its movement.

Note: At present, only the setting of the Straight Lines button is saved with your project. Any changes you make to individual links or control points are lost when you close your project.

Node Labels

This button controls whether the names of nodes are shown in the Schematic Editor. Source defaults to displaying node names.

Link Labels

This button controls whether the names of links are shown in the Schematic Editor. Source defaults to displaying link names.

Track (Schematic Editor options toolbar)

This button controls whether the Schematic Editor always scrolls to show components as they are selected in the Project Hierarchy. The default state of this button is off. In this mode, Source leaves the Schematic Editor window unchanged, regardless of any selections you may make in the Project Hierarchy.

If you turn Track on, the Schematic Editor window will scroll to bring into view any node or link that you select in the Project Hierarchy. You can use this feature to locate components in large models.

Overview Panel

This button controls whether the Overview Panel is shown in the Schematic Editor. The default state of this control is off. You can use the Overview Panel to obtain a thumbnail view of your entire schematic.

Pan

When this button is enabled, clicking and holding on any part of the drawing surface in the Schematic Editor moves the entire drawing surface. This is an alternative to using the scroll bars.

Tool-tips

This button is a popup menu containing three options:

- Tool tips on - when selected, clicking on any node in the Schematic Editor causes a small floating window to appear which contains additional information about that node.
- Tool tips off - when selected, the floating windows do not appear.
- Tool tips locked - when selected, clicking any node in the Schematic Editor causes a small floating window to appear next to every node.

Select Analysis Type

Selects the type of analysis to be performed. Synonym for Run <type> analysis. The options are:

Flow Calibration analysis, which derives the "best" set of parameter values so that output from the model matches an observed data set;
Run w/Warm Up, which seeds the model with the available historical data and prepares for forecasting. See also Incorporating uncertainty into climate variability;
Single analysis, which simulates the river performance for a single set of conditions (as opposed to an iterative analysis which considers several possible outcomes); or
Stochastic analysis, which is used when dealing with stochastic climate data. Refer to Calibration Wizard for catchments.

Configure

Opens a configuration window for the selected analysis type where you can set parameters to control the run (eg. date-range). Synonym for Run » Configure....

Begin Analysis (Run)

Performs the selected analysis. Synonym for Run » Run....

Figure 18. Statistics toolbar

Monthly

Shows the statistics for each month of the year in the period run.

Yearly

Shows the statistics for each year in the period run.

Month by Year

Shows the individual statistics for every month of every year in the period run.

Total

Provides statistical data for the entire period run.

Refer to Using the Charting Tool for more detail on these commands.