Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

This is a temporary documentation page that is eWater internal only as the feature is not available in 4.5.0. It will be merged with the Results Manager page when the documentation is cloned for 4.7.0

It should be inserted beneath the "Tree Menu" sub-section in the Results Manager page

Simulation Summaries

Clicking on a run name in the Tree Menu displays a simulation summary in the Central Workspace. The simulation summary records the simulation settings and has the following components:

Run NameThe run name, as it appears in the Tree Menu
Identifier

A unique, persistent identifier for the run. The identifier (if present) will be surfaced in *.res.csv files exported from the run.

The run identifier can be used as a unique identifier of simulation results when integrating with other systems.

Metadata

A table of information about the simulation settings. Usually, the table will have two columns:

  • Key - the metadata key, e.g. Configuration Type
  • Value - the value of the metadata, e.g. Single analysis

For custom /wiki/spaces/SD516/pages/54986263, it is possible to also define a Subkey column.

External Files

Details of external files that are used by the scenario. Three types of external files are reported (if they exist):

  • Input Set
  • Recorder Set
  • Data Source
PluginsA list of plugins loaded in the project

...

The simulation summary is designed to allow users to create plugins to display custom information , or integrate with external systems. Refer to the Provenance Plugin documentation for more information.