Simulation Mode: Manual vs. Auto-Run
MUSIC can be run in two modes: Auto Run or Manual. To switch between modes, go to the 'Settings' tabs and set Auto Run Models to on (green) or off (red). In Auto Run mode, music will automatically re-run the simulation, any time a change is made to the Catchment (for example, a new Node is added, or the properties of a Source Node or Treatment Node are changed). This allows you to see the results of your changes instantly, but it can be very time-consuming, particularly for complex simulations over long durations.
In manual mode (Auto Run turned off), click the Run Catchment Models Button ( or press F5) to run the simulation, when required.
MUSIC starts automatically in manual mode (Auto Run turned off). Whether you wish to leave Auto Run turned off depends on the complexity, time-step and duration of simulation you are running, your computer’s speed, and your need to see the results of changes ‘on the fly’.
The following table summarises the advantages and disadvantages of running music in Auto Run or Manual mode.
| Manual (Auto run OFF) | Automatic (Auto Run ON) | |
|---|---|---|
| Advantages |
|
|
| Disadvantages |
|
|
| Info | ||
|---|---|---|
| ||
|
Running music from the Command Line
In addition to using the graphical user interface, you can use the command line mode to run music. A major advantage of this is that it allows you to run music in batch mode, or use it with other third-party tools (for example, optimisation software such as eWater Insight).
- You can perform several actions in music using the command line including:
- Specifying various files to use, such as the input data files, music project files, climate template files and configuration files;
- Obtain the output files for several parameters such as:
- Specifying the output file type. For example, choose a flux file or time series output.
| Info | ||
|---|---|---|
| ||
| Note: Any errors occurring during execution are written to a log file. |
For more information on using the command line, contact eWater support.
Saving MUSIC files
Whenever you run a simulation, music will prompt you to save the file; it is a good idea to do so, to reduce the risk of losing the model in the event of a system hang.
MUSICc has two primary file types:
- MUSIC data files (.sqz): saves model setup (and its attached meteorological template), but not simulation results - file size generally < 500kb; and
- MUSIC data files with results (.sqr): saves the full model setup and all simulation results - file size may be very large, depending on model complexity, time-step and period of meteorological template.
It is generally advisable to save .sqz files (to save disk space), but the model will need to be re-run upon opening (this takes no longer, and often less time, than opening the full file with all simulation results).
However, in some instances, you may wish to save the simulation with all attached results, so that the exact simulation is preserved when you next open (particularly where you are using stochastic simulation of pollutant time-series, when results from subsequent simulations may vary slightly).
...
| icon | false |
|---|
Note: MUSIC can import and/or open files created by earlier versions of music, BUT if you want to open them again using an earlier version of music, you must use "Save As" to save them with a different name (leaving the original file unchanged).
Tip Box
...
Scenarios are run to produce results by clicking on 
button. Each scenario run produces a collection of result sets.
During a run, each nodes in the scenario can produce one or more result sets in the form of Mean Annual Loads (MAL), Node Water Balance (NWB), Treatment Train Efficeincy (TTE), water flows, volumes, contaminants loads, concentration and other outputs specific to that node.
Recording parameters
When you run a scenario, Source nodes produce results in the form of MAL and NWB, Treatment Nodes in the form of TTE, MAL and NWB and receiving node in the form of MAL and TTE. These nodes can also produce times series data on flow, contaminants and other data outputs specific to that node. To view or save these model outputs after the run, you need to select them to record before you run. When you save a project or make a copy of a scenario, MUSIC automatically saves the list of model outputs selected for recording. There are two ways to select which parameters and model elements to record, using the Project Hierarchy to select model parameters at the component level (eg. source node, wetland), or more fine-grained parameter-level control in the Parameter pane.
Performance Improvement
Before running the scenario, give consideration to the required output and only record the parameters of interest. These node types can produce more than 20 separate data outputs. In general, the more outputs you record, the longer the simulation will take.
Component-level controls
For a given scenario run, you can select which outputs will be recorded using the component's contextual menu or the Record icon in the Project Explorer toolbar:
- Using the Project Explorer, right-click a group or individual model element in the Project Hierarchy as shown below. From the contextual menu, select:
Record All – every parameter at this level and below will be recorded;
Record None – no parameters at this level and below will be recorded;
If the indicator appears as
, some (not all) parameters at this level and below will be recorded.
Parameter-level controls
For fine-grained control of individual recordable parameters as shown below:
- Select the group or model element within the Project Hierarchy. Selection causes all of the group's or element’s parameters to be displayed in the Parameters area; and
- Use the contextual menu to enable or disable individual parameters or parameter groups.
Note: The contextual menus shown in Figures 6 and 7 can be applied at any point within their respective hierarchical displays. If you select an individual model element, the effect will be limited to just that element. Applying a recording choice to a group propagates the effect to all elements grouped below it in the hierarchy. For example, to record only Downstream Flow for all straight-through routing links, you would select Link » Straight-Through Routing and choose Record None (Figure 6), and then select Downstream Flow in the Parameter pane and select Record All (Figure 7).
Using the Log Reporter
If a scenario run results in errors or warnings, the first indication of those is displayed in the Run completion dialogue by a red or yellow icon next to the Close button as indicated in Figure 7.
Figure 7. Running scenario (error)
You can investigate the causes of errors or warnings using the Log reporter (Figure 8). If the Log Reporter window is not visible, do either or both of the following:
- Choose to make it visible; and/or
- Make the Log Reporter active by clicking the Log Reporter tab.
Once the Log Reporter is active, you can view all the logs run by Source, from configuring a scenario to running it. You can clear the log or export its contents to a .csv file using the contextual menu (as shown in Figure 8). Table 1 provides a description of each of the columns in the Log Reporter.
Figure 8. Log Reporter
Table 1. Log Reporter, Columns
Column | Description |
|---|---|
| Date | The local date on the computer. |
| Run | The run number. You can also filter messages based on this number - use the filtering icon. |
| Level | The notification level associated with the message, which can be one of information, warning, error or fatal. The messages are classified according to the way in which they were generated (see Message Type). |
| Time Step | The scenario time-step which the message refers to. |
| Name | Name of the node or link corresponding to the message. |
| Model Type | These are the node and link types – ie. Inflow, Straight Through Routing |
| Message | Details of the message. |
| Message Type | There are three types available:
|
Execution order rules
During a scenario run, components of the scenario are run in a particular order to ensure that they comply with inbuilt Simulation phases and execution order rules.
Note: The execution order is based on leaf node names alphabetically. Thus, renaming a node can change the order.
Execution order rules are now available in Scenario Options: Execution Order Rules
Scenario results
Note: Results of a scenario run can be viewed in the Results Manager or using the Recording Manager.
Once run, every scenario generates a result set – a distinct collection of results recorded for that run. Scenario results can be examined and analysed using the Results Manager, which opens when a run completes. Within Results Manager, 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. See Results Manager for more information.
In Results Manager, result sets are listed in the tree menu on the left side. The name of scenario's result set is formed by concatenating the run number from the current session with the name of the scenario. If there are errors or warnings from your run, these are indicated by an appropriate symbol next to the result set's name (see notification level), and are also listed in the Log Reporter (see Using the Log Reporter). For example, Figure 11 shows that in this Source session, Stage C was run first, and had warning(s) associated with it, Stage B was run next and had a fatal error that stopped the run from completing, and Stage A was run third without any warnings or errors.
Figure 11. Results Manager
