Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

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

eWater Source 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 project 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 local csv resource files, and an Insight configuration file (which must be called config.txt) must be placed in a ZIP file.

Contents

Table of Contents
maxLevel3
excludeContents
printablefalse

Job

CreationUpload Data

Setup

Choose Insight Zip

Click "Choose Insight zip" and select the .zip file that contains your Insight project. It may take a few seconds for the file to upload.

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

Insight Configuration

Table 1 lists the configuration options for the Insight Runner.

Table 1. Insight
Runner job
configuration.

Configuration Option

Description

Config File

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

It should be noted that the parameters 'project', 'timeseries', 'population' and 'generations' will replaced/added by the runner and don't have to be specified like in a traditional insight optimisation

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 Job Configuration

Queue 

Table 2 lists the configuration options for the Insight Runner.

Table 2.
Insight Runner job
Queue configuration.

Configuration Option

Description

Job Name

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

Agent End points

The location of agents that are created for this job.

  • Local - A local executable to the Run Manager Server
  • AWS - An Amazon Web Services EC2 t2.small machine
Number of AgentsThe amount of agents to be allocated to the job. Note that Insight Jobs must have at least 2 (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 × time series runs), 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 the Source project once
Number of AgentsChoose the maximum number of agents used to run the job
QueueAdds the job to the queue of jobs to be run