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 (Figure 16) which offers a choice of a Geographic wizard, River Manager or River Operator schematic scenarios 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 (Figure 14). 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 (Figure 14). 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 if the project has never been saved.
...
Opens a standard Windows™ save dialog (Figure 18) 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.
...
Quit Source. You are asked to confirm your intention (Figure 12) and reminded to save any unsaved work.
Figure 3. Edit menu
Opens the Edit Scenario Configuration modal dialog (Figure 146) where 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 modal dialog (Figure 147) 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 (Figure 148) where 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 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 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 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 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 modal dialog Figure 142 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 Figure 143 where 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 Figure 136 where 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 Figure 138 where 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 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 Restriction Curves Explorer window Figure 208.
Opens the Ownership Setup window (Figure 87). Refer to the chapter on Ownership.
Opens the Resource Assessment Explorer window. Refer to the chapter on Resource assessment.
Opens the Configure Ordering Algorithm modal dialog (Figure 93).
Opens the Cost Functions modal dialog (Figure 94).
Opens the Configure Crop Parameters dialog (Figure 48).
Opens the Forecasting Scenarios dialog (Figure 130). This is only available in the River Operator scenario when a scenario run has been completed.
Opens the Wetland Configuration dialog (Figure 238).
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:
...
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 (Figure 239). 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 PalettePalette, 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 (Figure 57).
Opens the Audit Logs Viewer (Figure 240).
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 (Figure 211).
Launches the calibration wizard for catchments. Synonym for clicking Configure on the Simulation toolbar (or choosing > 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 (Figure 166). This panel should be treated as read-only.
...
Opens the period definition panel of the calibration wizard for catchments (Figure 167). This panel should be treated as read-only.
...
Opens the metaparameter definition panel of the calibration wizard for catchments (Figure 168). This This panel should be treated as read-only.
...
Opens the optimisation function configuration panel of the calibration wizard for catchments (Figure 170). This panel should be treated as read-only.
...
Opens the optimisation results window (Figure 171)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 (Figure 241).
Opens the Data Calculator dialog (Figure 212).
Opens the Data Modification Tool dialog ().
Opens the Metaparameter Explorer dialog (Figure 84).
Opens the Find dialog (Figure 37). See Searching for nodes and links.
...
Allows access to some of the plugins added using the Plugin Manager.
Allows you to add and remove plugins in Source. Refer to Figure 209.
Opens the Units Preferences window (see Unit preferences).
Opens the Options dialog (Figure 230). 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 can not 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 (Figure 231) dialog. See also Recording Manager defaults.
Opens the Graph Settings dialog (Figure 199). 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 (Figure 228). Refer to the chapter on User preferences.
Figure 6. Help menu
Opens this the User guide.
...
Opens the Guidelines for Water Management Modelling. See also Guidelines for water management modelling.
...
- Create new projects and scenarios. The commands found here are synonyms for > New > Project and > New > Scenario, and New Scenario on the File toolbar.;
- Open recent projects. You can also find a list of recent projects at > .
- Find more information about Source capabilities, news and release notes.; and
- Access user guides and links to online training and other useful materials.
...
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:
...
Filters out all data items with incompatible units
Figure 8. File toolbar
New Scenario
Creates a new, empty scenario. Synonym for both and New Scenario (by menu) on the Project Explorer toolbar.
...
Saves the current project, overwriting the existing file. Synonym for Implies 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.
...
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.
...
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.
...
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.
...
Opens a panel where chart settings (eg. colours) can be adjusted.
...
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.
...
Moves the layer selected in the Layer Manager higher up in the layer appearance order.
...
Moves the layer selected in the Layer Manager lower lower down in the layer appearance order.
...
Removes the layer currently selected in the Layer Manager from 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
- Network Costs... opens the Cost Functions modal dialog. Synonym for Edit
...
Project Explorer
Toggles whether the Project Explorer is visible on screen. Synonym for .
...
Data Sources
Toggles whether the Data Sources is visible on screen. Synonym for .
...
Recording Manager
Toggles whether the Recording Manager is visible on screen. Synonym for .
...
Log Reporter
Toggles whether the Log Reporter is visible on screen. Synonym for .
...
Chart Recording Manager
Toggles whether the Chart Recorder is visible on screen. Synonym for .
Figure 13. Project Explorer toolbar
New Scenario (by menu)
Attaches a new, empty scenario to the current project. Synonym for both and New Scenario on the File toolbar. The available scenario options are:
...
Removes the scenario that is selected in the Project Hierarchy. You are prompted to confirm the deletion. Deletions can not cannot be undone.
Recording Options
...
- 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; and
- 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.
...
- 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.
...
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 .
...
Layer Manager
Toggles the state of the Layer Manager window Layer Manager window. Synonym for .
...
Location Control
Toggles the state of the Location Control dockable window.
Node Palette
Toggles the state of the Node Palette. Synonym for .
...
Schematic Editor
Toggles the state of the Schematic Editor tab. Synonym for .
...
Tabular Editor
Toggles the state of the Tabular Editor tab. Synonym for .
Figure 16. Schematic Editor grid toolbar
Display Grid
Controls whether the Schematic Editor displays a grid on the drawing canvas.
...
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.
...
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.
...
This button controls whether the names of nodes are shown in the Schematic Editor. Source defaults to displaying node names.
...
This button controls whether the names of links are shown in the Schematic Editor. Source defaults to displaying link names.
...
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.
...
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.
...
Selects the type of analysis to be performed. Synonym for > . 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
Begin Analysis (Run)
Performs the selected analysis. Synonym for
Figure 18. Statistics toolbar
Monthly
Shows the statistics for each month of the year in the period run.
...
Provides statistical data for the entire period run.
Refer to Using the Charting Tool for more detail on these commands.
...