Working with Insight
Ensure that the following pre-requisites are met prior to installing Insight:
- eWater Source must be installed prior to running Insight;
- Microsoft .NET framework v4 (or higher); and
- Microsoft C++ 2010 x86 redistributable package.
Additionally, at a minimum, Insight requires the following to run an optimisation:
- A Source project file containing a single scenario with decision variables and objectives expressed as Source functions (see Note);
- Access to the Source command line tool;
- An Insight settings file (containing the Source project location, objectives and decision variables);
- The number of generations; and
- The population size of each generation.
Info | ||
---|---|---|
| ||
Insight should usually be run using a Source project file containing a single scenario. It is possible to run Insight using a project file containing multiple scenarios. However, Insight will only run one scenario in the project file, which is the first scenario created by the user. |
Working with Insight is a three-step process:
- Setting up an optimisation runConfiguring an Insight Optimisation Run - Load a project and/or configuration and configure optimisation settings. This can be done using either the user interface or the command line;
- Run the optimisation; and
- View and analyse the optimisation results - Results of on optimisation run can only be viewed using the Insight interface (due to the two and three-dimensional nature of results)..
Launching Insight
Figure 1 shows how to launch Insight once Source has been installed:
- Click on the Windows Start menu;
- Choose All Programs;
- Scroll down and click on the folder indicating the version of Source you have installed (In Figure 1, this is eWater Source 3.3.0.234); and
- Choose Insight from the list of programs listed.
Figure 1. Launching Insight
The Insight user interface
Info | ||
---|---|---|
| ||
Note: When you open Insight for the first time, it will automatically attempt to locate an installation of the Source command line tool (RiverSystem.CommandLine.exe). |
Figure 2. Insight user interface
The Insight user interface (Figure 2) comprises of:
- A top-level menu where you can perform high-level functions such as load configuration settings or open a set of results;
- A toolbar, where you can add/remove components of the optimisation run or perform a run;
- A tree menu structure on the left that lists the components required to complete an optimisation run - objectives etc; and
- A panel on the right that provides details of the selected tree menu item.
Insight menus
The File menu items allow you to work with settings configuration and results as follows:
- File » Load RiverSystem project directory - This is synonymous to clicking Browse. It loads the directory containing the Source project(s). In Source (public version), you can only load a single project at a time;
- File » Load Configuration - Loads the settings file of a previously saved configuration;
- File » Load Configuration and project - Allows you to add additional configuration parameters to a loaded settings file;
- File » Save Configuration - Saves the current configuration settings;
- File » Import results and File » Export results - allows you to import and export results of an optimisation run respectively; and
- File » Exit - Quits Insight.
The Help menu contains a link to this documentation page.
Insight toolbar
Figure 3. Insight toolbar
Creates a new component of type as selected:
- Objective;
- Constraint;
- Real decision;
- Discrete decision; or
- Tracked variable
Removes the selected item from the tree menu.
Expands all folders in the tree.
Collapses all folders in the tree
Performs an optimisation run for the loaded project. Synonymous to clicking Run in the main interface.