How to create a plot settings file
    • 04 Aug 2022
    • 3 Minutes to read
    • Dark
      Light

    How to create a plot settings file

    • Dark
      Light

    Article Summary

    To create a plot settings file for your Batch Runner simulations, set up a plot using existing 1D river results data and click the Save Plot Settings button to create a new psf file (text file with plot settings). The plot settings include options to specify an alternative chart title and to set the resolution of the jpeg image file produced. Below highlights the new plot settings controls provided on the chart setup window (note in v5.1 these settings are only available for 1D river results).

    BatchRunnerassetsimagestimeseriesplot.PNG

    Note that any chart title specified in the settings file will then be repeated every time the settings file is used within a batch run. Whereas, if this is left blank then a default title will be generated each time and this will then relate to the associated results used each time.

    The plot settings stored when saved as a new psf file are as follows:

    • Selected node labels – these will be the only nodes included in charts using the pot settings file. If extra results files are added to the chart then they must also include these node labels (otherwise no new data will be added to the plot)

    • Variables – the same ticked options are re-selected when the plot settings file is re-used.

    • Timings – the same period will be plotted when the plot settings file is re-used. If extra results files are added to the chart then they must also include data for this period (otherwise no new data will be added to the plot)

    • Results or calibration files – Any results or calibration files listed in the plot setup window will be stored in the plot settings files. However, there is the option to exclude a result from being added to a new chart created from the file. The first column in the results files table, entitled “Plot”, provides a tick box. If a file is unticked here, then it will still be saved to results file, but it will not appear in any subsequent plots.
      Note that charts are created from a plot settings file either by “exporting” the file (using the right-click menu of the 1D river network table) or calling as part of a batch run. For the latter there will be (new) results files added to the plot, specified within the batch runner tool.

    • Plot title – fixed title to be used every time plot settings file is used. Leave blank to let software set default title (variable title as related to data used each time)

    • Show/hide full path for results files referenced in chart subtitles

    • Single/multiple lines for subtitles, i.e. one line per results file plotted or all files referenced on same line

    • Plot image width and height – set in pixels. A reset button is provided to return these settings to the default values

    Plot settings file can be used as post-processing tasks within a batch run of 1D river simulations. When setting up a plot settings file for a batch select an existing results file for the 1D river model to be used in the batch. This enables compatible node labels, variables and timings to be set for the batch run plotting. If the selected results in the settings file are then unticked only new simulations from the batch will be plotted. Alternatively keep the results file ticked to include it in all subsequent batch plots. This is useful if it is a baseline or calibration dataset used for comparison.

    Note plot settings can only be specified from those in the existing results file used for the template, e.g. start and end times must be within the existing time range and variables must be present in the existing results.


    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.