13.3. Monitoring a DIS simulation

13.3.1. Running a local simulator
13.3.2. Interacting with a DIS simulation
13.3.3. Other settings
13.3.4. Logging DIS messages
13.3.5. Performance graph

Interaction with DIS scenarios is performed from the DIS Listener View.

At the top of the panel are two small icons. The first has a toggle behaviour, and when ticked Debrief will auto-resize at each step, to ensure all loaded data remains visible. The second icon opens the Console view (to keep track of messages returned by the launched simulator - see more at Section 13.4.3, “Track the simulator using the Console”), and the final one accesses the help for Debrief's DIS integration.

13.3.1. Running a local simulator

If you have specified the path to an executable in the Server preferences (see Section 13.2.2, “Configuring the launch of an external simulator”), then you can use the Local simulator box to (optionally) specify the location of the input file to be passed to the executable. Click on the ... button to open a file browser.

Once a control file has been specified, you can click on the Launch button to start the simulator executable, passing the input file to it. After launching Debrief will automatically start listening on the correct network port.

[Tip]Tip

A quick way of setting the input file is to drag one from the Navigator view oneo the path. This will update the input file path to the one dragged in.

An even quicker way of running a different input file is to right-click on a *.inp file in the Navigator view and select Run in simulator. This will launch the simulator, passing it that control file. Do this if you have lots of different input files in your workspace.

13.3.2. Interacting with a DIS simulation

The large listen button is used to toggle whether Debrief is listening for DIS messages.

If Debrief receives sufficient network status messages from the simulator, Debrief will enable the Play, Pause, Stop. After Stop has been pressed, and new DIS messages received will be put into a new plot (existing data will be wiped).

13.3.3. Other settings

Two other minor options are provided. If New plot per replication is ticked, when Debrief recognises that data for an new simulation run is being received, Debrief will open a fresh plot to contain the data.

[Note]Note

If the current plot is based on a .REP input file, Debrief will base the fresh plot on that same input file. This practice can be used to design a set of background annotations (such as exercise area, scale, bathy backdrop) - which gets used for all plots.

If the simulator is running very quickly, and it looks like the UI is getting swamped with updates, the Live updates checkbox can be cleared, which will let Debrief continue to receive and store DIS messages, but Debrief will not bother updating the user interface (the Outline view or the Plot Editor).

Lastly, the Server prefs link can be used to open the preferences page for Debrief DIS communications.

13.3.4. Logging DIS messages

On the DIS Listener view's drop-down menu is a Log Messages toggle button. When this is selected, Debrief will log all messages to the Debrief system log. This log can be accessed via the Window / Show View / Error Log menu option. The .log file is chunked into 1Mb files, and is stored in the hidden .DebriefNG/.metadata folder within your home directory. To remind the user about this logging (with its associated performance and disk usage penalty), the Scenario Complete popup dialog includes a reminder that logging is active, when relevant.

13.3.5. Performance graph

At the foot of the DIS Listener View is a performance graph. When a simulation is being listened to, this graph updates once per second. It shows two lines. One is the frequency at which simulation messages are being received, and the second is the frequency of screen updates. As more data is received, and shown on the plot, the frequency of screen updates will slow down.

Inspection of this graph can give the analyst an indication of whether the simulator is running, how quickly it is running, and how Debrief is handling the volume of loaded data.