Changelog for TUFLOW Plugin v3.7

Release date: 10 Jan 2023

  1. New Features and Enhancements
    1. TUFLOW Viewer - Support For Reloading Mesh Layers
    2. TUFLOW Viewer - Updating Mesh Styling Updates Both Temporal and Maximums
    3. TUFLOW Viewer - Increase Hover Over Labelling Speed
    4. TUFLOW Viewer - Add Missing Plot Result Type Axis Labels and Uniots
    5. TUFLOW Viewer - Cross-Section Results Can Use Water Level or Max Water Level
    6. Arch Bridge Editor
    7. ARR to TUFLOW - Point Temporal Patterns
    8. ARR to TUFLOW - CSV Output Includes Event ID
    9. Import Empty - GPKG Database Settings Saved
    10. Reload Layer - Reload Mesh Support
    11. Load Layers From TCF - Improved Progress Bar
    12. Load Layers From TCF - Support Any TUFLOW Control Selection
    13. Convert Model GIS Format - Manually Assigning CRS
    14. Convert Model GIS Format - Commands That Do Not Copy Anything Reported
    15. Convert Model GIS Format - Create Empty Files
    16. Convert Model GIS Format - Custom Output GPKG Name
    17. Toolbox - TMO to Points
  2. Bug Fixes
    1. TUFLOW Viewer
    2. Other

New Features and Enhancements

TUFLOW Viewer - Support For Reloading Mesh Layers

Major Feature

Support reloading of mesh layers (must use reload layer tool if results have changed otherwise QGIS crashes). This is only available in QGIS 3.28+.

reload_mesh_layer

TUFLOW Viewer - Updating Mesh Styling Updates Both Temporal and Maximums

Changing rendering style of a result type will now also change the style of the maximum and minimum type of the same name (and visa versa). Previously this would not update both as QGIS treats these as separate datasets.

TUFLOW Viewer - Increase Hover Over Labelling Speed

Increased hover over labelling speed. From testing 10,000 point dataset: previously each label took ~1.0s to calculate and render, now ~0.15s.

TUFLOW Viewer - Add Missing Plot Result Type Axis Labels and Uniots

Adds units and label to y-axis for RFR, RFC, RFML outputs.

plot_rfr

TUFLOW Viewer - Cross-Section Results Can Use Water Level or Max Water Level

Adds ‘Water Level’ and ‘Max Water Level’ result types to cross-section (previous had to use time series ‘Level’ result type).

Arch Bridge Editor

Major Feature

New tool - Arch Bridge Editor or ‘BArch’ types. For more information please visit the following TUFLOW wiki page:
QGIS TUFLOW Arch Bridge Editor

arch_bridge

ARR to TUFLOW - Point Temporal Patterns

The tool will now download the point temporal pattern CSV manually if no temporal patterns are found in the ARR_Web_Data.txt.

ARR to TUFLOW - CSV Output Includes Event ID

The processed rainfall CSV files now contain the temporal pattern event ID. This makes it easier to match the processed data to the raw temporal pattern data from the Datahub.

arr_to_tuflow_event_id

Import Empty - GPKG Database Settings Saved

The GPKG ‘Spatial Database Options’ settings are now saved after the tool is run so that they are auto populated the next time the tool is used.

import_empty_gpkg_options

Reload Layer - Reload Mesh Support

Major Feature

Updated to support mesh layers in QGIS 3.28+.

reload_mesh_layer

Load Layers From TCF - Improved Progress Bar

The progress bar has been improved and made more robust.

load_from_tcf_prog_bar

Load Layers From TCF - Support Any TUFLOW Control Selection

Adds support for any TUFLOW control file to import from.

load_from_tcf_all_cf

Convert Model GIS Format - Manually Assigning CRS

Adds ability to specify output CRS. The output CRS is assigned to all layers when converting formats, however no translation/warping is performed.

conv_gis_format_crs

Convert Model GIS Format - Commands That Do Not Copy Anything Reported

Tool will now log commands that do not convert/copy any files (but should do).

conv_gis_format_nothing_copied

Convert Model GIS Format - Create Empty Files

Adds option to create empty files for the converted model. The tool will try and locate an existing ‘empty’ folder or ‘gis’ folder to put the created empty folder, however the user can also specify a relative path (from the root directory i.e. ‘TUFLOW’ folder to place it).

conv_gis_format_create_empty

Convert Model GIS Format - Custom Output GPKG Name

Adds option to specify the output GPKG database name when using a grouped profile.

conv_gis_format_gpkg_name

Toolbox - TMO to Points

Major Feature

Added ‘TMO to Points’ algorithm to the TUFLOW toolbox. This tool converts outputs from a .tmo output (Map Output Format == TMO) into a point vector layer.

tmo_to_points_toolbox

Bug Fixes

TUFLOW Viewer

  • Fixes a bug that would cause python error and not display results when trying to plot TS_P.shp and TPC results at the same time
  • Fixes bug when saving project when a TS_P.shp was loaded that could cause a python error
  • fixes rendering map outputs in QGIS 3.28 which could become scrambled if min dt was present (a bug is still present in QGIS that no longer renders temporal min dt)
  • Fixes bug that would incorrectly carry over 1D result types to next loaded result dataset
  • Stops duplicate plots of the same 1D element - can happen if the PLOT layer is duplicated in the workspace
  • Fixes bug that would produce python error after closing mesh results from layers panel then trying to close 1D results
  • Fixes bug in Load from TCF when a scenario name contains dashes (-)
  • fixes bug in map output flow calculation which was producing a python error
  • Fixes python error that could occur after closing tuflow completely and re-opening with time series result when a PLOT feature is already selected
  • Unidirectional pipes now plotted correctly in long plot
  • Cell centre ‘bed elevation’ results in TUFLOW FV netCDF format will no longer check if face is active in plot window
  • Load from TCF now correctly finds output zone results
  • Fixes bug that would cause 1D long sections to not plot when 1D point objects were also selected
  • Fixes bug when viewing results on cross-sections with mif files that would not show water levels
  • Fixed bug in animation tool that could cause python error if the dataset was the first in the mesh layer (index = 0)

Other

  • 1D Integrity Tool - fixes python error that could occur when checking for non-compliant channel ids in QGIS 3.26
  • 1D Integrity Tool - Fixes bug in Unique Channel ID tool that wasn’t correctly flagging non-compliant ids
  • Configure Project - Fixes bug that would not create empties if ‘Create Model Folder Structure’ was not also ticked
  • Increment Layer Tool - Handles empty geometry layers a little nicer
  • Import Empty - Fixes ‘Convert to GPKG’ option which wasn’t doing anything
  • Insert TUFLOW Attributes - Fixes insert ‘2d_mat’ when using GPKG
  • Style Current Layer - Fixes tooltip
  • Load From TCF - Fixes a bug that did not load layers from ECF if using “Estry Control File == AUTO”
  • TUFLOW Utilities - info tool will error gracefully if an error occurs with the utility
  • TUFLOW Utilities - Fixes browse dialogs hanging if previous file/folder path was on a drive that is no longer connected
  • TUFLOW Utilities - Fixed bug that would crash QGIS if the download button is clicked twice in a row
  • TUFLOW Utilities - Cache is now cleared for download links so latest is always downloaded