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 |
| Quick View | Quickly alter the view of your results.
| Results Manager |
| 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
The menu bar for Source is shown in Figure 1 and is like the standard Windows™ menu bar. This section outlines the function of each menu item.| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
File » New » Project…
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.
File » New » Scenario…
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.
File » Open…
Opens an existing project using the standard open file dialog. Synonym for Open Project on the File toolbar. Source projects use the ".rsproj" extension.
File » Close Project
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.
File » Save
Saves the current project, overwriting the existing file. Synonym for Save Project on the File toolbar. Implies if the project has never been saved.
File » Save As…
Opens a standard save dialog which allows you to:
...
Source projects use the ".rsproj" extension.
File » Print…
This command is currently disabled. However, the Print buttons on the Schematic Editor and Geographic Editor toolbars may be used to print scenarios.
...
Opens the Import Scenario dialog where you can import scenarios from different projects. See Import and export of data - Importing scenarios.
File » [recent documents]
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.
| 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. |
File » Exit…
Quits Source. You are asked to confirm your intention and reminded to save any unsaved work.
| Anchor | ||||
|---|---|---|---|---|
|
...
Opens the Edit Scenario Configuration – Name Functional Units 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 equivalent to step 4 of the Geographic Wizard and is only available when a catchments scenario is active.
Edit » Functional Units » Assign Area Via Raster…
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.
Edit » Functional Units » Assign Area Manually…
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 Ownership Setup dialog where you can manage ownership in a scenario. See Ownership.
Edit » Resource Assessment…
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.
Edit » Ordering » Network Costs…
Opens the Configure Ordering Network Costs dialog, where you configure network costs for use with network linear programming ordering. Synonym for Network Costs… in the Ordering toolbar. See Network linear programming - Configuring optimisation.
Edit » Crop Parameters…
Opens the Crop Parameters dialog where you can configure crops for use at the water user node. See Configuring generic crop settings.
...
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.
| Anchor | ||||
|---|---|---|---|---|
|
...
- 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.
View » Project Explorer
Toggles whether the Project Explorer is visible on screen. Synonym for Project Explorer on the Project toolbar. See User Interface - Project Explorer.
View » Recording Manager
Toggles whether the Recording Manager is visible on screen. Synonym for Recording Manager on the Project toolbar. See Recording Manager.
View » Log Reporter
Toggles whether the Log Reporter is visible on screen. Synonym for Log Reporter on the Project toolbar. See Running Scenarios - Using the Log Reporter.
View » Data Sources
Toggles whether the Data Sources Explorer is visible on screen. Synonym for Data Sources on the Scenario toolbar. See Specifying data inputs - Data Sources Explorer.
...
Toggles whether the Geographic View is visible on screen. Synonym for Geographic Editor on the Scenario toolbar. See Geographic Editor.
View » Layer Manager
Toggles whether the Layer Manager is visible on screen. Synonym for Layer Manager on the Scenario toolbar. See User Interface - Layer Manager.
...
Toggles whether the Node Palette is visible on screen. Synonym for Node Palette on the Scenario toolbar. See Nodes and Links.
View » Schematic Editor
Toggles whether the Schematic Editor tab is visible on screen. Synonym for Schematic Editor on the Scenario toolbar. See Schematic Editor.
View » Tabular Editor
Toggles whether the Tabular Editor tab is visible on screen. Synonym for Tabular Editor on the Scenario toolbar. See Tabular Editor.
View » Reset All Windows
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.
View » Notes…
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 Execution Order window showing the order of node execution in the current scenario. See Running Scenarios - Execution order rules.
...
| Anchor | ||||
|---|---|---|---|---|
|
Run » Configure…
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 and Operations.
Run » Run…
Performs the selected analysis. Synonym for Run on the Simulation toolbar. See Configuring Scenarios and Forecasting and Operations.
| Anchor | ||||
|---|---|---|---|---|
|
Tools » Analysis Windows » Map…
Displays a map of flows and constituent loads per sub-catchment See Catchment Map Results AnalysisReporting Region.
Tools » Analysis Windows » Data Unit Converter
Converts data from one unit type to another. See Analysis tools - Data unit converter
...
Opens the Find dialog where you can search for nodes and links in the current open scenario. Synonym for Ctrl+F. See Nodes - Searching for nodes and links.
Opens the Chart window.
...
Opens the River Operations dialog where you can manage forecasting for a scenario. See Forecasting and Operations.
...
Opens the Climate Data Import Tool window where you can import climate data for a catchments scenario. See Climate data import tool.
| Anchor | ||||
|---|---|---|---|---|
|
...
...
Launches your browser with a URL to the eWater Training page.
Help » Source Documentation
Launches your browser with a URL to the home page of this documentation.
Launches your browser with a URL to the eWater Toolkit.browser with a URL to the eWater Toolkit.
Launches your browser with a URL to the page Australian Modelling Practice
Launches your browser with a URL to the eWater support site (Uservoice).
Help » Splash Screen
Opens the Source splash screen (synonymous to opening Source for the first time).
...
The menu bar for Results Manager is shown in Figure #8. This section outlines the function of each menu item.
Figure
...
8. Results Manager menu bar.
Figure
...
9. Results Manager File menu
Loads all result files (*.res.csv) in the specified folder into Results Manager. Files in sub-folders are not loaded, nor are other time series. Synonym for Load a folder of Results Files (*.res.csv) on the Results Manager toolbar, and Ctrl+R. See Results Manager - Loading Results.
...
Loads a previously saved configuration file (*.dora) into Results Manager. Synonym for Load configuration on the Results Manager toolbar, and Ctrl+L. See Results Manager - Configurations.
File » Exit
Exits the Results Manager.
Figure
...
10. Results Manager Options menu
Opens the Transforms window, where you can create, edit and delete data transforms. Synonym for Set up your data transforms and Ctrl+Shift+T. See Transforms.
Figure
...
11. Results Manager Help menu
Launches your browser with a URL to the eWater support site (Uservoice).
...
Opens a dialog containing product and license information/
Toolbars
Toolbars in the main window offer shortcuts to their equivalent menu commands.
| Anchor | ||||
|---|---|---|---|---|
|
...
12. Chart toolbar (Charts - Chart toolbar)
Drag (Shift)
When selected, allows you to drag a result from one chart onto another chart.
...
A pop-up menu that allows you to change the chart type. See Chart typesGraph Types.
Hide/show legend
Toggles display of the legend.
...
Opens the print dialog so that you can print the chart.
| Anchor | ||||
|---|---|---|---|---|
|
...
13. Data sources toolbar (Specifying data inputs - Data Sources Explorer)
New Data Source
Creates a new data source, using either the output of a scenario (Scenario Data Source…) or a time-series file (File Data Source…).
...
Works in conjunction with Reload on run to determine if source data will cause scenario run failure.
| Anchor | ||||
|---|---|---|---|---|
|
...
14. Date ranges toolbar (Types of functions and variables - Function date ranges)
New date range
Creates a new date range of type as selected.
...
Toggles view of all default date ranges.
| Anchor | ||||
|---|---|---|---|---|
|
...
15. File toolbar (User Interface - Main screen)
New Scenario
Creates a new, empty scenario. Synonym for both and New Scenario on the Project Explorer toolbar. Projects and scenarios - Scenarios.
...
Saves the current project, overwriting the existing file. Synonym for Implies if the project has never been saved.
| Anchor | ||||
|---|---|---|---|---|
|
...
16. Function editor toolbar (Functions - Function Editor)
This comprises of the text management toolbar, suffixed by additional icons.
...
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
| Function manager toolbar | |
| Function manager toolbar |
...
17. Function manager toolbar (Functions - Function Manager)
New variable
Creates a new function or variable of the type selected.
...
Displays the usages of all function and variables in the function tree. See Usages and References.
| Anchor | ||||
|---|---|---|---|---|
|
18. Geographic editor toolbar (Geographic Editor)
Opens the Print preview dialog allowing you to save the section of the schematic that is currently visible in the Geographic editor as a pdf.
...
Fits the entire model horizontally and vertically in the geographic view.
| Anchor | ||||
|---|---|---|---|---|
|
19. Scenario Input Sets toolbar (Scenario Input sets)
This comprises of the text management toolbar suffixed with additional icons.
...
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 | ||||
|---|---|---|---|---|
|
20. Layer manager toolbar (User Interface - Layer Manager)
Add layer
Add a new layer to the geographic view.
...
Removes the layer currently selected in the Layer Manager from the geographic view.
| Anchor | ||||
|---|---|---|---|---|
|
...
21. Maps toolbar (Maps)
Hide map
Hides the map.
Maps
...
Zooms the map to fit the entire model horizontally and vertically in the map view.
| Anchor | ||||
|---|---|---|---|---|
|
...
22. Ordering toolbar
Configure Ordering
A pop-up menu with two options:
- Network Costs… opens the Cost Functions modal dialog. Synonym for EditNetwork linear programming - Configuring optimisation.
| Anchor | ||||
|---|---|---|---|---|
|
...
23. Project toolbar (User Interface - Main screen)
Project Explorer
Toggles whether the Project Explorer is visible on screen. Synonym for . See User Interface - Project Explorer.
...
Toggles whether the Log Reporter is visible on screen. Synonym for . See Running Scenarios - Using the Log Reporter.
| Anchor | ||||
|---|---|---|---|---|
|
...
24. Project Explorer toolbar (User Interface - Project Explorer)
New Scenario
Attaches a new, empty scenario to the current project. Synonym for both and New Scenario on the File toolbar. The available scenario options are:
...
- Parameter View which changes the Project Hierarchy so that it is classified according to the kind of recordable parameter;
- Geographic Defaults or Schematics Defaults, which changes the Project Hierarchy so that it is classified according to the kind of recordable component.
| Anchor | ||||
|---|---|---|---|---|
|
...
25. Quick View toolbar (Charts - Quick View toolbar)
Allows you to apply either a date range filter or a repeating range filter to all results in the current chart, and you can also apply an aggregator.
| Anchor | ||||
|---|---|---|---|---|
|
...
26. Recording manager toolbar (Recording Manager)
Save Run Results
Exports time-series data from the currently-selected run to either a * .csv or tab-separated-value file.
...
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.
| Anchor | ||||
|---|---|---|---|---|
|
...
27. Scenario toolbar (Main screen)
Geographic Editor
Toggles the state of the Geographic Editor tab. Synonym for View » Geographic Editor. See Geographic Editor.
...
Toggles the state of the Node Palette. Synonym for View Node Palette. See Nodes and Links.
Schematic Editor
Toggles the state of the Schematic Editor tab. Synonym for View Schematic Editor. See Schematic Editor.
...
Toggles the state of the Function manager dockable window. Synonym for View Function manager. See Functions - Function Manager.
| Anchor | ||||
|---|---|---|---|---|
|
...
28. Schematic editor toolbar (Schematic Editor)
Enable connecting link to a different node
...
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.
...
Fits the entire model both horizontally and vertically in the Schematic Editor window.
| Anchor | ||||
|---|---|---|---|---|
|
...
29. Simulation toolbar (Running a scenario)
Select Analysis Type
Use drop-down menu to choose the desired analysis type for the model run. See Configuring Scenarios and Forecasting and Operations.
Configure
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 Run » Configure…. See Configuring Scenarios and Forecasting and Operations.
Run
Performs the selected analysis. Synonym for Run » Run on the Simulation toolbar. See Configuring Scenarios and Forecasting and Operations.
Note: This toolbar is found on the Statistics tab of some results accessed through the Recording Manager. Equivalent options are accessed from the Period Type drop-down on the Statistics tab of Results Manager, see Chart Statistics.
Monthly
Shows the statistics for each month of the year in the period run.
...
Shows statistics for a specified range in the chart.
| Anchor | ||||
|---|---|---|---|---|
|
31. Text management toolbar
This is a generic toolbar used specifically for management of text input. It is present in the Scenario Input Sets dialog and Function Editor.
...
Toolbars in the Results Manager
| Anchor | ||||
|---|---|---|---|---|
|
...
32. Results Manager toolbar
Load a folder of Result Files (*.res.csv)
...
Opens the Transforms window, where you can create, edit and delete data transforms. Synonym for Options » Transforms and Ctrl+Shift+T. See Transforms.
| Anchor | ||||
|---|---|---|---|---|
|
...
33. Transforms toolbar (Transforms)
Add Transform type
Creates a new transform (or range filter) of type:
...