8. Configuring Outputs and Run End Log

From v3.0.0, REvoSim has a versatile logging system, that can be accessed by clicking the logging button on the main toolbar. This launches an Output Dock, which appears in the left dock area and has two tabs, placed at the bottom. The Output settings tab has a number of options that dictate the behaviour of the REvoSim logging system, and buttons to output two predefined logs at any point in a run. In addition to these, the Running log tab provides a flexible system for writing logs as a simulation run progresses.

8.1. Output options

Options in the Output settings tab are as follows:

Output save path:
 This is the folder into which all outputs from REvoSim (logs, images, any other files) are saved. For consistency these are all placed within a newly created folder called REvoSim_output. Text files are placed within the root of this folder, and images are placed in their own folder within REvoSim_output.
Refresh/polling rate:
 This is the frequency (in iterations) that the simulation is polled. Polling includes running the full clustering analysis intergral to the thorough species-identification algorithm (see RevoSim 2019 paper), writing the in-simulation log, writing any requested image files to disk, and updating the GUI (unless disabled). Because the species identification system has a significant computational overhead, if species tracking is on, frequent polling will significantly slow the simulation.
Image logging:Any of the simulation visualisations during a run can be saved as an image (png stacks labelled by iteration number). The tick boxes in this part of the tab dictate which images are saved. See Population Scene for full descriptions of each option.

8.2. Run end log

REvoSim provides a detailed log file at the end of runs - or on request during a run - that features the information below. This can be automatically output at the end of every run in batch mode (see option Automatically create detailed log on batch runs below), or dumped as required using the Write data for current run button highlighted below. The log is written to the current output folder, and is placed in a file called REvoSim_end_run_log.txt. This file is structured as follows:

Timestamp:The first line is a time stamp highlighting when the run was written, in the following format: 2018-12-30T11:57:51
Settings:A printout of all REvoSim settings for this run then follows, divided into integers and then bools. This means that at any point it is possible to revisit and check all settings for that run.
Legend:There is then an explanation of the contents of this log file: “This log features the tree from a finished run, in Newick format, and then data for all the species that have existed with more individuals than minimum species size. The exact data provided depends on the phylogeny tracking mode selected in the GUI.”
Tree:There then follows a tree in Newick format for the run to the point at which the log is written, excluding species below minimum species as requested, and also excluding species without descendents if requested. This can then be loaded into, e.g. FigTree to be rendered, or into e.g. R, for analysis. An example tree is shown below - note species labels are prefaced with id for clarity, and also include the maximum size of that species as part of their species name, after a hyphen:
Log - detailed species data:
 The rest of the log file comprises detailed data for each species in csv format, in the same order they appear in the tree. For each species, for every polling iteration, REvoSim provides the following data:
  • Species ID
  • Species ID of Parent
  • Iteration number (i.e. the polling iteration for which this was recorded)
  • Number of individuals at polling iteration (size)
  • A sample genome for the species, selected as for running log (i.e. randomly), presented as a 32-bit number
  • The above genome as a binary string
  • Genomic diversity - i.e. the number of different genomes in the species
  • The number of pixels occupied by this species, subtracted 1 (i.e. real range is 1-65536, but -1 allows C++ style numbering: 0-65535)
  • The geographic range in the form of the maximum distance between outliers
  • The centroid of range in X - the mean of all X positions
  • The centroid of range in Y - the mean of all Y positions
  • Mean fitness of all members of species, stored multiplied by 1000 to allow small changes to be easily identified
  • Minimum R, G, then B - the log then reports the minimum R, G and B values the species is found in
  • Maximum R, G, then B - as above, but maximum values
  • Mean R, G, then B - the final three numbers are the mean R, G, and B values the species inhabits

An example log thus appears:


8.3. Run end log options

REvoSim provides the following options for the run end log:

Automatically create detailed log on batch runs:
 This option outputs the detailed log at the end of each run when REvoSim is operating in batch mode.
Write data for current run:
 This option outputs the detailed log for the currently running simulation at the point at which the button is pressed.
Exclude species without descendents:
 Under most settings a significant number of small, short-lived species may appear regularly within a REvoSim run. Given the significant amount of data REvoSim can generate, and the fact that these short lived species will be unimportant for many studies (potentially masking important obvservations), this option rationalises REvoSim detailed logs by only including species with descendents in the end run log and tree.
Minimum species size:
 It is also possible to filter the species data in the log files so that only species above a certain number of individuals are included in the logs. This spin box dictates what that minimum cut-off is.

8.4. Other options

Don’t update GUI:
 This option allows runs to proceed without updating the GUI (although note that this prevents images being saved during a run). Checking this allow REvoSim to run marginally faster, and may be of utility for very long runs.

8.5. Custom logs

In addition to the Run end log, and running log (see Running Log), there are a series of custom logs that can be selected in the tools option of the main menu (see Main Menu).