User interface reference

Note: This is documentation for version 4.11 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above

User interface reference

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.

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

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:

  • 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

Toolbar

Description

Location in Source

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.

Figure 1. Menu bar

 

Figure 2. File menu

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 File » Save As… if the project has never been saved.

File » Save As…

Opens a standard save dialog which allows you to:

  • Enter a name for your project; and

  • Determine where the file will be saved.

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.

File » Print Preview

This command is currently disabled. However, the Print buttons on the Schematic Editor and Geographic Editor toolbars may be used to print scenarios. Clicking that button also provides a preview.

File » Import Scenario

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.

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.



Figure 3. Edit menu

Edit » Constituents…

Opens the Constituents Configuration dialog where you can define constituents. See Constituents - Configuring constituents.

Edit » Functional Units » List

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.

Edit » Catchments » Assign Models

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.

Edit » Restriction Curves…

Opens the Restriction Curves Explorer dialog where you can edit restriction curves. See Restriction Curves.

Edit » Scenario Options

Opens the Scenario Options dialog where you can set preferences that affect the selected scenario. The following options are available:

Edit » Project Options

Opens the Project Options dialog where you can set preferences that affect the open project. The following options are available:

 Edit » Ownership…

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.

Edit » Functions…

Opens the Function Editor dialog where you can edit functions. See Functions - Function Editor.

Edit » Link Cross Sections…

Opens the Link Cross Sections dialog where you can assign a physical cross-section for generating link rating curves. See Cross Section Editor

Edit » Constituent Models…

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.

Edit » Rainfall-Runoff Models…



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.

Edit » Demand Constraints…



Opens the Demand Constraints dialog where you can view all configured demand constraints. See Water user node - Demand constraints.

Edit » Feature Table…

Opens the Feature Table dialog where you view parameters for each of the configured nodes in the scenario. See Feature Table.

Edit » Recorder Sets…

Opens the Recorder Sets dialog where you can create and manage recorder sets. See Recorder Sets

Edit » Scenario Input Sets…

Opens the Scenario Input Sets dialog where you can create and manage scenario input sets. See Scenario Input Sets.



Figure 4. View menu

Many of the commands in this menu control whether a window is visible on your screen. The commands act as toggles:

  • If a window is visible when the command is chosen, the window will be hidden.

  • If a window is hidden when the command is chosen, it will become visible.

The commands remember the location of a window while it is hidden:

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

View » Function Manager

Toggles whether the Function Manager is visible on screen. Synonym for Function Manager on the Scenario toolbar. See Functions - Function Manager.

View » Geographic Editor

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.

View » Location Control

Toggles whether the Location Control is visible on screen. Synonym for Location Control on the Scenario toolbar. See Maps - Location Control.

View » Map

Toggles whether the scenario map is visible on screen. Synonym for Map on the Scenario toolbar. See Maps.

View » Node Palette

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.

View » Audit Logs…

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.

View » Results Manager…

Opens the Results Manager window where you can examine and analyse results. See Results Manager.

View » Execution Order

Opens the Execution Order window showing the order of node execution in the current scenario. See Running Scenarios - Execution order rules.



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.



Figure 6. Tools menu

Tools » Analysis Windows » Map…

Displays a map of flows and constituent loads per sub-catchment See Catchment Map Results Analysis.