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.
...
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.
...
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.
| Anchor | ||||
|---|---|---|---|---|
|
...
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 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 | ||||
|---|---|---|---|---|
|
...
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 | ||||
|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
Drag (Shift)
When selected, allows you to drag a result from one chart onto another chart.
Pan
When selected, you can click and drag in the chart area to pan around the chart. This is particularly useful when examining a particular area of a chart using the zoom function.
Lasso Zoom
When selected, you can click and drag on the chart area to zoom in on that area. This is used in conjunction with Zoom Control.
Zoom Control
A pop-up menu affecting the zooming behaviour of Lasso Zoom.
Logarithmic graph
Recomputes the Y-axis of the graph for different logarithmic scales.
Toggle gridlines
A pop-up menu affecting the behaviour of grid lines.
Hint
Toggles display for the x and y coordinates of data points (also called tracing points).
Units
A pop-up menu allowing you to change the display of the Y-axis to different, commensurate units.
Chart type
A pop-up menu that allows you to change the chart type. See Chart typesGraph Types.
Hide/show legend
Toggles display of the legend.
...
| Anchor | ||||
|---|---|---|---|---|
|
New Scenario
Creates a new, empty scenario. Synonym for both and New Scenario on the Project Explorer toolbar. Projects and scenarios - Scenarios.
Open Project
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 | ||||
|---|---|---|---|---|
|
...
Fits the entire model horizontally and vertically in the geographic view.
| Anchor | ||||
|---|---|---|---|---|
|
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 | ||||
|---|---|---|---|---|
|
...
Zooms the map to fit the entire model horizontally and vertically in the map view.
| Anchor | ||||
|---|---|---|---|---|
|
Configure Ordering
A pop-up menu with two options:
- Network Costs… opens the Cost Functions modal dialog. Synonym for EditNetwork linear programming - Configuring optimisation.
...
Toggles whether the Project Explorer is visible on screen. Synonym for . See User Interface - Project Explorer.
Recording Manager
Toggles whether the Recording Manager is visible on screen. Synonym for . See Recording Manager.
Log Reporter
Toggles whether the Log Reporter is visible on screen. Synonym for . See Running Scenarios - Using the Log Reporter.
| Anchor | ||||
|---|---|---|---|---|
|
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:
- 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.
...
Removes the scenario that is selected in the Project Hierarchy. You are prompted to confirm the deletion. Deletions cannot be undone.
Recording Options
Allows you to change the state of all recordable parameters for the group or individual model element that is selected in the Project Hierarchy. The choices are:
- Record All - records all of the parameters at this level of the hierarchy and below when the model is run. The recorded results will be visible in the Results Manager; and
- Record None - records none of the parameters at this level of the hierarchy and below when the model is run.
See Running scenarios - Recording parameters.
...
Sorts the components of each scenario into alphabetical order according to the names of the components in your scenario.
View Type
This pop-up menu offers three choices:
- 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 | ||||
|---|---|---|---|---|
|
...
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 | ||||
|---|---|---|---|---|
|
Enable connecting link to a different node
Toggling on allows you to disconnect the end of a link from the node to which it is attached, and then re-connect that link to another node. You can use this feature to insert new nodes into a schematic without losing the configuration of existing links.
Straight Lines
Toggles the representation of links to straight lines from the default of orthogonal (elbow) line.
Note/Error icons
Toggles the view of any notes and/or errors that are present in the Schematic Editor.
Node Labels
Toggles view whether the names of nodes are shown in the Schematic Editor. Source defaults to displaying node names.
Link Labels
This button controls whether the names of links are shown in the Schematic Editor. Source defaults to displaying link names.
Track (Schematic Editor toolbar)
When enabled, the Schematic 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.
Overview Panel
Toggles the display of the Overview Panel in the Schematic Editor. The default state of this control is off. You can use the Overview Panel to obtain a thumbnail view of your entire schematic.
Pan
When enabled, clicking and holding on any part of the drawing surface in the Schematic Editor moves the entire drawing surface. This is an alternative to using the scrollbars.
Tool tips
A pop-up menu containing three options:
- Tool tips on - when selected, clicking on any component in the Schematic Editor causes a small floating window to appear which contains additional information about that component.
- Tool tips off - when selected, the floating windows do not appear.
- Tool tips locked - when selected, clicking any component in the Schematic Editor causes the small floating window to appear next to every node.
Show/hide water user and bulk licensing links
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.
Snap to Grid
Controls whether nodes are aligned with the underlying grid in the Schematic Editor.
Set Grid Size
The value in this field determines the frequency of grid lines in the Schematic Editor. The units are in pixels.
Opens the Print preview dialog allowing you to save the schematic in the Schematic Editor as a pdf. The entire schematic is scaled to fit on a single A4 page in portrait mode.
Save as Image
Saves the entire schematic in the Schematic Editor as a *.jpg.
Current zoom
Displays the zoom.
Zoom in
Zoom into the model in the Schematic Editor. Synonym for Ctrl +.
Zoom out
This button allows you to zoom out of the model in the Schematic Editor. Synonym for Ctrl -.
Fit to width
Fits the entire model horizontally in the Schematic Editor window.
Fit to window
Fits the entire model both horizontally and vertically in the Schematic Editor window.
| Anchor | ||||
|---|---|---|---|---|
|
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.
| Anchor | ||||
|---|---|---|---|---|
|
...
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 | ||||
|---|---|---|---|---|
|
This is a generic toolbar used specifically for management of text input. It is present in the Scenario Input Sets dialog and Function Editor.
...