To run a scenario, do the following:

Select the recorded parameters (model outputs) of interest in the Project Hierarchy and Parameter pane. See below.
- Some model outputs are selected by default; these can be turned off by right-clicking on the Scenario's name and selecting Record None.

Click Select Analysis Type on the Simulation toolbar to set the appropriate type of analysis. Depending on the scenario, Source offers several options for analysing your model data, including:
- Flow calibration analysis, which calibrates a set of rainfall-runoff and flow routing model parameter values so that output from the model is representative of an observed data set;
- Run w/Warm Up, which seeds the model with the available historical data and prepares for forecasting. This is enabled in River Operations scenarios only;
- Single analysis, which simulates the river performance for a single set of conditions (as opposed to an iterative analysis which considers several possible outcomes); or
- Stochastic analysis, which is used to generate flow replicates from stochastically generated rainfall inputs when dealing with stochastic climate data. See also Incorporating uncertainty into climate variability.
- Replicate analysis, which is used to run the same Source model file with different time series inputs as separate replicates.
- Linked analysis, which is used to run scenarios linked by Scenario Transfer Node (STN).
Click Configure on the Simulation toolbar to select the required time frame for the scenario to run. The resulting window depends on the type of analysis you chose in the previous step.
If you chose:

Flow Calibration analysis, the Calibration Wizard opens. Refer to Calibration Wizard for catchments;
Run w/Warm Up, the Run w/Warm Up window opens when you run an Operations scenario;
Single analysis, the Single Analysis window opens (Figure 1). If constituents have been configured in the scenario, the Constituents tab will be enabled where you can choose to run constituents over a selected date range or over the entire time range (using the Restrict checkbox shown in Figure 2)
Stochastic analysis, the Stochastic Analysis Tool opens.
Replicate analysis, the Replicate Analysis Configuration window opens.
Linked analysis, the running linked analysis configuration window opens.

You can only configure a run time frame that is supported by the time spans in the time series associated with your scenario. A lowest-common-denominator approach is used. For example, if your project contains two time series where the first spans the period 1/1/1900 through 31/12/1990, and the second, the period 1/1/1960 through 21/12/2010, the available simulation time frame will be 1/1/1960 through 31/12/1990.

Figure 1 depicts a Single analysis configuration setting. It can be seen that different time steps ranging from one minute to annual are available from the 'Time Step' drop down list.

Figure 1. Configure single analysis

If the time step selected is hourly, then there is one additional drop down menu at the right side of both start and end date to indicate the start and end hours (Figure 2a). And if the time step selected is sub-hourly, for example six minutes, then there are two additional drop down menus available to indicate the start and end hours and minutes as in Figure 2b.

Figure 2. a) Two hourly time step b) Six minutes time step

Figure 3 shows the Constituent Configuration window.

Figure 3. Running constituents

Figure 4 shows the dialog when you configure a linked scenario (using a Connecting Models).

Figure 4. Running linked scenarios

Click Run on the Simulation toolbar to start the simulation run. A progress bar indicates running times during a scenario run (Figure 5).

Figure 5. Running scenario (progress bar)

Running configurations

A scenario can be customised to run using a combination of specifically assigned dates and Scenario Input Sets. This option is accessed through the Configuration Manager (Figure 6) or directly under Edit » Scenario Options. In Figure 7, the Single Analysis configuration is set to run for the dates 01/01/1981 - 31/12/2016 and will use values assigned through the HighDevelopment input set. A new configuration can be added with a customised name. In the Of type dropdown menu, first select the type of analysis to be run, e.g. 'Single analysis'. Then click the Add new configuration button. A new row appears at the bottom of the existing list of configurations. By default it is called Custom 1. To rename the configuration, double-click on the name and type in a chosen name. This new configuration option will appear in the configuration dropdown menu on the main Source toolbar. The Scenario Input Set to run and selected dates are set from the main configuration screen. These steps are illustrated in Figure 8.

To delete a configuration, select the relevant row and press the Delete button on the keyboard.

Figure 6. Accessing the Configuration Manager

Figure 7. Specifying run configuration settings

Figure 8. Customising run configuration settings

Model run times

Generally, the larger or more complex the model, the longer it will take to run. There are several user-configurable options in Source that you can use to increase performance (ie. reduce scenario run times) by ensuring only necessary functions and features are enabled during a model run. For example, you can reduce the number of recorded parameters (see below), or reduce the modelling period by choosing appropriate start and end dates when configuring your model (Figure 1). Other options include running various model components in parallel, these options can be enabled when configuring the model (Figure 1) and from within the Scenario Options dialog (Edit » Scenario Options). See Improving Performance for more information.

Recorded Parameters

Model results are only output from a model run for the Parameters that have been selected as recorded in the Parameter window (Figure 9). Custom Recorder Sets can be saved, or exported from a model and provide a quick method for changing the activated recorders within the model.

Figure 9. Recorded Parameters

Recorder Sets

You can now easily switch between groups of recorders by using recorder sets. Similar to scenario input sets, they can be created from existing recorder configurations, specified manually using the text editor, or from a file. To access configuration, select Edit >> Recorder Sets.

Configuration Options

The quickest way to construct a Recorder Set is to enable recorders manually in the project hierarchy and parameter pane, and then select Edit >> Recorder Sets, right click on the scenario name and select Create Current Recorder Set (Figure 10), this adds all the selected reorders from the project to the Recorder Set editor pane. This Recorder Set can then be edited, saved or applied immediately to the project.

Figure 10. Adding a Recorder Set

Recorder Sets can be added manually using the inbuilt text editor. Select Edit >> Recorder Sets, right click on the desired scenario and select Add Empty Recorder Set. Text configuration can also be read directly from an external text file with reload on run enabled, by selecting the File instead of the Manual configuration option (Figure 11).

Figure 11. Recorder Set added to Recorder Set Editor

Searching Recorder Sets

Searching recorder sets can be done the same way as Scenario Input Sets (using Ctrl+F). More detail can be found in the Scenario Input Sets page

Using Wildcards

You can also define recorder sets with wildcards. e.g. Inflow>*>Downstream Flow>Downstream Flow will record the Downstream Flow for every node of type "Inflow". A recorder set must have at least 4 sections (separated by a '>' character).

e.g: To record every inflow recorder, you must use Inflow > * > * > *

To record every downstream flow recorder, you must use * > * > * > Downstream Flow

When Running

When configuring the model run, multiple recorder sets can be enabled and recorded for the model run (Figure 12).

Figure 12. Configuration of Multiple Recorder Sets for Model Run

Rainfall Runoff Hotstart

The Rainfall Runoff Hotstart tab provides the opportunity to set the initial state of a rainfall-runoff model (i.e. bucket storage) from a previous warm-up run. On this tab a date can be selected to either Create a new snapshot of the rainfall-runoff model state on that date, or Apply an existing snapshot (Figure 13). Created snapshot information is produced from a model run with a warm-up period and saved to a file on disk. This saved file can then be accessed to Apply the snapshot during subsequent runs without requiring a model warm-up period. Thus, the created snapshot file can be used to define the initial conditions of a subsequent run. Snapshots can only be created/applied for GR4J or Sacramento rainfall-runoff models.

Figure 13. Rainfall-runoff model hot start

Rainfall Runoff Hotstart using Command Line Runner

In addition to the tab in the configuration window (as in Figure 13), the Hotstart functionality can also be enabled using the Command Line Runner. A snapshot of the rainfall runoff model state at a particular date can be created and applied using the commands. First a snapshot file containing information about the model conditions at the end of a warm up period has to be created. This file can be applied to the subsequent run to initialise the model conditions.

Creating a snapshot file

To create a snapshot file in the command line, open your command line runner such as Windows Command Prompt or PowerShell and point towards the location of the folder in which the latest Source files are located and then use the following example syntax to create the snapshot file:

C:\Program Files\eWater\Source 5.30.0.12680>RiverSystem.CommandLine.exe -p "C:\Git\HYDROTESTS\Hotstart functionality\Sambar_Investigation_Calibration_Start_5-10-0.rsproj" --createsnap "C:\Git\HYDROTESTS\Hotstart functionality\test.rsnap" --snapshotDate 1/1/1990 -y "C:\Git\HYDROTESTS\Hotstart functionality\test.rsproj" -o "C:\Git\HYDROTESTS\Hotstart functionality\Result.res.csv" --starttime 1/1/1980 --endtime 1/1/1990

In the above line, the red command indicates the project file path and the model you would want to run for the warm up period and create the snapshot file. The green command indicates the path to the destination folder where the snapshot file named 'test' has to be created with the date 1/1/1990. The blue command indicates the path to the destination folder where the project is saved as an updated project in the latest Source version. This updated project 'test.rsproj' is used later to apply the snapshot. The purple command indicates the path to the folder where the run results are saved as a .csv file (here saved as 'Result'). You can indicate the project run period using 'starttime' and 'endtime'. Here, the start date is 1/1/1980 and end date is 1/1/1990.

Applying a snapshot file

By applying the above created snapshot file , the user can initialise the catchment conditions for the next run, say from 2/1/1990 with the initial conditions that of 1/1/1990. For applying the created snapshot file, an example syntax is given below:

‘RiverSystem.CommandLine.exe -p " C:\Git\HYDROTESTS\Hotstart functionality\test.rsproj " --snap " C:\Git\HYDROTESTS\Hotstart functionality\test.rsnap " --resultsOutputMode NoOutput --starttime 2/1/1990 --endtime 31/12/2000’

In the above line, the snapshot file 'test.rsnap' is applied to the project 'test.rsproj' (already saved when creating the snapshot file) with a start date of 2/1/1990 and end date of 31/12/2000. In this case, the project will run from 2/1/1990 to 31/12/2000 with the initial conditions same as that of 1/1/1990.

Performance Improvement

Networks with multiple outlet nodes (Figure 14) can be configured to run separate networks simultaneously by selecting Run Separate Networks in Parallel ( see Figure 1 above). This should not be selected as an option if there are calculation dependencies across the separate networks, e.g. Subnetwork 2 calls a function which involves a value from Subnetwork 1.

Figure 14. Example of geographic and schematic scenarios with multiple outlets

Browser not supported