Versions Compared

Key

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

Anchor
Main screen
Main screen
Main screen

...

  • The main window can be maximised or minimised using controls at the right hand end of the title bar;
  • A menu bar with familiar FileView and Help menus. Additional menus direct you to more specific functions of Source; and
  • Toolbars providing point-and-click access to many commands.
Figure 1. User interface for Source 

The following toolbars (available from the main Source screen) allow you direct access to various sections of Source:

  • Data Sources toolbar - allows you to add and manage sources of data (time series or by linking to another scenario). You can edit or view this data once it has been loaded in the Data Sources Explorer;
  • File toolbar - allows you to create a new project, opening an existing project, and saving a project (and all the scenarios within that project);
  • Function manager toolbar - allows you to add and manage all functions and expressions in Source;
  • Ordering toolbar - provides quick access to ordering-related functions. The button on this toolbar reveals a pop-up menu;
  • Project toolbar - allows you to toggle view of the Project ExplorerRecording ManagerLog Reporter and Chart Recording Manager;
  • Recording Manager toolbar - allows you to manage results in the Recording Manager;
  • Scenario toolbar - allows you to hide or display the Geographic EditorSchematic Editor and Tabular Editor, the Function ManagerData Sources, the Node Palette, the Layer Manager and Location Control panels; and
  • Simulation toolbar - allows you to set the analysis type (single, stochastic or flow calibration), specify start and end dates for the simulation, and to run the catchment model.
 


Quitting Source

You can quit Source by doing either of the following:

...

If you have not saved your project previously, choose File » Save As and you will be prompted to name your project. Source uses the Windows file extension ".rsproj" to identify its project files.  


Editors

Source uses editors which are tailored to the needs of the main scenario types. There are three main editors, known as the Geographic, Schematic and Tabular editors, which support the catchments, management and operations scenario types respectively. These editor-scenario type associations are not absolute and you will often use multiple editors within a given project. For example, you can use the Schematic Editor to define the model of a river system for both operations and management scenario types. Details for each of these editors are available at Geographic EditorSchematic Editor and Tabular Editor. You can also view scenarios on a background map image using the Map tab.

...

To change which parameters are recorded, first select an element in either the Project Hierarchy or Model Parameters area, then use either the Recording Options pop-up menu on the Project Explorer toolbar, or the contextual menu to change the setting. Note that these commands are hierarchical in nature and affect both the selected element and its logical children as displayed in the visual hierarchy. You can also define a set of default recording options to be applied to all of your projects. See Recording Manager defaults.

Data Sources

The Data Sources tab allows you to view

Data Sources

The Data Sources tab allows you to view and manage time series at one location in Source. When time series are added using the Data Sources Explorer, they are available for use throughout Source. For more details on using this, refer to Specifying data inputs.

Function Manager

The Function manager panel allows you to create, manage and maintain all functions and expressions defined in Source. Just as all data in the Data Sources Explorer is available throughout Source, all functions and expressions added in the Function manager can be used in the same way.

...

Chart Recording allows you to compare the results of different scenario runs. You can change certain parameters in a scenario to see how the output is affected. Refer to Chart Recording Manager for more information on this.

...

Just as with standard Microsoft applications, you can adjust panels within the Source window. This provides great flexibility when working with very large models. Refer to Main Application Window for details.

Anchor
FeatureEditor
FeatureEditor
About feature editors

...

Many feature editors support loading parameter information from a file. Where present, the Import... button can be used to load parameters into a feature editor whereas the corresponding Export... button will save the table’s current values to an external file. Additionally, as an alternative to entering or importing discrete parameter settings, the feature editors for many nodes allow for the node’s behaviour to be defined via an arithmetic expression or , known in Source as a function (refer to Functions).

...

Figure 7. Notes, Overview

Image Modified 

If a note can be added to an item, when you right-click on the item the option Add Note will be available from the context menu, refer to Adding notes to nodes and links. The exception is adding notes to a function, which is done using the Add/Edit Note icon in the Function Editor toolbar, see Adding a note to a function

A summary of all the notes configured in a scenario can be viewed using View » Notes. For the example shown in Figure 8, the First inflow andDam nodes, the $AllocGS function and the Default Link #1 link have notes associated with them.

...

Once a scenario containing notes has been run, the notes are listed in the log reporter with a message type of Note. Also listed is the notification level, the name of the associated item (eg. Inflow 1) and the text message. Furthermore, the Schematic Editor shows all the nodes and links that have notes configured on them. Figure 9 shows two nodes with informational notes, one with a warning note, and one error note. 

...

  • You should always include an explicit origin of (0,0). This avoids the need for the model to extrapolate in the negative direction along the X-axis. It also avoids any potential problems which might arise if the model silently assumes an origin of (0,0);
  • X-values should always be in monotonically increasing order. In the current implementation, an X-value that is entered out of order is highlighted in red until a Y-value is entered, after which Source re-orders the table. You can use this feature to add interstitial coordinates to a table by adding new (X,Y) coordinates to the last row and waiting for the table to re-order;
  • Y-values should also increase monotonically. Be cautious if you need to violate this guideline, and especially cautious if the right-most line segment has a negative slope;
  • The right-most coordinate pair should lie beyond your most extreme known value. This avoids the need for the model to extrapolate in the positive direction along the X-axis, and also means that you do not need to remember which piecewise linear editors use linear extrapolation of the right-most line segment vs those which project the right-most Y-value to infinity;
  • All values should be sensible. For example, there is no point in entering coordinate-pairs that violate mass balance (eg. a loss exceeding inflows); and
  • If your model employs optimised ordering, keep your piecewise linear editors to as few data-points as possible. Complex curves usually increase run-time and can sometimes lead to infeasible solutions. Refer to the chapter on Ordering.

Anchor
Working with date pickers
Working with date pickers
Working with date-pickers

...

Selecting a date, pressing return, or clicking outside of the calendar’s confines closes the calendar.

Dockable windows

Many Source windows can be docked within the main window, or arranged independently, depending on your project or scenario requirements. For example, if you have a very large node-link network, you can separate the Schematic Editor panel from the main Source window, thus providing a better view of the entire network. This section explains how to you can customise views of the Source main screen.

The dockable windows include the Geographic, Schematic and Tabular editors, the Map tab, most of the auxiliary windows, and windows belonging to some plugins. The docking and undocking action sticks with a project and scenario when it is saved. If the Schematic Editor is not docked, and a project is saved and closed, when it is re-opened, the Schematic Editor will be in the same position it was when the project was closed. The same applies if Source is closed and re-opened.

Undocking windows

The default position of dockable windows is docked. A single click within the borders of any docked window will activate it. An active window can be identified from either its title bar or from an element within it that is highlighted. For example, the Project Explorer is the active docked window in Figure 1.

Figure 10. Identifying active windows

Image Added

The windows of some tools may be docked in the main window.

Windows can be reset with View » Reset All Windows

HotKeys

A keyboard shortcut, also known as the hotkey, is a series of one or several keys to provide an alternate way to do something without a mouse. 

In Source, some hotkeys, which are specified only for the user interface of Results Manager, are described in Results Manager-HotKeys.

In other user interfaces of Source, hotkeys are also developed, commonly in three types, to activate the task without a mouse:

(a)Directly use the hotkey after menu items such as Ctrl+F (that is the same as clicking on the menu Tools » Find Node/Link) to find a specific node/link, F5 (that is the same as the menu Run » Run) to run the model for the single analysis. This type of hotkeys on the main interface are listed in Table 1.

TABLE 1 HotKey list for the main Interface


ActionShortcut     Full Description

New >>Scenario

Ctrl+N

Opens the Create a Scenario dialog to add a new, empty scenario to the current project.  

Open

Ctrl+O

Opens an existing project using the standard open file dialog.

Save

Ctrl+S

Saves the current project, overwriting the existing file.

Print

Ctrl+P

This command is currently disabled.

Exit

Alt+F4

Quits Source.

View>>Results Manager

F10

Opens the Results Manager window 

Configuration

F6

Opens a configuration window 

Run

F5

Performs the selected analysis such as running the model for the single analysis

Tools>>Find Node/Link

Ctrl+F

Opens the Find dialog where the user can search for nodes and links in the current open scenario.


(b)Using the Alt key to trigger or navigate the tasks from the menu items on the user interface:

  • Hold the Alt key to explore which letter has the underscore, such as View from the main Interface, and then press that letter (e.g. V) until the task is triggered. For example, Alt+V+R is to open the user interface of Results Manager. This action is the same as clicking on the menu View » Results Manager or direct use of a hotkey F10.
  • Hold the Alt key to explore which letter has the underscore, such as Edit from the main Interface, and then press that letter (e.g. E) until the task item (e.g. Trade Manger) is displayed, but the task item is without any underscore letter or with an underscore letter  (e.g.  ALT+E+P) used in multiple tasks. The user needs to release the Alt key, move the cursor (by the arrow keys) to the task item and press the Enter key to trigger the task.