Introduction
A Source scenario must be run in order to produce any useful information. Each scenario run produces a collection of result sets. A result set is a group of related outputs, usually from the same component and is usually, but not always, arranged as a time series.
During a run, each component in the scenario can produce one or more result sets in the form of predicted water flows, volumes and other outputs specific to that component. Some components are capable of producing more than 20 separate result sets. When ownership is not enabled, the model starts at the first node then progresses down the river system in a single pass to compute the water volume and flow rates through each node and link.
| Anchor | ||||
|---|---|---|---|---|
|
When you run a scenario, every node and link produces produce results in the form of predicted water flows, volumes and other data outputs. To view or save these model outputs after the run, you need to select them to record before you run. When you save a project , or make a copy of a scenario, Source automatically saves the list of model outputs selected for recording. There are two ways to select which parameters and model elements to record, using the Project Hierarchy to select model parameters at the component level (eg. links, nodes), or more fine-grained parameter-level control in the Parameter pane.
| Info | ||
|---|---|---|
| ||
Before running the scenario, give consideration to the required output and only record the parameters of interest. Some node or link types can produce more than 20 separate data outputs (eg. storages). In general, the more outputs you record, the longer the simulation will take, though this depends on exactly what you record; recording mass - balance is more computationally intensive than recording inflow, for example |
Component-level controls
For a given scenario run, you can select which outputs will be recorded using the component's contextual menu or the Record icon in the Project Explorer toolbar:
- Using the Project Explorer, right-click a group or individual model element (eg. node, link, function or other element) in the Project Hierarchy (Figure 6). From the contextual menu, select:
Record All – every parameter at this level and below will be recorded;
If the indicator appears as- Restore the model parameters for a component to their default value - choose Set to Recording Defaults.
- If you select a model element component on the Geographic Editor or Schematic Editor (eg a catchment outlet), then the chosen model element component is highlighted in the Project Hierarchy. Right-click the element name component's name and select the recording status from the contextual menu, or click the Record icon in the Project Explorer toolbar.
- By clicking
button above Project Explorer, this will display the long description area under Parameter window. To get a long description to appear in the long description area, a recorder must be selected in the Parameter window. Hovering over a recorder in the Parameter window will present the long description if there is one.
| Info | ||
|---|---|---|
| ||
Note: Model elements that are not nodes or links are grouped under Miscellaneous. For example, you can record functions and data sources here. |
Figure 6. Selecting recording parametersparameters
Parameter-level controls
For fine-grained control of individual recordable parameters (Figure 7):
- Select the component group or model element within the Project Hierarchy. Selection causes all of the component’s parameters group's or element’s parameters to be displayed in the Parameters area; and
- Use the contextual menu to enable or disable individual parameters or parameter groups, or to restore parameters to their default settings..
Figure 7. Selecting model parameters
| Info | ||
|---|---|---|
| ||
| Note: The contextual menus shown in Figures 6 and 7 can be applied at any point within their respective hierarchical displays. If you select an individual component or parametermodel element, the effect will be limited to just that element. Applying a recording choice at an aggregate level to a group propagates the effect to the selected element and all elements grouped below it in the hierarchy. For example, to record only Downstream Flow for all straight-through routing links, you would select Link » Straight-Through Routing and choose Record None (Figure 6), and then select Downstream Flow in the Parameter pane and selectRecord All (Figure 7). |
| Anchor | ||||
|---|---|---|---|---|
|
If a scenario run results in errors or warnings, the first indication of those is displayed in the Run completion dialog dialogue by a red or yellow icon next to the Close
button as indicated in Figure 7.Jira Legacy showSummary false server System JIRA serverId a22b5711-2728-3bcc-860f-2832d905a432 key SD-548
Figure 7. Running scenario (error)
You can investigate the causes of errors or warnings using the Log reporter (Figure 8). If the Log Reporter window is not visible, do either or both of the following:
- Choose to make it visible; and/or
- Make the Log Reporter active by clicking the Log Reporter tab.
Once the Log Reporter is active, you can view all the logs run by Source, from configuring a scenario to running it. You can clear the log or export its contents to a .csv file using the contextual menu (as shown in Figure 8). Table 1 provides a description of each of the columns in the Log Reporter.
Figure 8. Log Reporter
Table 1. Log Reporter, Columns
| Column | Description |
|---|---|
| Date | The local date on the computer. |
| Run | The run number. You can also filter messages based on this number - use the filtering icon. |
| Level | The notification level associated with the message - informational, which can be one of information, warning, error . See or fatal. The messages are classified according to the way in which they were generated (see Message Type). |
| Time Step | The scenario time-step which the message refers to. |
| Name | Name of the node or link corresponding to the message. |
| Model Type | These are the node and link types – ie. Inflow, Straight Through Routing |
| Message | Details of the message. |
| Message Type | There are three types available:
|
| Anchor | ||||
|---|---|---|---|---|
|
During a scenario run, components of the scenario are run in a particular order to ensure that they comply with in-built inbuilt Simulation phases and execution order rules.
| Info | ||
|---|---|---|
| ||
| Note: The execution order is based on leaf node names alphabetically. Thus, renaming a node can change the order. |
You can modify the execution order for a scenario as follows:
Choose Edit » Execution Order Rules... to open theExecution
Order Rules dialog (shown in Figure 9);Rules can also be enabled or disabled using the checkboxes.
Figure 9. Execution order rules
Once you have specified the execution order rules, you view them in one of two ways:
- Use the Execution Order tab (shown in Figure 9). Click Refresh to update the view after changes are made in the Rules tab; or
- Choose View » Execution Order... to open the Execution Order dialog (similar to Figure 10). While open, this dialog gets updated when changes are made to the scenario in the main Editor window.
Figure 10. Execution order
order rules are now available in Scenario Options: Execution Order Rules
| Anchor | ||||
|---|---|---|---|---|
|
| Info | ||
|---|---|---|
| ||
| Note: Results of a scenario run can be viewed in the Recording manager Results Manager or using the Results Recording Manager - obsolete. |
Each scenario run creates a Once run, every scenario generates a result set – a distinct collection of result sets. Each collection is represented by a tab in the Recording Manager. The name of each tab is formed by concatenating the name of the scenario with a time-stamp indicating when the scenario was run. For example, Figure 11 shows that "Scenario 1" has been run twice at slightly different times.
Figure 11. Recording Manager
You can use the tools on the Recording Manager toolbar to save a collection of results to a file, export a collection to Microsoft Excel, or delete the currently-selected collection.
Within each of the Recording Manager’s tabs, results are arranged in four columns:
- Type - Source generic name for node or link (eg Inflow);
- Name - your name for that component;
- Attribute - the name of the output parameter as listed in Parameters (eg Additional Inflow); and
- Values - a link which can be clicked to view a graphical representation of the output parameter.
You can navigate through a list of results using the vertical scroll bar. In addition, clicking on a link or node in the Schematic Editor, Geographic Editor or Project Hierarchy automatically selects all of the result sets associated with that component in the Recording Manager.
Right clicking in the Recording Manager, then choosing Save Selected allows you to export the selected time series data as a .csv file. Choosing View Selected opens the Charting Tool for the selected time series data.
One of the key uses of the Recording Manager is to select one or more result sets (rows in the Recording Manager) for display in the Charting Tool. The Charting Tool helps you visualise, analyse and understand scenario results and other data produced by Source. Each time you click a link in the Values column, a copy of the Charting Tool opens to display that result set. Clicking the same link multiple times opens additional copies of the Charting Tool containing the same result set.
You can also use the Chart Recording Manager to view and manage result sets. Refer to Chart Recording Manager for more information.
When constraints are enforced, there may be a difference between the amount of water ordered and that released. The application of constraints is evident at both the supply point and minimum flow requirement nodes.
To discover where constraints have been applied:
- Run the model;
- Select an appropriate supply point or minimum flow requirement node. This selects all of the node’s recording parameters in the Recording Manager; and
- Inspect the Values column in the Recording Manager and click an Order Details link. This opens a Complex Time Series Form (Figure 12). The Graph tab provides a summary of the differences between the amount ordered and the amount released for the duration of the run. The Constraints column of the Table tab (Figure 13) provides a breakdown per time-step. Hover your mouse cursor over a cell of interest to see its contents presented in a tool tip.
Figure 12. Complex time series (Orders vs Releases, summary)
Figure 13. Complex time series (Orders vs Releases, detail)
results recorded for that run. Scenario results can be examined and analysed using the Results Manager, which opens when a run completes. Within Results Manager, results can be evaluated graphically in charts, numerically in tables or as statistics, and they can also be filtered and manipulated using transforms. With custom charts, you can also view and statistically analyse multiple results within and between runs, compare results to external data sources and automatically update with the latest results each time a model is run. See Results Manager for more information.
In Results Manager, result sets are listed in the tree menu on the left side. The name of scenario's result set is formed by concatenating the run number from the current session with the name of the scenario. If there are errors or warnings from your run, these are indicated by an appropriate symbol next to the result set's name (see notification level), and are also listed in the Log Reporter (see Using the Log Reporter). For example, Figure 11 shows that in this Source session, Stage C was run first, and had warning(s) associated with it, Stage B was run next and had a fatal error that stopped the run from completing, and Stage A was run third without any warnings or errors.