Changelog for TUFLOW Plugin v3.10

New Features and Enhancements

TUFLOW Viewer

Support for TUFLOW-SWMM Results

Support for the new GPKG time-series output format (_swmm_ts.gpkg) has been added and can be loaded via:

  • Load Results (via the TLF or TCF)
  • Load Results - Time Series

For more information on the format please visit the TUFLOW Wiki:
TUFLOW Viewer - GPKG_Time_Series_Format

Support for NetCDF Rasters in Animation Tool

Support for NetCDF rasters (including high-resolution NC outputs) has been added to the animation export tool. The rasters must be loaded via Load Results - NetCDF Grid

New Option to Copy Results Before Loading

The option to create a temporary copy of the results before loading has been added. This negates the issue of locked result files while trying to view results while TUFLOW is running. This is applicable for XMDF, DAT, and NetCDF results.

For more information, please visit the following TUFLOW wiki page:
TUFLOW Viewer - Loading Results While TUFLOW is Running

copy_results

Selecting 1D Nodes Does No Longer Affects 1D Long Sections

Selecting 1D nodes while plotting a 1D long section no longer affects the long section (i.e. cause it to disappear).

Unchecking a Mesh Result in the Layers Panel No Longer Causes Result to be Deselected

Unchecking a mesh layer (e.g. XMDF) in the QGIS Layers Panel will no longer deselect the result in TUFLOW Viewer in the ‘Open Results’ widget. This was previously implemented because there was a bug in QGIS that would cause results to remain visible even after they were deselected in TUFLOW Viewer due to the F7 styling panel ‘Live Update’ option overriding TUFLOW Viewer (to fix this the Open Results widget was linked to the checked layer visibility).

Import Empty

Adds Missing Tooltips

Missing tooltip for the 2d_wrf type added.

import_empty_wrf

TUFLOW Context Menu

GPKG Time Series Result Styling

Styling by different result types has been added to the GPKG time-series result context menu. This is possible regardless of whether the layer has been opened via TUFLOW Viewer or opened in QGIS natively.

gpkg_ts_context_menu

Load Layers From TCF

Commands Where No Files Were Loaded Are Now Reported

Commands that should have layers loaded but don’t, are now reported to the user.

load_tcf_layers_error_handling

Processing Toolbox

SWMM Tools

A toolbox containing a number of tools for TUFLOW-SWMM model building has been added. For more information please visit the following TUFLOW wiki page:
TUFLOW QGIS Plugin

tuflow_swmm_toolbox

MiTools

A toolbox containing a number of ported MiTools has been added.

mitools_toolbox

Create TUFLOW Project Missing Commands

Missing commands from the TCF has been added to the control file templates created when running the Create TUFLOW Project tool. The missing commands were:

  • Start Time ==
  • End Time ==
  • Timestep ==
  • Log Folder ==
  • Output Folder ==
  • Write Check Files ==

cf_template

Import Empty Supports Empty Folder or Project Folder

The import empty toolbox tool now supports the empty directory to be either the project directory (TUFLOW folder) or the empty directory itself. If using the project directory, the directory structure must match the standard TUFLOW structure.

import_empty_dir_location

Bug Fixes

TUFLOW Viewer

  • Disable matplotlib 3.5.1 “legend about to break” check and message
  • Fixes bug where Flood Modeller cross-sections weren’t plotting due to the change in inactive area handling in TUFLOW Plugin v3.9
  • Fixes bug when loading a cross-section that starts with a valid float number in the header
  • Fixes python error that prevented TUFLOW Viewer from loading when there was a 1d_xs
  • Fixes hover over plot labelling for matplotlib 3.7
  • fixes a bug that stopped loading tpc result when a ‘#’ was present in the flow regime result
  • Removes duplicate result types from 2d_bc_tables
  • Static NetCDF grid results no longer affect the time slider
  • Optimised code relating to feature selection when viewing time series results
  • Long profile results are not shown if only 2D results are available (Time Series results)

Other

  • Import Empty (Toolbox) - Fixes bug that could potentially not correctly bring in new GPKG layer if GPKG contained more than one layer
  • Import Empty (Toolbox) - Removes duplicate empty types from list
  • Apply GPKG Name - Fixes bug where name wasn’t applied to raster layers where the database only containes one raster layer
  • Increment Layer - Fixes bug that would cause python error if a layer group was selected
  • Convert TUFLOW Model GIS Format - Fixes bug on tool initialisation when using network drivers (caused python error)
  • Load from TCF - Fixes python error that would occur if an xf layer was being referenced
  • 1D Integrity Tool - Vector layer input comboxes will no longer reset if a layer is added/removed from workspace
  • 1D Integrity Tool - Error is shown to user if selected channels are not connected when using the flow trace tool. Previously this would error silently and progress bar looked to hang.
  • 1D Integrity Tool - Remembers selected DEM which could reset if layers were added/removed from workspace
  • 1D Integrity Tool - Fixes Python error that could occur if an aerial image was accidentally used as ground surface
  • 1D Integrity Tool - Fixes a Python error that could occur when importing new layers when raster layers are open in the workspace
  • 1D Integrity Tool - Fixes a bug where using a cover limit of exactly zero would result in no cover limitations being flagged
  • Run TUFLOW - Fixes bug that can cause Python error when browsing for TUFLOW.exe
  • Copy TUFLOW Command - A little more clever when searching for control files in case it finds an erroneous ‘TUFLOW’ folder