Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Edit through the REST API

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

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
Menu bar
Menu bar
Figure 1. Menu bar

 


Anchor
File menu
File menu
Figure 2. File menu

...

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

 


Anchor
Edit menu
Edit menu
Figure 3. Edit menu

Image Modified

...

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
View menu
View menu
Figure 4. View menu

...

  • 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 menu
Run menu
Figure 5. Run menu

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 menu
Tools menu
Figure 6. Tools menu

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 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
Help menu
Help menu
Figure 7. Help menu

...

Image Added

...

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.     

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

...

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. 

...

Opens a dialog containing product and license information/

Toolbars

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

...

A pop-up menu that allows you to change the chart type. See Chart typesGraph Types

Hide/show legend

Toggles display of the legend.

...

 Displays the usages of all function and variables in the function tree. See Usages and References.

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 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 20. Layer manager toolbar (User Interface - Layer Manager)

...

Anchor
Project toolbar
Project toolbar
Figure 23. Project toolbar (User Interface - Main screen)

...

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)

...

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.

...

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.


Anchor
Statistics toolbar
Statistics toolbar
Figure 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 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
Text management toolbar
Text management toolbar
Figure 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.

...