How to use the Simulation Builder to add simulations to a catalogue

The Simulation Builder tool can be used to create multiple 1D simulation files (ief files) automatically. The files will all follow a common pattern, e.g. network file plus 2 event files, but each will reference a different combination of input data files. The input files are selected from user defined lists setup within the tool.

This section explains how Simulation Builder can link directly with the active catalogue. References to created simulations can be automatically added to the catalogue:

1. Define or load a 1D simulation file to be used as a template for the simulations you will build, i.e. it should have the required number of event files and/or a TUFLOW tcf file referenced.

2. Define or load the event files and/or TUFLOW tcf files that will be referenced in the new 1D simulations that will be created. They must be present in the project panel if the new simulations are to be also incorporated into the current catalogue.

3. Right Click on your template 1D simulation within the Simulations section of the Project panel and choose ‘Simulation Builder’ from the context menu.

   

4. The Simulation builder wizard is displayed with some pre-populated information read from your template IEF.

   

   The ‘Setup ’ page allows you to use either an existing IEF (as a template) or specify a Simulation Builder Library file. If using a template IEF, a common ‘Results Directory ’ path can be set for use in all generated IEF files. As default, the ‘Results Directory ’ path will be to a new folder named ‘Output’ located in the same folder as the simulation IEF file. This can be amended at this point, or later in the ‘Preview ’ dialog. To continue, Press ‘Next ’.

   Note:

   the ‘Next’ button moves you through to the next tab; alternatively, click directly on the tab you want to jump to.

5. The next page (or pages) display the options for varying each input data file slot within the template. These can be network (dat) files, event (ied) files or TUFLOW (tcf) files. On each tab, select the files to be used to build your matrix of simulations. A separate tab in the interface is generated for each input file defined in the specified template IEF, thus allowing you to define combinations of alternatives to utilise for each input separately. Note that at least one input file must be specified in each tab (via check box) to proceed. The input files specified in the template IEF are selected by default (although you can then deselect these).

   Compatible input files that are loaded within the Flood Modeller Project panel are automatically populated for selection in each tab. Each input file can be given an alias (default is the filename without the extension, although this can be edited). The alias is utilised in the filenames of the new simulation files created (to provide indication of their content).

   Note:

   for event files, every event file will be available under each event tab; the interface does not distinguish between, for example, rainfall events and development scenarios, and it is the responsibility of the user to ensure the relevant events are selected for each tab.

   The '+' button allows you to browse to other compatible input files not currently loaded within the Flood Modeller Project panel. The check box in the table header selects all listed files.

   

   For additional information on specifying input files in the tool, review the specific Simulation Builder tool guidance.

6. When all input files have been specified, click the Add to Preview button. A new window is displayed listing all simulation files that can be created from all combinations of the specified input files.

   

   You have options to edit selected settings for each simulation prior to building the new files:

   • Simulation (ief) filename
   • Results folder
   • Initial conditions file
   • TUFLOW options
   • Start Time
   • Finish time
   • Timestep
   • Save Interval
   • Catalogue scenario (see below)

   These data are edited either by typing directly into the table or by highlighting one or multiple rows (by clicking on the left edge of each row in combination with the Shift or Ctrl keys), right-clicking and selecting the edit tool. The edit tool appears in a new window (as shown below) and enables you to define a setting to assign to all highlighted simulations.

   

   There is also the option to return to the previous tabbed display to specify more combinations of input files and append the resulting additional simulations to the preview list.

7. The preview window toolbar includes an option to Add to catalogue. Click this option and a new, blank column appears on the left side of the table. Clicking on a field in the new column provides a list of scenarios from the currently active catalogue. Select which scenario each new simulation should be part of.

   

   Note:

   the edit tool (described above) provides an option to set a scenario for multiple rows together.

8. When all required simulations are fully specified click the ‘Build’ button in the toolbar. A prompt box will appear with default settings to ‘Add to Project’ and ‘Overwrite existing files’. Either or both of these can be deselected. Click Build to proceed.

   If simulations are being added to the active catalogue, the folder connections window will then be displayed prompting you to specify where to create the new files within the catalogue folder structure.

   In addition, if ‘Add to Project’ is ticked, the new simulations will also be added to the project panel of the current Flood Modeller project. Simulations are added in a sub-folder of the Simulations section (default name is the template IEF, but this can be edited).

   

   Note:

   When adding simulations to your catalogue using Simulation Builder, although the IEF files created will be defined within the catalogue folder structure, there are no checks on the referenced files within each IEF, e.g. event files, networks, etc. Thus, it is up to the user to define these data within the catalogue folder structure (to avoid catalogue validation issues later).