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 dialoguesdialogs. | 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 dialogue 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 dialogue 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 dialoguedialog. 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 dialogue 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 buttons on the Schematic Editor and Geographic Editor toolbars may be used to print scenarios.
...
This command is currently disabled. However, the Print buttons Print buttons on the Schematic Editor and Geographic Editor toolbars may be used to print scenarios. Clicking that button also provides a preview.
...
Opens the Import Scenario dialogue dialog where you can import scenarios from different projects. See Importing Scenarios 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 Constituents Configuration dialogue dialog where you can define constituents. See Constituents - Configuring constitutentsconstituents.
Opens the Edit Scenario Configuration – Name Functional Units dialogue where dialog where you can inspect the list of existing functional units. You can also use this dialogue dialog to add new functional units or delete functional units that are no longer required. This dialogue 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 dialogue where dialog where you can associate sub-catchments with functional units using a raster. This dialogue dialog is only available when a catchments scenario is active. See See Functional units - Using a raster.
Edit » Functional Units » Assign Area
...
Manually…
Opens the Functional Unit Area Configuration dialogue where dialog where you can manually associate sub-catchments with functional units. This dialogue dialog is only available when a catchments scenario is active. See Functional units - Manual assignment.
Opens the Edit Scenario Configuration – Catchment Model Assignment (optional) dialogue dialog where you can assign constituent models at the whole catchment level. This dialogue dialog is only available when a catchments scenario is active, and also requires a plugin.
Opens the Restriction Curves Explorer dialogue dialog where you can edit restriction curves. See Restriction Curves.
Opens the Scenario Options dialogue dialog where you can set preferences that affect the selected scenario. The following options are available:
- Assurance Rules – Rules – configure the notification levels of assurance rules, which provide optional checks of models, see Assurance Rules;
- Custom Running Configurations – ***Default Node Rotation – Configurations – create one or more user-defined configurations for each run analysis type (eg. single analysis, flow calibration analysis);
- Default Node Rotation – configure the default rotations of nodes. Any nodes subsequently added to the schematic editor will have the new default direction;
- Execution Order Rules – Rules – ***Ordering Algorithm –
- Mass Balance - Set the tolerance limit for the Mass Balance assurance rule.
- Ordering Algorithm – select between using rules based ordering or network linear programming, and configure network linear programming;
- Performance – Performance – enable/disable parallel processing of catchments and/or water user orders;
- Projection – Projection – convert projected layers from the geographic view to latitude and longitudinal coordinates for the map view;
- Rules Based Ordering – Ordering – disable/enable calculation of ordering, constraints or off-allocation for network components;
- Ordering Priorities – ***
- Tabular Formatting Settings – configure display of cell values in Tabular Editor
- Wetlands – configure convergence criteria for the wetland algorithm.
- Priorities – Specify how shortfalls are prioritised between different demands in the scenario;
- Storages – choose the storage processing method used in the scenario, see Storage node - Storage processing method;
- Tabular Formatting Settings – configure display of cell values in the Tabular Editor; and
- Wetlands – configure convergence criteria for the wetland algorithm.
See Scenario Options.
Opens the Project Options dialogue dialog where you can set preferences that affect the open project. The following options are available:
...
See Project Options.
Edit » Ownership... Ownership…
Opens the Ownership Setup dialogue dialog where you can manage ownership in a scenario. See Ownership.
Edit »
...
Resource Assessment…
Opens the Resource Assessment Explorer dialogue dialog where you can manage for Annual configure Annual Accounting, Continuous Accounting and Continuous Sharing. This dialogue dialog is only available when a schematic scenario is active. See Resource assessment.
Edit » Ordering »
...
Network Costs…
Opens the Cost Functions dialogue 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 dialogue dialog where you can configure crops for use at the water user node. See Configuring generic crop settings.
Opens the Function Editor dialogue dialog where you can edit functions. See Functions - Function Editor.
Opens the Link Cross Sections dialogue dialog where you can assign a physical cross-section for generating link rating curves. See Cross Section Editor
Opens the Constituent Model Configuration dialogue where dialog where you can assign and work with constituent generation and constituent filter models. This dialogue is only available when a catchments scenario is active.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 dialogue dialog where you can assign and work with rainfall runoff models. This dialogue dialog is only available when a catchments scenario is active. See Rainfall runoff models.
Opens the Demand Constraints dialogue dialog where you can view all configured demand constraints. See Water user node - Demand constraints.
Opens the Feature Table dialogue where dialog where you view parameters for each of the configured nodes in the scenario. See Feature Table.
Opens the Scenairo Scenario Input Sets dialogue dialog where you can create and manage scenario input sets and input parameter sets. See Scenario Input Sets.
| Anchoranchor | ||||
|---|---|---|---|---|
|
...
- 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 Function Manager is visible on screen. Synonym for Function Manager on the Scenario toolbar. See Functions - Function Manager.
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 Location Control is visible on screen. Synonym for Location Control on the Scenario toolbar. See Maps - Location Control.
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.
Opens the Audit Logs Viewer dialogue dialog. Right-click on a cell to copy either the selected entries or all entries to the clipboard.
View »
...
Notes…
Opens the Notes dialogue dialog showing all 'post-it' type notes that have been added to nodes and links items (eg. nodes, links, function) in the current scenario. See User Interface - About Notes.
Opens the Results Manager window where you can view can examine and work with resultsanalyse results. See Results Manager.
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 Running scenarios Configuring Scenarios and Forecasting and Operations.
Run »
...
Run…
Performs the selected analysis. Synonym for Run on the Simulation toolbar. See Running scenariosConfiguring 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
Launches the calibration wizard for catchments. Synonym for clicking Configure on the Simulation toolbar (or choosing ) when analysis type is set to Flow calibration analysis. See Calibration Wizard for catchments.
Opens the recordable element selection step of the calibration wizard for catchments. This panel should be treated as read-only. See See Calibration Wizard for catchments - Select elements to record.
Opens the period definition step of the calibration wizard for catchments. This panel should be treated as read-only. See See Calibration Wizard for catchments - Define calibration period.
Opens the metaparameter definition step of the calibration wizard for catchments. This panel should be treated as read-only. See See Calibration Wizard for catchments - Defining metaparameters.
Opens the optimisation function configuration step of the calibration wizard for catchments. This panel should be treated as read-only. See Calibration Wizard for catchments - Configure optimisation functions.
Tools » Calibration » Result
Opens the optimisation results window. This window is populated by a run of the calibration wizard for catchments. See Calibration wizard for catchments - Inspecting calibration results.
Opens the Test runner window where you can run a regression test. See Regression testing - Running regression tests.
Tools » Regression Tests » Test Builder
Opens the Test Builder window where you can create a regression test. See Regression testing - Building regression tests.
Tools » Data Calculator Tool
Opens the Data Calculator window, where you can perform mathematical, statistical and reflected operations on raster or time series data. See Analysis tools - Data calculator.
Opens the Data Modification Tool window, where you can edit raster or time series data depending on conditional statements that you can define. See Analysis tools - Data modification tool.
Opens the Find dialogue 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.
...
Allows access to some of the plugins added using the Plugin Manager. See Plugins.
Tools » Plugin Manager
Opens the Plugin Manager dialogue dialog that allows you to add and remove plugins in Source. To add or edit plugins you need to close any open Source project. See Plugins - Working with the Plugin Manager.
Tools » Application
...
Settings…
Opens the Application Settings dialoguedialog. See Application settings.
Tools » River
...
Operations…
Opens the River Operations dialogue dialog where you can manage forecasting for a scenario. See Forecasting and Operations.
Opens the Function Execution Order dialogue dialog showing the order in which functions are evaluated for each time of evaluation. See Functions - Debugging.
Turns on the Recording Manager.
Opens the Source Project Diff Tool window where you can find the differences between two scenarios. See Scenario Difference Tool.
Allows you to save scenario configuration details to a *.csv file.
...
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 Support page.
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 eWater support site (Uservoice).
Opens the Source splash screen (synonymous to opening Source for the first time).
Launches your page Australian Modelling Practice
Launches your browser with a URL to the eWater websitesupport site (Uservoice).
...
Help »
...
Splash Screen
Opens the Source splash screen (synonymous to opening Source for the first time).
Launches your browser with a URL to the eWater website.
Opens the Toolkit login dialog where you enter your login credentials.
...
Opens a window containing product and license information.
Results Manager Menu Bar
| Anchor | ||||
|---|---|---|---|---|
|
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 in to 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. SeeResults Manager - Loading Results.
Loads any time series file type compatible with Source into Results Manager (refer to a complete list in of Data file formats). Multiple files can be selected and imported at once. Synonym for Load a times series on the Results Manager toolbar, and Ctrl+O. See Loading Results Manager - Loading Results.
Saves the current configuration of Results Manager to a configuration file (*.dora). Synonym for Save configuration on the Results Manager toolbar, and Ctrl+S. See Results Manager - Configurations.
Loads a previously saved configuration file 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 the Hot Key Window, which lists keyboard shortcuts and what they do in Results Manager. See Results Manager - Hot keys
Opens a dialogue dialog containing product and license information information
Toolbars
Toolbars in the main window offer shortcuts to their equivalent menu commands.
| Anchor | ||||
|---|---|---|---|---|
|
...
12. Chart toolbar (Charts - Chart toolbar)
See Chart toolbar for more detailed information on using the buttons and pop-up menus shown in Figure 9.
Drag (Shift)
When selected, allows you to drag a result from one chart onto another chart.
...
Zoom Control
A pop-up menu affecting the zooming behaviour of Lasso Zoom.
...
A pop-up menu that allows you to change the chart type. See Chart typesGraph Types.
Hide/show legend
Toggles display of the legend.
...
Edit graph properties
Opens the Chart Settings dialogue dialog where various chart properties can be configured (eg. line colour, font size). See Charts - Chart settings.
Save
A pop-up menu offering a number of ways in which chart data can be exported.where you can save the chart as an image (*.png file), as a data file (*.res.csv format), or as a full vector graphic (*.xps format).
Copy to clipboard
Exports the chart to the clipboard, in a vector format compatible with Microsoft Word.
Opens the print dialogue 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...Source…) or a time-series file (File Data Source...Source…).
New Folder
Creates a new folder
...
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
...
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 (by menu) 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 | ||||
|---|---|---|---|---|
|
...
16. Function editor toolbar (Functions - Function Editor)
This comprises of the text management toolbar, suffixed by additional icons.
Add/Edit Note
Allows you to add a new note, or edit an existing one for the function. See User Interface - About notes.
Insert keyword built-in function (Ctrl+Space)
Inserts a keyword into the 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.
...
Collapses all items in the function tree.
Edit functions...functions…
Opens the Function Editor.
...
Opens the Function Editor and displays the function evaluation tree for the selected function. This button is only enabled when a function is selected in the function tree. See Functions - Usages and References.
Show all function and variable usages
Displays the usages of all function and variables in the function tree. See Usages and References.
| Anchor | ||||
|---|---|---|---|---|
|
18. Geographic editor toolbar (Geographic Editor)
Save as image (Geographic Editor toolbar)
Saves the section of the schematic that is currently visible in the Geographic Editor as a *.jpg.
Print (Geographic Editor toolbar)
Opens the Print preview dialogue dialog allowing you to save the section of the schematic that is currently visible in the Geographic editor as a pdf.
Track (Geographic Editor toolbar)Save as image
Saves the section of the schematic that is currently visible in the Geographic Editor as a *.jpg.
Track
When enabled, the Geographic 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.
Note/Error icons (Geographic Editor toolbar)icons
Toggles the view of any notes and/or errors that are present in the Geographic Editor.
...
See User Interface - About notes.
Node labels
Toggles the view of node names in the Geographic Editor.
Link labels (Geographic Editor toolbar)Link labels
Toggles the view of link names in the Geographic Editor.
Current zoom (Geographic Editor display toolbar)
Displays the current zoom.
Zoom in (Geographic Editor display toolbar)
Zooms in on the model in the Geographic Editor.
Zoom out (Geographic Editor display toolbar)
Zooms out on the model in the Geographic Editor.
Fit to window (Geographic Editor display toolbar)
Fits the entire model horizontally and vertically in the Geographic Editorthe geographic view.
| Anchor | ||||
|---|---|---|---|---|
|
19. Scenario Input Sets toolbar (Scenario Input sets)
This comprises of the text management toolbar suffixed with additional icons.
Insert scenario base nodes
...
Apply values to scenario immediately
Overrides the input data source with the specified value in the Scenario Input Set editor.
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 (
Main screenUser Interface - Layer Manager)
Add layer
Allows the addition of 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.
...
Shows a combined map and satellite combined image with nodes overlaid.
Fit to window
Zooms the map to allow a single view of all nodesfit the entire model horizontally and vertically in the map view.
| Anchor | ||||
|---|---|---|---|---|
|
...
22. Ordering toolbar
...
Configure Ordering
A pop-up menu with two options:
- Algorithm... Network Costs… opens the Configure Ordering Algorithm Cost Functions modal dialoguedialog. Synonym for Edit » Ordering » Algorithm...Network Costs... opens the Cost Functions modal dialogue. 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.
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 .
Chart Recording Manager
Toggles whether the Chart Recorder is visible on screen. Synonym for . See Running Scenarios - Using the Log Reporter.
| Anchor | ||||
|---|---|---|---|---|
|
...
24. Project Explorer toolbar (User Interface - Project Explorer)
New Scenario (by menu)
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.
Copy Scenario
Makes a copy of (clones) the scenario that is selected in the Project Hierarchy. You are prompted to select a new name for the copied scenario. The new scenario will be a duplicate of the original at the time of the copy. All scenario names must be unique. See Projects and scenarios - Copying a scenario.
Delete Scenario
Removes the scenario that is selected in the Project Hierarchy. You are prompted to confirm the deletion. Deletions cannot be undone.
...
- 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.
Sort Categorised
Sorts the components of each scenario according to the type of component (eg. all links sort together, all nodes sort together, etc) and, within each component grouping, according to component sub-type subtype (eg. all Inflow nodes sort together).
...
- Parameter View which changes the Project Hierarchy so that it is classified according to the kind of recordable parameter;
- Geographic Defaults view, which is not relevant to Source; andSchematic Defaults view or Schematics Defaults, which changes the Project Hierarchy Project Hierarchy so that it is classified is classified according to the kind of recordable component.
| Anchor |
|---|
...
|
...
|
...
25.
...
Quick View toolbar (
...
Charts - Quick View toolbar)
Save Run Results
...
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 | ||||
|---|---|---|---|---|
|
Save Run Results
Exports time-series data from the currently-selected run to either a * .csv or tab-separated-value file.
Open Run Results in Excel
...
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 View tabGeographic Editor tab. Synonym for View » Chart Recording Manager» Geographic Editor. See Geographic Editor.
Layer manager
Toggles the state of the Layer Manager window. Synonym for View Layer Manager. See User Interface - Layer Manager.
Map
Toggles the state of the Layer Manager windowMap tab. Synonym for View Layer Manager Map. See Maps.
Node palette
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.
Tabular Editor
Toggles the state of the Tabular Editor tab. Synonym for View Tabular Editor. See Tabular Editor.
Location Control
Toggles the state of the Location Control dockable window. Synonym for View Location Control. See Maps - Location Control.
Data Sources
Toggles the state of the Data Sources dockable window. Synonym for View Data Sources. See Specifying data inputs - Data Sources Explorer.
Function manager
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 the view of any notes and/or errors that are present in the the Schematic Editor.
Node Labels
Toggles view whether the names of nodes are shown in the Schematic Editor. Source defaults to displaying node names.
...
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 scroll barsscrollbars.
Tool tips
A pop-up menu containing three options:
...
Show/hide water user and bulk licensing nodeslinks
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.
...
The value in this field determines the frequency of grid lines in the Schematic Editor. The units are in pixels.
Print (Schematic Editor toolbar)
Opens the Print preview dialogue dialog allowing you to save the schematic in the Schematic Editor as a pdf. The entire schematic is scaled to fit within on a single A4 page in portrait mode.
Save as Image (Schematic Editor toolbar)Save as Image
Saves the entire schematic in the Schematic Editor as a *.jpg.
Current zoom (Schematic Editor toolbar)
Displays the zoom.
Zoom in (Schematic Editor toolbar)
Zoom into the model in the Schematic Editor. Synonym for Ctrl +.
Zoom out (Schematic Editor toolbar)
This button allows you to zoom out of the model in the Schematic Editor. Synonym for Ctrl -.
Fit to width (Schematic Editor display toolbar)
Fits the entire model horizontally in the Schematic Editor window.
Fit to window (Schematic Editor display toolbar)
...
Fits the entire model both horizontally and vertically in the Schematic Editor window.
| Anchor | ||||
|---|---|---|---|---|
|
...
29. Simulation toolbar (Running a scenario)
...
Monthly
Shows the statistics for each month of the year in the period run.
Yearly
Shows the statistics for each year in the period run.
Month by Year
Shows the individual statistics for every month of every year in the period run.
Total
Provides statistical data for the entire period run.
Full
Shows statistics for all data in the chart.
Windowed
Shows statistics for a specified range in the chart.
...
This is a generic toolbar used specifically for management of text input. It is present in the Scenario Input Sets dialogue and Function Editor.
Open
Opens an existing text file from your specified location on the computer.
Save
Saves the text to your computer as a text file.
Cut
Cuts the selected text and places it in your computer's clipboard
Copy
Copies the selected text to your computer's clipboard.
Paste
Pastes the selected text. Enabled after either a Cut or Copy.
Delete
Deletes the selected text.
Undo
Undoes the previous action.
Redo
Enabled after the Undo action. Re-does the Undo action.
Word wrap
Wraps the text in the main panel to make it entirely visible on a single screen.
Show line numbers
Displays the line number in front of the line.
Show end of line
Displays an end of line character.
Toolbars in the Results Manager
...
Load previous run results
Loads results of previously saved scenario run.
Load time series
Loads a time series.
Go to
Allows you to search for a specific recorder in the tree menu.
Feedback
Opens an online form to provide feedback for new Results Manager functionality.
Hot keys
Opens the hot key window.
Transforms
...
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.
Yearly
Shows the statistics for each year in the period run.
Month by Year
Shows the individual statistics for every month of every year in the period run.
Total
Provides statistical data for the entire period run.
Full
Shows statistics for all data in the chart.
Windowed
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.
Open
Opens an existing text file from your specified location on the computer.
Save
Saves the text to your computer as a text file.
Cut
Cuts the selected text and places it in your computer's clipboard
Copy
Copies the selected text to your computer's clipboard.
Paste
Pastes the selected text. Enabled after either a Cut or Copy.
Delete
Deletes the selected text.
Undo
Undoes the previous action.
Redo
Enabled after the Undo action. Re-does the Undo action.
Word wrap
Wraps the text in the main panel to make it entirely visible on a single screen.
Show line numbers
Displays the line number in front of the line.
Show end of line
Displays an end of line character.
Toolbars in the Results Manager
| Anchor | ||||
|---|---|---|---|---|
|
Load a folder of Result Files (*.res.csv)
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 File » Load Results Files and Ctrl+R. See Results Manager - Loading Results.
Load a time series
Loads any time series file type compatible with Source into Results Manager (refer to complete list of Data file formats). Multiple files can be selected and imported at once. Synonym for File » Load times series and Ctrl+O. See Results Manager - Loading Results.
Save configuration
Saves the current configuration of Results Manager to a configuration file (*.dora). Synonym for File » Save Configuration and Ctrl+S. See Results Manager - Configurations.
Load configuration
Loads a previously saved configuration file (*.dora) into Results Manager. Synonym for File » Load Configuration and Ctrl+L. See Results Manager - Configurations.
Go to a result in the tree
Opens a text box where you can search the results in the currently active scenario using the wild card * to represent any character. See Results Manager - Searching for results.
Set up your data transforms
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:
- Percentile range;
- Number range;
- Inverter
- Repeating range; or
- Date range; or
- Aggregator
Remove transform
Deletes the selected transform
...