Scenario Input Sets

Scenario input sets allow you to easily keep the model structure, while switching between groups of input parameters. These may be used to represent changeable physical attributes. You can switch between different scenario input sets to compare the effects on a model. For example, you can have one scenario input set consisting of specific parameters for Source/Treatment Nodes and another with varying parameters.

You choose the scenario input set used for a run using the Scenario Input Set drop-down menu in the Configure dialog (Figure below), accessed by clicking Configure on the simulation toolbar.

Scenario input sets are created and managed using the Scenario Input Sets dialog, which is accessible via Edit » Scenario Input Sets... (Figure below).

Using the panel on the left, then right-clicking, you can do the following using the contextual menus:

• Add Scenario Input Set – create new parent scenario input set;
• Add Child Scenario Input Set – create new child scenario input set, the selected input set will be the parent;
  
• Rename – change the name of a scenario input set; and
• Delete – remove a scenario input set.

Scenario input sets can define input parameters. Input parameters specific to a scenario are defined in the Scenario Input Sets dialog, either manually or using a file. 

Searching Input Sets

In the Manual parameter set editor. Search can be triggered by pressing Ctrl+F while the editor is selected. A search bar in the top right hand corner will appear (see figure below). The search will highlight any matches, and can be configured by the drop down in the search box (match case, match whole and regular expressions).

Child Scenario Input Sets

Child scenario input sets allow you to further refine model scenarios. A child scenario input set inherits all parameters specified in its parents. If changes are made to the parent scenario input set, existing and new children will inherit those changes.  You can then set additional parameters, or alter existing ones, overwriting the inherited parameters. When you run a model with a child scenario input set, for any parameters that differ between the parent and child, the parameters from the child will take precedence. 

Adding Scenario Input Sets

First, open the Scenario Input Sets dialog, via Edit » Scenario Input Sets...  Then either add a new root-level or child scenario input set as explained below.

A new root-level scenario input set:

• Right-click on the scenario's name and select Add Scenario Input Set from the contextual menu. This will open the New Scenario Input Set 
• You can use this dialog to copy the assigned data sources from another root-level scenario input set to this one. From the drop down menu, select the scenario input set from which to copy the data source usages,  or select <Empty> if you do not wish to assign data sources at this time. 

To add a new child scenario input set:

• Right-click on the scenario input set that you wish to be the parent, and choose Add Child Scenario Input Set from the contextual menu. 

Input parameter entry

Parameters specific to a scenario input set are defined and managed using the parameter set editor in the Scenario Input Sets dialog. The panel on the right allows you to specify parameters, either manually, or by loading a text file.

The general format for a parameter is: path1.path2...pathN=value 

Manual entry

Figure above shows an example of manual parameter entry using the manual parameter set editor. This editor has the following features:

• An auto-complete functionality, press Ctrl + space to get a list of available elements;
• Typing additional characters filters the auto-completion list. Items can also be selected by pressing the down arrow key ('↓');
• Once the correct element is selected, pressing Tab or Return auto-fills an element from the list;
• Pressing the period character ('.') displays a list of valid elements for the next step in the path;
• For a valid path, pressing the equals character ('=') displays candidate values; and
• Click the Insert units icon for a list of available units. Note that these are not scenario-dependent so you must choose the correct item.
  

File-based parameter specification

The file-based parameter entry (shown in Figure below) allows the specification of a file that will contain the element path and values. The formatting of this file must adhere to the same rules as the manual parameter set editor.

Viewing scenario input sets from node/link feature editors

Scenario input sets can also be viewed from the node or link feature editors as shown in the Figure below. The entire scenario input set tree can be viewed when a node or link feature editor is selected. By default, the lines (properties) which apply to the selected node or link are only shown and others are filtered out. The functionality 'All lines' shows all the lines used in the scenario input sets regardless of selected node/link.

This functionality helps the user to identify the nodes or links to which the scenario input sets are applied, especially when the model is large and complicated.