Note: This is documentation for version 5.12 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above

Insight Runner

Owned by Alex England (Deactivated)
Last updated: 12 Oct 2023 by TeamcityVersion comment

Overview

The Insight Runner runs a single eWater Insight optimisation across one or more Source Projects.

eWater Source and Insight Project Setup

To run an Insight job, the eWater Source project(s) must already be configured to be run in traditional Insight with it's configuration in the text file format, see Using the command line for Insight and Configuring an Insight Optimisation Run. The Load Time Series option of Insight is supported by the Insight Runner however the path must be the same as, or relative to, the path setting, which must be the root folder of the zip archive. Both of these settings will be modified by the Insight Runner.

Once configured, the eWater Source project(s), any input timeseries files, and the Insight configuration file must be placed in a zip archive file. The Insight configuration file must be renamed "config.txt" if it is saved using a different name in Insight.

Note that the Insight config file must be in the root of the zip archive and not within a folder. The project setting in the config file must refer to the folder which contains the config file otherwise Source project and timeseries files may not be located correctly and cause the run to fail.

Example Insight Project zip file

InsightExample.zip

In this example there is a single project, Multi_obj_optimise.rsproj, and there are two run folders, Run1 and Run2, containing differing inputs for the Inflows.csv timeseries file. Each population will will run two Source runs using the input timeseries.

  • InsightExample.zip
    • config.txt
    • Multi_obj_optimise.rsproj
    • TimeSeries
      • Run1
        • Inflows.csv
      • Run2
        • Inflows.csv

Insight config.txt paths:

project C:\InsightExample

timeseries C:\InsightExample\TimeSeries


The Run Manager Cloud Application is currently configured to use multiple versions of Source and has two plugins available:

  • UrbanDeveloper
  • SubSource

Before running projects on Run Manager it is always recommended to save the projects using a supported version to avoid needing to upgrade the projects during Source runs.

Contents

Job Setup

Choose Insight Zip

Click "Choose Insight zip" and select the .zip file that contains your Insight project. Depending on the size of the file it may take a moment for the file to upload.

Once the project has finished being uploaded, the Insight Runner configuration options will be displayed.

Insight Configuration

Table 1 lists the configuration options for the Insight Runner.

Table 1. Insight configuration.

Configuration Option

Description

Config File

The insight configuration file to run the optimisation with. It will be automatically filled out using the file from the Insight zip archive file.

It should be noted that the parameters 'project', 'timeseries', 'cache', 'population' and 'generations' will be replaced/added by the runner.

Population SizeThe population size given to the NSGA-II algorithm to use during the optimisation
Number of GenerationsThe number of generations given to the NSGA-II algorithm to use during the optimisation

Queue 

Table 2 lists the queue options for the Insight Runner.

Table 2. Queue options.

Configuration Option

Description

Job Name

The name given to the job when viewed in the Run Manager

Agent End pointsChoose which type of agents should be used to run the job (will be hidden if Run Manager is configured to only have one type of agent endpoint)
Source VersionChoose the Source version to use for the Job
Number of AgentsThe number of agents to be allocated to the job. Note that Insight Jobs must have at least 2 agents (one master and one endpoint). You may specify any number of agents however to minimise the waiting time of agents the number of agents should be a factor of the runs per generation plus one for the Insight master, where runs per generation = (population size × project count × timeseries runs count), as NSGA-II cannot move onto the next generation until all individuals in the current generation have finished.
Model Run Estimate (Minutes)(Optional) The user's estimate of how long it will take to run a single individual = (project count × timeseries runs count)
Estimate(Optional) Estimates the costs of running the job based on the user's Model Run Estimate, the number of agents, the population size, and the number of generations.
QueueAdds the job to the queue of jobs to be run

Results

The Insight Runner will provide the following result files in a zip: