Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
iconfalse

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
MenuDescription
Menu barSimilar to the high-level standard Windows menu bar, this bar allows you to access various components of Source.
File menuProvides high-level management of files, scenarios and projects, such as the ability to save, close and open files.
Edit menuProvides access to various components, such as ownership, resource assessment and additional tools (for example, the Feature Table and Scenario Input Sets).
View menuControls visibility of various panels, such as the Project Explorer or Log Reporter.
Run menuProvides the ability to run scenarios.
Tools menuProvides access to various tools and plugins.
Help menuProvides 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:

  • File – Load results files and time series, save and load configuration files;
  • Options access Transforms; and
  • Help Provides links to documentation, feedback and a list of the keyboard shortcuts.
Table 2. Source toolbars
ToolbarDescriptionLocation in Source
ChartAllows you to manage and work with charts.Results Manager
Data SourcesAllows you to manage and work with time series data.Data Sources Explorer
Date RangesAllows you to manage and work with date ranges.Function Editor
Results ManagerAllows you to manage, analyse and view resultsResults Manager
FileProvides high-level management of projects and scenarios.Main screen
Function EditorAllows you to work with functions.Function Editor
Function managerProvides high-level management of functions.Function Manager
Geographic EditorAllows you to work with catchments scenarios.Geographic Editor
Scenario Input SetsAllows management of input sets (used when importing data).Scenario Input Sets
Layer ManagerProvides managements of layers used in the catchments scenarios.Layer Manager
MapsAllows management of a background map image with overlaid nodes of a schematic scenario.Maps
OrderingProvides access to the Ordering dialogs.Main screen
ProjectProvides shortcuts to various Source components.Main screen
Project ExplorerProvides high-level management of scenarios and projects.Project Explorer
Quick View

Quickly alter the view of your results.

 

Results Manager
Recording ManagerAllows you to manage scenario run results.Recording Manager
ScenarioProvides shortcuts to various Source components.Main screen
Schematic EditorAllows you to edit the display properties of the Schematic Editor and components shown within it.Schematic Editor
SimulationAllows you to undertake a scenario run.Main screen
StatisticsAllows you to edit the statistical view of results.Charting tool
Text managementA generic toolbar used for management of text input.Forms part of the Functions and Scenario Input Sets toolbars
TransformsAllows management of transforms.Results Manager

Menus

...

Toggles whether the Node Palette is visible on screen. Synonym for Node Palette on the Scenario toolbar. See Nodes and Links.

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

...

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. 

...

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+RSee Results Manager - Loading Results.

...

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).

...

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

Anchor
ChartToolbar
ChartToolbar
Figure

...

12. Chart toolbar (Charts - Chart toolbar)

Drag (Shift)

When selected, allows you to drag a result from one chart onto another chart.

...

Opens the print dialog so that you can print the chart. 

Anchor
Data sources toolbar
Data sources toolbar
Figure

...

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
Date ranges toolbar
Date ranges toolbar
Figure

...

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
File toolbar
File toolbar
Figure

...

15. File toolbar (User Interface - Main screen)

New Scenario

Creates a new, empty scenario. Synonym for both File » New » Scenario… and New Scenario on the Project Explorer toolbar. Projects and scenarios - Scenarios.

...

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

Anchor
FunctionEditorToolbar
FunctionEditorToolbar
Figure

...

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

...

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
Geographic editor toolbar
Geographic editor toolbar
Figure

15

18. Geographic editor toolbar (Geographic Editor)

Print

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
Input sets toolbar
Input sets toolbar
Figure

16

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
Layer manager toolbar
Layer manager toolbar
Figure

17

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
Maps toolbar
Maps toolbar
Figure

...

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
Ordering toolbar
Ordering toolbar
Figure

...

22. Ordering toolbar

Configure Ordering

A pop-up menu with two options:

Anchor
Project toolbar
Project toolbar
Figure

...

23. Project toolbar (User Interface - Main screen)

Project Explorer

Toggles whether the Project Explorer is visible on screen. Synonym for View » Project Explorer. See User Interface - Project Explorer.

...

Toggles whether the Log Reporter is visible on screen. Synonym for View » Log Reporter. See Running Scenarios - Using the Log Reporter.

 

Anchor
Project Explorer toolbar
Project Explorer toolbar
Figure

...

24. Project Explorer toolbar (User Interface - Project Explorer)

New Scenario

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:

...

  • 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
Quick view toolbar
Quick view toolbar
Figure

...

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
Recording manager toolbar
Recording manager toolbar
Figure

...

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
Scenario toolbar
Scenario toolbar
Figure

...

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
Schematic editor display toolbar
Schematic editor display toolbar
Figure

...

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
Simulation toolbar
Simulation toolbar
Figure

...

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.

...

Performs the selected analysis. Synonym for Run » Run on the Simulation toolbar. See Configuring Scenarios and Forecasting.


Anchor
Statistics toolbar
Statistics toolbar
Figure

28

30. Statistics toolbar (Recording Manager)

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 Statistics

...

Shows statistics for a specified range in the chart.

 

Anchor
Text management toolbar
Text management toolbar
Figure

29

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
Results Manager toolbar
Results Manager toolbar
Figure

...

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
Transforms toolbar
Transforms toolbar
Figure

...

33. Transforms toolbar (Transforms)


Add Transform type

Creates a new transform (or range filter) of type:

...