Statistical Reports can be generated from the results of one or more simulations. The reports contain summaries relating to selected locations and attributes.
Results data to be used in the generation of statistical reports can be restricted by specifying a time window(s). Only data falling within the specified time window(s) will be used.
The summary data produced includes:
- Minimum and maximum values (with date and time)
- Values for up to three user-defined percentiles
- Exceedance statistics for up to three user-defined thresholds
- Pass forward flow details (when analysing outfall spills)
Statistical summaries are produced by first defining the relevant statistics in a Statistics Template and then applying this template to the results of one or more simulations to generate Statistics Results for each simulation. One or more sets of Statistics Results can then be viewed in Statistical Report Views.
The statistics can be copied to a spreadsheet using the usual Windows clipboard options and they can also be exported to CSV files (Export statistical data from the Statistics menu).
Generating a Statistical Report
This section lists the steps required to generate a statistical report:
Define Statistics to be Generated using Statistics Template
To generate a statistical report, first define the relevant statistics in a Statistics Template:
- In the
Explorer Window, create a statistics template by right-clicking on a
Model group and selecting either New
InfoWorks
Statistics template or New SWMM
Statistics template from the popup menu. Enter a name for the template and click OK. The new statistics template will be displayed.
- In the statistics template, ensure that the type of network, for which the summary is to be produced, is displayed in the Network field.
- Select the Location type and Attributes for which the summary is to be produced.
- Check the list water quality attributes box if you want to include the results for water quality attributes in the report.
- If the template is for an InfoWorks network, select the appropriate water quality attribute from the list that appears in the Attribute field.
- If the template is for a SWMM network, enter the name of the pollutant, whose result attributes are to included in the report, in the Attribute field.
- Check the use absolute value of attribute box if you want to use the absolute value of the specified attribute.
- Check the Identify events and the Calculate percentiles to include these options in the report.
- Create a list of network objects for which statistics are to be generated. This can be done be dragging a selection list into the Statistics Template Grid, adding a current selection on the GeoPlan or by typing entries in manually.
- Enter up to three Percentiles to be included in the report.
- Enter up to three Thresholds, for which the summary will display information for each period when the threshold was exceeded. Define the rules which will determine how exceedances will be treated (e.g. exceedances of short duration to be ignored). See the Statistics Templates topic for further details.
- To add further location and attribute combinations, add a new tab to the statistics template by clicking Add new tab.
- To specify a period of time or a regularly recurring set of time windows to restrict the data from which statistical results are drawn (for example, to derive statistics for the bathing season parts only of a multi-year run), define a Time Window via the
Time Windows dialog.
Note: This step is not required when producing a statistical report using the UK 12/24 block spill counting method. See the Statistics Templates topic for further details.
- Click Custom Columns to enter, via the Custom Columns dialog, descriptive text associated with each location in the statistical report.
- When you have finished editing the template, click Validate to check for errors.
- Click Save to save the template and then click
to close the template.
Apply Statistics Template to Simulation Results
To generate Statistics Results and display a set of Statistical Reports apply the template to the results of one of more simulations:
- Select Statistical reports from the Results menu or drag a Statistics Results item into the InfoWorks ICM workspace.
- The Compose Statistical Report dialog is displayed.
- Drag the simulations of interest into the Sim /SWMM sim box.
- Drag a statistics template into the Statistics template box.
- Click Produce report.
Messages are displayed if statistics have not been prepared or results are not available (for a failed simulation), or results for cloud simulations are not downloaded. Select Yes to any of these messages to prepare the required statistics or re-run the simulation or download cloud results.
If you choose to download results, the Download Cloud Results dialog is displayed.
- Select the type of results you want to download.
- Click Ok.
Note: If you re-run a simulation or download cloud results, the simulation status icon in the Sim/SWMM sim box will be updated. You will need to click Produce report again to generate the report.A set of reports is generated and displayed in a Statistical Report View that contains the following tabs:
- Exceedance Summary Grid
- Exceedance Detail Grid
- Simulation Summary Grid
Switch between tabs to view the different reports. Scroll or page up and down within a report.
The status of the generated Statistics Results item, located under the applicable simulation in the Explorer window, is indicated by the colour of its icon:
Results for this statistical report were successfully generated
Results for this statistical report are not currently available Results in this statistical report contains errors If there are errors in the Statistics Template, an error log will be displayed.
Statistics results will usually be generated when a simulation is run but they can also be generated at any other time after the simulation has been run. For each statistics template that is applied to a simulation, a Statistics Results item of the same name will appear below the simulation in the InfoWorks ICM Explorer.