Note: This is documentation for version 5.10 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above
User Interface
Main screen
Once open, you can see that Source follows the user interface conventions of a standard Microsoft Windows™ application (as shown in Figure 1. For example:
The main window can be maximised or minimised using controls at the right hand end of the title bar;
A menu bar with familiar File, View 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 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 Explorer, Recording Manager, Log 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 Editor, Schematic Editor and Tabular Editor, the Function Manager, Data 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:
Choose File » Exit...; or
Press Alt+F4 on your keyboard.
Projects and scenarios
Projects act as 'wrappers' holding a collection of one or more scenarios. Refer to Projects and scenarios for more information.
Saving your work
Save your work by doing either of the following:
Choose File » Save;
Click Save Project on the File toolbar.
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 Editor, Schematic Editor and Tabular Editor. You can also view scenarios on a background map image using the Map tab.
Components of the main screen
Project Explorer
The Project Explorer (Figure 2) allows you to manage model components using a combination of the menu bar, the Project Hierarchy, the Model Parameters area, and pop-up menus. For an active scenario, clicking an item in the Schematic or Geographic Editor highlights it in the Project Hierarchy.
Figure 2. Project Explorer
Project Hierarchy
The Project Hierarchy displays a structural breakdown of the project. The type of display will depend on the view selected within the View Type pop-up menu on the Project Explorer toolbar. All view options will display at least the project and scenarios within the project. The Default View, which is shown on the left side in Figure 3, displays individual elements that make up a model. The Parameter View displays all the recordable parameters for the model. The Geographic View displays elements of the geographic scenario.
Using the contextual menu (as shown in Figure 2), for a selected node/link, you can set parameter recording, edit and rename it.
Figure 3. View type menu options
Model parameters
The Model Parameters area (refer to Figure 2) shows which parameters will be recorded for the scenario element (node, link, catchment etc) that is currently highlighted in the Project Hierarchy. The indicators have the following meanings:
Every parameter at this level and below will be recorded; or
No parameters at this level and below will be recorded.
Some (but not all) parameters at this level and below will be recorded.
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.
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 defined in Source. Just as all data in the Data Sources Explorer is available throughout Source, all functions added in the Function manager can be used in the same way.
Node Palette
The Node Palette contains a list of icons representing the nodes that are supported by Source. To create a node-link network, drag icons from this palette onto the Schematic Editor’s drawing surface.
Layer Manager
The Layer Manager (Figure 4) is mainly associated with the Geographic Editor. It is visible by default when you create a new catchments scenario. Choose View » Layer Manager if the Layer Manager is not visible. You can add new layers, and move layers up and down in order of visibility. The checkbox next to a layer’s name indicates that the layer is visible in the Geographic Editor. Note that any layers that are added or removed are not persisted in the scenario.
Figure 4. Layer manager
Recording Manager
The Recording Manager displays a list of all the recorded results from the model run or runs. Each model run has its own tab. You can sort the results by clicking the column headings. The associated with this window gives quick access to common functions.
Log Reporter
The Log Reporter displays any errors, warnings or information messages resulting from user actions, or events that have occurred when running a scenario. You can choose to display or hide different types of events by clicking the Errors, Warnings, or Info tabs at the bottom of the Log Reporter.
Chart Recording
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.
Working with the Source window
Just as with standard Microsoft applications, you can adjust panels within the Source window. This provides great flexibility when working with very large models.
About feature editors
A feature editor window allows you to define various parameters for nodes and links. It opens when you double click on components in the Schematic Editor. You can also open a feature editor by right-clicking on the node or link and choosing Edit from the contextual menu.
Each node or link type supports different parameters, so the exact structure of feature editors varies according to the type of node or link being manipulated. However, the controls shown in Figure 5 are common to many feature editors.
The left panel lists all parameters associated with the node or link. You can also add a note to a node or link to indicate a specific feature for example, which may affect its behaviour during a scenario run. This note is indicated as an exclamation mark on the component's icon in the Schematic Editor. It also appears in the Recording Manager after a scenario run. To include a note, right click on the component's icon in the feature editor and choose Add Note. This is shown in Figure 7.
Contextual menus can be accessed by right-clicking on various elements in the user interface. In some cases, choices in contextual menus duplicate those in toolbars and the main menu structure. In others, the contextual menus are the only way to access a particular function. All contextual menus available in Source are shown with the relevant feature editor or graphic;