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
Simulation Summaries
Clicking on a run name in the Tree Menu displays a simulation summary, which summarises the simulation settings, in the Central Workspace.
The simulation summary has the following components:
| Run Name | The 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:
For custom plugins, 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):
|
| Plugins | A list of plugins loaded in the project |
The simulation summary is only available for selected simulation types (Run Configurations) and, currently, Single analysis is the only Run Configuration that will generate a complete simulation summary. The simulation summary does not persist, meaning that it will not be available for runs saved in the project. It is also not available for runs exported to file.
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.