The Results Manager allows you to examine and analyse scenario results in MUSIC X. Results can be evaluated graphically in charts, numerically in tables or as statistics, and they can also be filtered and manipulated using transforms. With custom charts, you can also view and statistically analyse multiple results within and between runs, compare results to external data sources and automatically update with the latest results each time a model is run.
...
In Results Manager there are a number of key terms. These are mostly related to naming conventions for results, groups of results, and how those results are manipulated. See Table below.
Term | Meaning |
|---|---|
| Scenario run | A run of a scenario in MUSIC X. A scenario run may also be referred to as a 'run' and the most recent is referred to at 'Latest run' in the tree menu in Results Manager. |
| Result | A single recorded output from a scenario run. |
| Result set | A logical grouping of results. This is commonly used to discuss results from a scenario run. |
| Result file | A *.res.csv file. |
| Result tab | Displays result(s) in the central workspace of Results Manager. |
| View tab | Displays a view of the selected result or custom chart, such as Chart, Table or Statistics. |
| Time series | Data that has been measured at a regular time interval (eg. observed daily flow). |
| Custom chart | A custom chart is a user-created collection of two or more time series results that allows comparison between those results graphically in charts, numerically in tables or by comparative statistics. |
| Transforms | Transforms allow you to modify (or transform) the view of the data. Once generated, they can be used as a template for another action, such as applying to custom charts. |
| Configuration | The configuration of Results Manager includes all custom charts, transforms, user-generated statistics and file locations of loaded time series and results files. |
Scenario Run Metadata
Each scenario run is issued a unique ID. When export results from a scenario run, the exported .res.csv files also includes this ID. The metadata associated with this run ID is available in results manager (See Figure 2 below). The metadata can be saved by supported file types.
...
The tree menu on the left side of the Results Manager window (Figure 4) shows all result sets from the current session, any saved results from previous runs, along with any loaded result files (*.res.csv) and time series files.
Once run, results from a scenario appear grouped together under Latest run and as a separate item grouped by scenario in run order. Those previous runs are named using the following convention, where # represents the run number from the current session:
...
.
...
The Results Manager tree menu is shown in Figure 2.
Note: Once a scenario run is complete, clicking on a node in the schematic or geographic editor will highlight that node's results in the Results Manager tree menu for the currently active scenario result set. If no scenario result set is active (eg. because a custom chart is selected), the Latest Run result set is used.
Figure 4. Results Manager, tree menu
The following should also be noted.
- The icon displayed after a scenario run corresponds to the notification level in the Log Reporter. The
icon indicates that the run contains warnings and the 
icon indicates that the run was incomplete because of a fatal error. - Previously saved result sets and time series can be loaded (see Loading Results), and appear under Loaded Result Files and Loaded Time Series, respectively.
- You can rename loaded result sets, time series and runs (except the latest run) that appear in the tree menu. However, this does not change the name of results grouped under the result set, time series or run - they will retain the original name, and any view tab will list the full name of the result as it was loaded in the Source MUSIC X project.
- Run results can be saved with the project using the Save Run in Project contextual menu item (in upper left contextual menu, Figure 2). This saves the run results and loads them automatically when the project is next opened. Note that this will increase the project's file size, particularly if you record many results or the model has a long run time. Runs that will be saved or have previously been saved in the project are indicated by a save icon next to the scenario name (Figure 5). If you have previously chosen to save a run in the project and you no longer wish to do so, you need to delete the run (right click on the run and choose Delete from the contextual menu).
Figure 5. Tree Menu showing a run saved in the project
...
Result tabs
The central workspace of Results Manager contains result tabs, which can display:
- A single time series chart (as in Figure 1); chart
- A custom chart, which allows the comparison of multiple time series;
- A unique view specific to a non-time series result in MUSIC X (eg. Scenario Mass Node Water Balance, Travel Time, Borrow and Payback); andA unique view of statistics generated for either an entire scenario (eg. Mass Balance) or for a single result from different scenarios (eg. Annual Descriptive Statistics).Treatment Train efficiency and Mean Annual Load); and
To use result tabs:
- Shift-click on a result (in the tree menu), or a custom chart or statistic (in the pane below the tree menu) to open that item in a new result tab.
- Click and drag a result tab to move it to a new result window, which will include the central workspace and view tabs depending on the type of view (see unique views above). You can repeat this to open more result windows.
- Once you've done this, and have one (or more) result window open along with the Result Manager window (which has a tree menu), you can Shift+Click on a result in the chart tab of any of these windows and drag it to another window to copy the result to the other window. This is synonymous to clicking the Drag button on the Chart toolbar and then dragging the result to another window. The result window or tab to which you dragged the result will automatically change to a custom chart, if it is not one already.
...