This section provides an overview of each menu, sub-menu and toolbar command available in the Source main screen. It also acts as a good reference point when you become familiar with Source.
| Info | ||
|---|---|---|
| ||
Note: The Results Manager opens in a separate window after a scenario run. Refer to the following associated menu options and toolbars:
|
Table 1. Menus
| Menu | Description |
|---|---|
| Menu bar | Similar to the high-level standard Windows menu bar, this bar allows you to access various components of Source. |
| File menu | Provides high-level management of files, scenarios and projects, such as the ability to save, close and open files. |
| Edit menu | Provides access to various components, such as ownership, resource assessment and additional tools (for example, the Feature Table and Scenario Input Sets). |
| View menu | Controls visibility of various panels, such as the Project Explorer or Log Reporter. |
| Run menu | Provides the ability to run scenarios. |
| Tools menu | Provides access to various tools and plugins. |
| Help menu | Provides links to useful materials, such as documentation, training and the eWater website. |
| Results Manager | Comprised of the following menus that allow you to manage results analysis:
|
Table 2. Source toolbars
| Toolbar | Description | Location in Source |
|---|---|---|
| Chart | Allows you to manage and work with charts. | Results Manager |
| Data Sources | Allows you to manage and work with time series data. | Data Sources Explorer |
| Date Ranges | Allows you to manage and work with date ranges. | Function Editor |
| Results Manager | Allows you to manage, analyse and view results | Results Manager |
| File | Provides high-level management of projects and scenarios. | Main screen |
| Function Editor | Allows you to work with functions. | Function Editor |
| Function manager | Provides high-level management of functions. | Function Manager |
| Geographic Editor | Allows you to work with catchments scenarios. | Geographic Editor |
| Scenario Input Sets | Allows management of input sets (used when importing data). | Scenario Input Sets |
| Layer Manager | Provides managements of layers used in the catchments scenarios. | Layer Manager |
| Maps | Allows management of a background map image with overlaid nodes of a schematic scenario. | Maps |
| Ordering | Provides access to the Ordering dialogs. | Main screen |
| Project | Provides shortcuts to various Source components. | Main screen |
| Project Explorer | Provides high-level management of scenarios and projects. | Project Explorer |
| Recording Manager | Allows you to manage scenario run results. | Recording Manager |
| Scenario | Provides shortcuts to various Source components. | Main screen |
| Schematic Editor | Allows you to edit the display properties of the Schematic Editor and components shown within it. | Schematic Editor |
| Simulation | Allows you to undertake a scenario run. | Main screen |
| Statistics | Allows you to edit the statistical view of results. | Charting tool |
| Text management | A generic toolbar used for management of text input. | Forms part of the Functions and Scenario Input Sets toolbars |
| Transforms | Allows management of transforms. | Results Manager |
Menus
...
| Anchor | ||||
|---|---|---|---|---|
|
Creates a new, empty project. Opens the Create a 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. See Projects and scenarios - Projects.
Adds a new, empty scenario to the current project. Opens the Create a Scenario dialog that offers a choice of the Geographic wizard or creating a Schematic scenario. Select the type that 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. See Projects and scenarios - Scenarios.
In the absence of an open project, implies creating a new project.
Opens an existing project using the standard open file dialog. Synonym for Open Project on the File toolbar. Source projects use the ".rsproj" extension.
...
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 save dialog which allows you to:
...
Source projects use the ".rsproj" extension.
This command is currently disabled. However, the Print buttons on the Schematic Editor and Geographic Editor toolbars may be used to print scenarios.
...
| Info | ||
|---|---|---|
| ||
| Note: This assumes that the associated project file has not been either moved from the location where it was saved, or renamed, or deleted from your hard disk. |
Quits Source. You are asked to confirm your intention and reminded to save any unsaved work.
...
| Anchor | ||||
|---|---|---|---|---|
|
Opens the Constituents Configuration dialog where you can define constituents. See Constituents - Configuring constituents.
...
Opens the Set Functional Unit Area Via Raster dialog where you can associate sub-catchments with functional units using a raster. This dialog is only available when a catchments scenario is active. See Functional units - Using a raster.
Opens the Functional Unit Area Configuration dialog where you can manually associate sub-catchments with functional units. This dialog is only available when a catchments scenario is active. See Functional units - Manual assignment.
...
Opens the Edit Scenario Configuration – Catchment Model Assignment (optional) dialog where you can assign constituent models at the whole catchment level. This dialog is only available when a catchments scenario is active, and also requires a plugin.
Opens the Restriction Curves Explorer dialog where you can edit restriction curves. See Restriction Curves.
...
See Project Options.
Edit » Ownership... Ownership…
Opens the Ownership Setup dialog where you can manage ownership in a scenario. See Ownership.
Opens the Resource Assessment Explorer dialog where you can configure Annual Accounting, Continuous Accounting and Continuous Sharing. This dialog is only available when a schematic scenario is active. See Resource assessment.
Opens the Configure Ordering Network Costs dialog, where you configure network costs for use with network linear programming ordering. See Network linear programming - Configuring optimisation.
Opens the Crop Parameters dialog where you can configure crops for use at the water user node. See Configuring generic crop settings.
Opens the Function Editor dialog where you can edit functions. See Functions - Function Editor.
Opens the Link Cross Sections dialog where you can assign a physical cross-section for generating link rating curves. See Cross Section Editor
Opens the Constituent Model Configuration dialog where you can assign and manage the constituent generation, filter, instream processing and storage processing models for all constituents in the scenario. See Constituents - Constituent model configuration.
Opens the Rainfall Runoff Model Configuration dialog where you can assign and work with rainfall runoff models. This dialog is only available when a catchments scenario is active. See Rainfall runoff models.
Opens the Demand Constraints dialog where you can view all configured demand constraints. See Water user node - Demand constraints.
Opens the Feature Table dialog where you view parameters for each of the configured nodes in the scenario. See Feature Table.
Opens the Scenario Input Sets dialog where you can create and manage scenario input sets. See Scenario Input Sets.User interface reference
...
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. See Main Application Window.
Opens the Audit Logs Viewer dialog. Right-click on a cell to copy either the selected entries or all entries to the clipboard.
Opens the Notes dialog showing all 'post-it' type notes that have been added to items (eg. nodes, links, function) in the current scenario. See User Interface - About Notes.
Opens the Results Manager window where you can examine and analyse results. See Results Manager.
Opens the Execution Order window showing the order of node execution in the current scenario. See Running Scenarios - Execution order rules.
...
| Anchor | ||||
|---|---|---|---|---|
|
Opens a configuration window where you can set parameters to control the run (eg. date range, scenario input sets). The configuration window shown depends on the analysis type selected in the Simulation toolbar. Synonym for Configure on the Simulation toolbar. See Configuring Scenarios and Forecasting.
Performs the selected analysis. Synonym for Run on the Simulation toolbar. See Configuring Scenarios and Forecasting.
| Anchor | ||||
|---|---|---|---|---|
|
Displays a map of flows and constituent loads per sub-catchment See Catchment Map Results Analysis.
...
Converts data from one unit type to another. See Analysis tools - Data unit converter
Launches the calibration wizard for catchments. Synonym for clicking Configure on the Simulation toolbar (or choosing ) when analysis type is set to Flow calibration analysis. See Calibration Wizard for catchments.
Opens the recordable element selection step of the calibration wizard for catchments. This panel should be treated as read-only. See Calibration Wizard for catchments - Select elements to record.
Opens the period definition step of the calibration wizard for catchments. This panel should be treated as read-only. See Calibration Wizard for catchments - Define calibration period.
Opens the metaparameter definition step of the calibration wizard for catchments. This panel should be treated as read-only. See Calibration Wizard for catchments - Defining metaparameters.
Opens the optimisation function configuration step of the calibration wizard for catchments. This panel should be treated as read-only. See Calibration Wizard for catchments - Configure optimisation functions.
...
Opens the Plugin Manager dialog that allows you to add and remove plugins in Source. To add or edit plugins you need to close any open Source project. See Plugins - Working with the Plugin Manager.
Opens the Application Settings dialog. See Application settings.
Opens the River Operations dialog where you can manage forecasting for a scenario. See Forecasting.
Opens the Function Execution Order dialog showing the order in which functions are evaluated for each time of evaluation. See Functions - Debugging.
...
Turns on the Recording Manager.
Opens the Source Project Diff Tool window where you can find the differences between two scenarios. See Scenario Difference Tool.
Allows you to save scenario configuration details to a *.csv file.
...
Figure #10. Results Manager Help menu
Launches your browser with a URL to the eWater support site (Uservoice).
...
Opens the Hot Key Window, which lists keyboard shortcuts and what they do in Results Manager. See Results Manager - Hot keys
Opens a dialog containing product and license information/
...
Creates a new data source, using either the output of a scenario (Scenario Data Source...Source…) or a time-series file (File Data Source...Source…).
New Folder
Creates a new folder
...
| Anchor | ||||
|---|---|---|---|---|
|
New date range
...
Toggles view of all default date ranges.
| Anchor | ||||
|---|---|---|---|---|
|
New Scenario
Creates a new, empty scenario. Synonym for both and New Scenario (by menu) and New Scenario on the Project Explorer toolbar.
...
Opens an existing project. Synonym for .
Save Project
Saves the current project, overwriting the existing file. Synonym for Implies if the project has never been saved.
| Anchor | ||||
|---|---|---|---|---|
|
This comprises of the text management toolbar, suffixed by additional icons.
Add/Edit Note
Allows you to add a new note, or edit an existing one for the function. See User Interface - About notes.
Insert keyword built-in function (Ctrl+Space)
Inserts a keyword into the A pop-up menu allowing you to insert a built-in function. Synonym for Ctrl+Space. See Available functions, operators, variables and date ranges - Functions.
Anchor Function manager toolbar Function manager toolbar
Figure 14. Function manager toolbar (Functions - Function Manager)
| Function manager toolbar | |
| Function manager toolbar |
New variable
Creates a new function , or variable of the type selected.
...
Collapses all items in the function tree.
Edit functions...functions…
Opens the Function Editor.
...
Opens the Function Editor and displays the function evaluation tree for the selected function. This button is only enabled when a function is selected in the function tree. See Functions - Usages and References.
Show all function and variable usages
...
| Anchor | ||||
|---|---|---|---|---|
|
Save as image (Geographic Editor toolbar)
...
Opens the Print preview dialog allowing you to save the section of the schematic that is currently visible in the Geographic Editor editor as a *pdf.jpg.
Print (Geographic Editor toolbar)
Opens the Print preview dialog allowing you to save
Save as image
Saves the section of the schematic that is currently visible in the Geographic editor Editor as a pdf*.
...
jpg.
Track
When enabled, 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.
Note/Error icons (Geographic Editor toolbar)icons
Toggles the view of any notes and/or errors that are present in the Geographic Editor.
...
See User Interface - About notes.
Node labels
Toggles the view of node names in the Geographic Editor.
Link labels (Geographic Editor toolbar)Link labels
Toggles the view of link names in the Geographic Editor.
Current zoom (Geographic Editor display toolbar)
Displays the current zoom.
Zoom in (Geographic Editor display toolbar)
Zooms in on the model in the Geographic Editor.
Zoom out (Geographic Editor display toolbar)
Zooms out on the model in the Geographic Editor.
Fit to window (Geographic Editor display toolbar)
Fits the entire model horizontally and vertically in the Geographic Editorthe geographic view.
| Anchor | ||||
|---|---|---|---|---|
|
This comprises of the text management toolbar suffixed with additional icons.
Insert scenario base nodes
...
Apply values to scenario immediately
Overrides the input data source with the specified value in the Scenario Input Set editor.Override any other values specified for the same parameter elsewhere in Source for all scenario runs with the values specified in the manual parameter set editor. If disabled, the values take precedence for a single scenario run only.
| Anchor | ||||
|---|---|---|---|---|
|
User Interface - Layer Manager)
Add layer
Allows the addition of Add a new layer to the geographic view.
...
| Anchor | ||||
|---|---|---|---|---|
|
Hide map
Hides the map.
...
Shows a combined map and satellite combined image with nodes overlaid.
Fit to window
Zooms the map to allow a single view of all nodesfit the entire model horizontally and vertically in the map view.
| Anchor | ||||
|---|---|---|---|---|
|
...
A pop-up menu with two options:
- Algorithm... Algorithm… opens the Configure Ordering Algorithm modal dialog. Synonym for Network Costs...
- Network Costs… opens the Cost Functions modal dialog. Synonym for Edit
| Anchor | ||||
|---|---|---|---|---|
|
Project Explorer
Toggles whether the Project Explorer is visible on screen. Synonym for . User Interface - Project Explorer.
Recording Manager
Toggles whether the Recording Manager is visible on screen. Synonym for .
...
Toggles whether the Log Reporter is visible on screen. Synonym for .
Chart Recording ManagerRecording Manager
Toggles whether the Chart Recorder Recording Manager is visible on screen. Synonym for .
| Anchor | ||||
|---|---|---|---|---|
|
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:
- Schematic Scenario - a blank schematic scenario with no predefined elements; and
- Geographic Wizard - creates a scenario based on choices made through a wizard containing predefined elements.
See Projects and scenarios - Scenarios.
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.
...
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.
...
Toggles view of links that enter and exit the water user and bulk licensing nodes.
Display Grid
Controls whether the Schematic Editor displays a grid on the drawing canvas.
...