https://docs.tuflow.com/qgis-tuflow-plugin/changelog/

--- 3.10.2 ---
- New Features and Enhancements -
Run TUFLOW (Simple) - Adds option to capture console output in python
Create Project (toolbox) - GPKG models use a Spatial Database format
Create Project (toolbox) - Adds basic run batch file
ARR to TUFLOW - Adds the option to add additional temporal patterns from both
the point and areal temporal pattern sets
TMO to Points - adds domain index (starting at 1) to point output

- Bug Fixes -
TUFLOW Viewer - Fixes NetCDF raster loading on Linux which was broken in v3.10
TUFLOW Viewer - Bug fix to support SWMM 1D GPKG time-series files generated by
simulations (tcf filename) which start with a number. Previously, these files
would load but plotting would not work correctly
Create Project (toolbox) - Adds missing bc_dbase.csv reference
TUFLOW Plugin - Fixes an issue loading the plugin in older QGIS versions due to
an illegal python statement for older python versions
Convert TUFLOW Model GIS Format - Fixes bug that would not correctly give a CRS
to the output GIS layers unless a user CRS was used
Convert TUFLOW Model GIS Format - Fixes a bug when converting a model into a
TUFLOW standard directory structure where .qcf was not recognised as a control
file
1D Integrity Tool - Fixes temporary layer creation from GPKG (removes fid
attribute)

--- 3.10.1 ---
- New Features and Enhancements -
TUFLOW Viewer - NetCDF rasters can be now be loaded without the Python netCDF4
library
TUFLOW Viewer - 1D flow integral results now available if output from TUFLOW
TUFLOW Viewer - 1D volume results now available if output from TUFLOW
Convert TUFLOW Model GIS Format - Specifying an output folder will no longer add
the root folder name to the output path
Convert TUFLOW Model GIS Format - Add option to change the default TUFLOW
directory structure (to some degree)

- Bug Fixes -
SWMM tools - Fixes bug that would stop plugin from loading due to dependencies
TUFLOW Viewer - Fixes flow regime plotting for netCDF time series results
TUFLOW Viewer - Fixes time series import for NC result format when the netCDF
python library isn't present
TUFLOW Viewer - Fixes bug when loading in NetCDF time series results without the
water level output
TUFLOW Viewer - When loading plot result gis layers, the path dividers will be
corrected depending on operating system
TUFLOW Viewer - Test bug fix when TUFLOW Viewer initialises temporal controller
with an updated PyQt version (PyQt is stricter with data types)
Load Layers from TCF - Quadtree single level is no longer reported as an error
Convert TUFLOW Model GIS Format - Output projection file will now be written
correctly when forcing projection
Load From TCF - Fixes bug loading inp files from TSCF
Load From TCF - Fixes bug where an uninitialised variable could be hit

--- 3.10 ---
- New Features and Enhancements -
TUFLOW Viewer - Adds GPKG time series results (currently written by
TUFLOW-SWMM)
TUFLOW Viewer - Disable matplotlib 3.5.1 "legend about to break" check and
message
TUFLOW Viewer - Selecting 1d node results will no longer affect any 1d long
section results
TUFLOW Viewer - unchecking a mesh layer in the Layers Panel will no longer
unselect the corresponding result in TUFLOW Viewer
TUFLOW Viewer - SWMM gpkg time series format is not supported within load from
TCF/TLF functions
TUFLOW Viewer - NetCDF rasters and GPKG time series working in animation export
tool
TUFLOW Viewer - Implemented new reload data functionality using copied results
which stops conflict between TUFLOW and QGIS if simulation is still running
TUFLOW Viewer - User option to delete copied results on close. Button to delete
all copied results added.
Load From TCF - Commands where no files are loaded are now reported
Configure TUFLOW Project (toolbox) - Updates HPC template control files with
missing commands
Toolbox - Adds new tool 'Create CN Lines' - port of mitools 'Create TUFLOW CN
Lines' tool
Toolbox - Adds new tool 'Create Cross-Section Lines' - port of mitools 'Create
TUFLOW XS' tool
Toolbox - Adds new tool 'Create Water Level Lines' - port of mitools 'Create
TUFLOW WLL' tool
Toolbox - TUFLOW-SWMM Tools added
Import Empty Toolbox - Empty directory can point to either the Project folder or
Empty Directory
Import Empty - Adds 2d_wrf tooltip
GPKG time series styling added to GIS layer context menu
Copy TUFLOW Command - A little more clever when searching for control files in
case it finds an erroneous 'TUFLOW' folder

- Bug Fixes -
TUFLOW Viewer - Fixes bug where Flood Modeller cross-sections weren't plotting
due to the change in inactive area handling in TUFLOW Plugin v3.9
TUFLOW Viewer - Fixes bug when loading a cross-section that starts with a valid
float number in the header
TUFLOW Viewer - Fixes python error that prevented TUFLOW Viewer from loading
when there was a 1d_xs
TUFLOW Viewer - Fixes hover over plot labelling for matplotlib 3.7
TUFLOW Viewer - fixes a bug that stopped loading tpc result when a '#' was
present in the flow regime result
TUFLOW Viewer - Removes duplicate result types from 2d_bc_tables
TUFLOW Viewer - Static NetCDF grid results no longer affect the time slider
TUFLOW Viewer - Optimised code relating to feature selection when viewing time
series results
TUFLOW Viewer - Long profile results are not shown if only 2D results are
available (Time Series results)
Load from TCF - Fixes python error that would occur if an xf layer was being
referenced
Arch Bridge Editor - Fixes bug where the tool would error when running if
features were drawn and saved while the editor was open
1D Integrity Tool - Fixes bug where a cover limit of exactly zero wasn't
flagging any cover issues
1D Integrity Tool - More robust recognition of 1d nwk layers
1D Integrity Tool - Fixes Python error that could occur when loading layers into
a workspace with raster layers
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
Import Empty (Toobox) - 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)
Run TUFLOW - Fixes bug that can cause Python error when browsing for TUFLOW.exe

--- 3.9 ---
- New Features and Enhancements -
TUFLOW Viewer - Adds BC tables check file (1D)
TUFLOW Viewer - Animation supports user defined time formatting
TUFLOW Viewer - Flood modeller results can now be shown on cross-section even if
they don't intersect the PLOT_P points if they have the same name
ReFH2 to TUFLOW - Rainfall model FEH2022 now supported in tool
TUFLOW Plugin Downloader - Adds button to copy the download path to the
clipboard
Increment Layer - New tool in layer context menu (new tools but similar to
existing import empty tool)
Import Empty - New tool in TUFLOW processing toolbox (very similar to existing
import empty)
Create Project - New tool in TUFLOW processing toolbox (very similar to
configure project)
Adds new/missing empty types to the empty tooltips (2d_bg, 1d_bg, 1d_lc)
Adds Filter Message by ID to TUFLOW context menu for messages_P layers
Adds TUFLOW Context menu to QGIS Layers Panel
Adds 'Copy TUFLOW Command' tool to TUFLOW context menu
Package Model - Package Model (using TUFLOW.exe) added to the TUFLOW toolbox
TUFLOW Utilities - GPKG rasters now supported when adding opened layers
Apply GPKG Layer Names - GPKG rasters now supported
Load from TCF - Older style 'ESTRY CONTROL FILE AUTO' syntax now supported
SWAN GIS - updated version to latest available
Style Current Layer - _ccA_L result file now has default styling
ARR to TUFLOW - LIMB data will now be processed if available
ARR to TUFLOW - Removes longitude limit (>153.2999)
Incremenet Layer - Adds user check when overwriting an existing layer in a GPKG

- Bug Fixes -
TUFLOW Viewer - Time series results are now loaded correctly using 'utf-8'
encoding which enables handling of special characters
TUFLOW Viewer - Loading NetCDF Grids will now try and load all selected layers
before reporting errors
TUFLOW Viewer - Results with only maximums will now appear in relevant plot
menus
TUFLOW Viewer - fixes loading netCDF raster as mesh
TUFLOW Viewer - XS deactivation was only working when using the MAT approach
TUFLOW Viewer - Loading mesh layers on when TUFLOW Viewer is opened was getting
tangled if layers of different types (vector layers / mesh layers) had the same
name
TUFLOW Viewer - Fixes flood modeller result cross-sections not loading when X,Y
coordinate did not contain a space between them in DAT file
TUFLOW Viewer - Fixes animations with embedded plots not working in QGIS 3.30
TUFLOW Viewer - Fixes bug introduced in 3.8.2 that prevented NetCDF grid results
from being loaded (produced python error about missing 'events' argument)
TUFLOW Utilities - Fixes bug in asc_to_asc brkline tool where the vector layer
was being passed into the utility instead of the raster layer
TUFLOW Utilities - Fixes bug where no 'browse' buttons were working
TUFLOW Utilities - Downloader was hanging indefinitely due to a python error on
a separate thread in QGIS 3.32 (caused by new numpy version)
Configure Project - Fixes bug that would not correctly save empty file location
for TUFLOW FV
TUFLOW Styling - Fixes default styling for sac_check_R
TUFLOW Styling - ISIS 1d_nwk layers are now given a single styling previously
would cause python error because they are not guaranteed to have the standard
1d_nwk fields
Convert Model GIS Format - Fixes bug that cause new filepaths to be incorrect
when convert filename that were only a number (e.g. 001.tgc)
Load from TCF - fixes bug that would not load layers if brackets were included
in file path
Load from TCF - fixes issue that would cause a python error if there was a '|'
at the end of a GIS input command


--- 3.8.2 ---
- New Features and Updates -
Load from TCF - Adds new option to load layers sorted by control file order
(exactly or group raster separately)
Load From TCF - Layers inside an 'IF Event' logic block will now be available
for selection - previously only 'IF Scenario' options would be available to the
user
Load from TCF - Keep blue highlighting in selection widgets even when they lose
focus
Import Empty - Adds 'Import into Kart Repo' option

- Bug Fixes -
TUFLOW Viewer - Fixes bug that could cause strange plotting behaviour when 1D/2D
results were both loaded and the reference time was changed for the 2D results
TUFLOW Viewer - not always picking up 1d_xs layers from GPKG
TUFLOW Viewer - Fixes bug that would sometimes not show all available
groundwater PO outputs
TUFLOW Viewer - Fixes bug that could cause python error when trying to close a
result just after TUFLOW is started overrided the same result layer
Load from TCF - Fixes bug that could cause a load error if the output folder was
a Windows path variable
Load From TCF - MIF layers with 2 geometry types will now correctly load in line
types which could sometimes not load in correctly
ReFH2 to TUFLOW - Fixes tool not initialising correctly when plugin is loaded
which was causing 'unexpected' error when the tool was opened by user
Arch Bridge Editor - fixes bug that would not recognise GPKG input layers as
1d_nwk
1D Integrity Tool - fixes python error that could occur if no points where
included when running the snapping tool
1D Integrity Tool - Fixes bug that could cause python error due to non-unique
indexing internally
Increment Layer - Fixes a bug that would lead to strange autofilled increment
names (or python errors) when the source layer name was using letters along side
version number e.g. '002b'
Configure Project - Updates to latest vector file creation functions in QGIS.
Projection.shp causes error in QGIS 3.30

--- 3.8.1 ---
- Bug Fixes -
TUFLOW Viewer - A rogue import statement was causing the plugin to not load
TUFLOW Viewer - fixes bug that would not correctly update newly selected result
in open result widget
TUFLOW Viewer - fixes bug when importing results from TCF when some input layers
are using absolute path references that could cause a python error
TUFLOW Viewer - No longer prompt user about saving default styles - could prompt
(many times) when saving a project
TUFLOW Toolbox - tmo_to_points wasn't being loaded
Utilities - Fixes issue when running 'info' function and non-ascii characters
are logged which may cause the tool to error

--- 3.8 ---
- New Features and Updates -
Adds latest available development version to 'About' dialog
Adds downloader for latest available development version
TUFLOW Viewer - Updates saving/loading vector styles to include streamlines and
flow traces. Not backward compatible and will not load old styles
TUFLOW Viewer - Load results from TCF - Handles encoding errors
TUFLOW Viewer - Workaround added for TUFLOW FV NetCDF mesh outputs that now
properly renders velocity maximums
TUFLOW Viewer - Adds axis labels for 1D hydraulic tables
TUFLOW Viewer - Adds ability to flip which axis is using a secondary axis
TUFLOW Viewer - Adds (xs) or (nwk) to hydraulic table results to indicate which
input layer should be selected to view hydraulic property
TUFLOW Viewer - Animation export format default changed to MP4
TUFLOW Viewer - Better error handling added to FFMPEG downloader. Previously if
download process crashed it sometimes didn't report anything and it looked like
it was hanging
TUFLOW Viewer - Now possible to copy a result type style into multiple results
TUFLOW Viewer - Adds result name to filename for the cross-section batch plot
export. Similar to the time series batch export filenames.
TUFLOW Viewer - NetCDF grid results now have option to change reference time
TUFLOW Viewer - visibility of results now try and communicate with QGIS layers
panel and tries keeps them in sync (i.e. checked / unchecked) - fixes potential
issue in QGIS 3.28 where they can go out of sync after using the F7 panel
Load From TCF - Catch errors when loading layer from TCF
Load From TCF - Handles encoding errors
Style Current Layer - Adds bg_uvpt_check
TUFLOW Utilities - Adds breakline function to 'common' utilities
TUFLOW Utilities - Adds ASC_to_ASC version to utility
TUFLOW Utilities - Adds output format option to ASC_to_ASC utility for 2023
version
Increment Layer Tool - Added new GPKG option to save a superseded version of
layer so working copy can be modified
Configure Project - Dialog will will only close if the tool runs successfully

- Bug Fixes -
Removes most of the "sys.path.append" calls in the code. This should make it
less likely to get tangled with other plugins or python libraries
Fixes bug that was not correctly unloading a couple of the tools
TUFLOW Viewer - Fixes 1D xs viewing when using a GPKG layer
TUFLOW Viewer - No longer recognised 1d_bc as a 1d_tab type
TUFLOW Viewer - Fixes Minimum dt display in QGIS 3.30 - now should correctly
display as only one result type
TUFLOW Viewer - Fixes bug that would not load 1D results correctly on project
load
TUFLOW Viewer - Fixes bug that could retain feature selection in layers that
were removed or otherwise deselected
TUFLOW Viewer - Fixes a bug with plotting 1D cross-sections that would cause
them to be plotted even though the 'XZ' type was not selected
TUFLOW Viewer - Fixes a bug with plotting 1D cross-sections that would stop them
from being plotted after switching to a different plotting tab then coming back
to the cross-section plotting tab
TUFLOW Viewer - Fixes a bug that would not plot cross-section hydraulic tables
if the 1d_xs and source CSV were in different folders
TUFLOW Viewer - Fixes a bug that could cause switching between results to be
really slow if multiple 1D results were loaded at the same time
TUFLOW Viewer - NetCDF grids are now correctly saved / loaded in qgis project
TUFLOW Viewer - fixes 'Move down' option when there are only 2 results open
TUFLOW Viewer - Fixes python error that could occur if selecting channel results
when another open result only contains 2D PO results
TUFLOW Viewer - Fixes grammatical error in batch export map tool successful
message box
TUFLOW Viewer - Fixes python error that could occur when batch exporting plots
when data was of different lengths
1D Integrity Tool - Fixes X connectors not being properly handled when using
flow trace tool
1D Integrity Tool - Fixes spelling mistake in Continuity Tool description
Import Empty - Fixes bug that would cause 'convert to database' always to be
checked when QGIS is first opened - now correctly remembers previous setting
between sessions
Increment Layer Tool - Fixes bug that would update a layer's name in layer panel
but not the data source if an incremented layer had duplicates in the project
Increment Layer Tool - Fixes bug that would display "|layername=" for shp files
after using 'import from tcf' tool
Convert TUFLOW Model GIS Format - Fixes bug that would not correctly convert TCF
commands prefixed with '1D'
Convert TUFLOW Model GIS Format - Fixes a bug that would cause the tool to not
bring in all layers if a scenario name had a decimal point in the name (e.g. If
Scenario == 2.5m)
Configure Project - Fixes bug that would not cancel tool after user cancel
request

--- 3.7 ---
- New Features and Updates -
Arch Bridge Editor - new tool
TUFLOW Viewer - 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)
TUFLOW Viewer - Support reloading of mesh layers (must use reload layer tool if
results have changed otherwise QGIS crashes)
TUFLOW Viewer - Increased hover over label speed. From testing 10,000 point
dataset: prev. each label took ~1.0s to calculate and render, now = ~0.15s
TUFLOW Viewer - Adds units and label to y-axis for RFR, RFC, RFML outputs
TUFLOW Viewer - Adds 'Water Level' and 'Max Water Level' result types to
cross-section (previous had to use time series 'Level' result type)
ARR to TUFLOW - Will download point temporal pattern CSV manually if no temporal
patterns are found in the ARR_Web_Data.txt
ARR to TUFLOW - CSV output now includes event id
Import Empty - Database settings are now saved from previous tool runs
Reload Layer - Updated to support mesh layers in QGIS 3.28+
Load From TCF - Improved progress bar
Load From TCF - Adds ability to select any TUFLOW control file to import from
Convert Model GIS Format - Adds ability to specify output CRS
Convert Model GIS Format - Tool will now log commands that do not convert/copy
any files (but should do)
Convert Model GIS Format - Adds option to create empty files for converted
model
Convert Model GIS Format - Adds option to specify the output GPKG database name
when using a grouped profile
Processing Toolbox - Added 'TMO to Points' algorithm
Adds file encoding prediction for all tools that read from the TCF and other
control files

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

--- 3.6 ---
- New Features and Updates -
TUFLOW Viewer - Curtain vectors will now have a vertical component if 'W' output
is found in results
TUFLOW Viewer - Added option to shift order of open results via right-click
context menu
TUFLOW Viewer - Added 'Remember Previous State' layout option
TUFLOW Viewer - NetCDF grids now supported
TUFLOW Viewer - Adds Python exported CSV format for flood modeller time series
results
TUFLOW Viewer - Adds ZZN support for flood modeller time series results
SCS to TUFLOW - SCS method calculated from GIS polygons
Load From TCF - Added progress bar
Load From TCF - Imported layers are automatically given TUFLOW styling
Load From TCF - Option to bring in layers 'grouped' or 'ungrouped'
Sort/Filter Layers - Improved speed and altered sorting algorithm slightly so
that layers with the same name (w/o '_L', '_P', '_R' suffix) will be sorted by
geometry in order of points, line, polygon
Convert Model GIS Format - Provides user with the option to restrict conversion
by scenario name
Configure Project - New icon and added to toolbar
TUFLOW Styling - Added styling for 2d_qnl
TUFLOW Utilities - TUFLOW to GIS will automatically find 2dm if using a
post-processed XMDF

- Bug Fixes -
TUFLOW Viewer - Cross-section plot lines could become offset if start or end of
line was outside the mesh
TUFLOW Viewer - Fixes bug for long section plotting of Flood Modeller results
that could sometimes produce a python error
TUFLOW Viewer - Fixes bug in hiding inactive area on cross-section when M column
header isn't defined in GIS file
TUFLOW Viewer - Fixes bug with cross-section plot that wouldn't update plot when
a result type was deselected
TUFLOW Viewer - Fixes bug when loading results from TCF which could produce a
python error when ~s~ flag was just before extension .tcf in the name
TUFLOW Viewer - Fixes 'load results from TCF' when output path is an absolute
path
TUFLOW Viewer - Fix bug when loading TUFLOW release 2013 time series results
which could produce a python error
TUFLOW Viewer - New method for loading results from TCF backported to be
compatible with Python versions earlier than 3.9 and QGIS versions earlier than
3.22
1D Integrity Tool - Fixes a bug with the ouput symbol renderer in QGIS 3.26
TUFLOW Utilities - Fixes bug with TUFLOW to GIS common tool using correct
scalar/vector type and loading timesteps from a post-processed XMDF
TUFLOW Styling - Fixes a bug that would not render TUFLOW style for GPKG layers
Import Empty - Fixes a bug where open layers with the same name as the imported
layer were removed from the workspace
ReFH2 to TUFLOW - Fixes bug that would cause GUI to hang if 2 different output
types (within rainfall or hydrograph) was selected (e.g. Direct Runoff and Total
Runoff)
ReFH2 to TUFLOW - Fixes python error that could occur if the selected GIS layer
was removed
Load From TCF - Fixes bug in new routine that wasn't finding all scenario names

--- 3.5.1 ---
Convert Model GIS Format - Updates to the latest version

- Bug Fixes -
ARR to TUFLOW - removes remote debugging breakpoint added in 3.5 which was
causing crash.

--- 3.5 ---
- New Features and Updates -
Load From TCF - new feature - user has option to load rasters, not load rasters,
or load them but don't render them
TUFLOW Viewer - Load results from TCF now finds results that have appended
scenario names
TUFLOW Viewer - changed extension order in browser dialog for load map outputs
(xmdf is now listed first)
ARR to TUFLOW - Sets initial losses > 72hrs to the 72 hr initial loss value

- Bug Fixes -
Auto Label - Fixes auto label tool in QGIS 3.26
TUFLOW Viewer - fixes animation export
Import Empty - ensures the .prj file of the imported empty is the same as the
empty - this was previously implemented but was recently broken in v3.4
Configure Project - Was not correctly setting the empty directory in the Import
Empty and Insert TUFLOW Attributes tool if the 'Save to Project' or 'Save
Globally' was used in either tool.
ARR to TUFLOW - Fixes a bug when selecting 'Use Event Independent Continuing
Losses' that would cause the variable setting TRD file to become scrambled.

--- 3.4 ---
- New Features and Updates -
Added New Stability Styling tool - new button is located using dropdown arrow
under 'Style Current Layer' button
TUFLOW Viewer - added ability to 'quick view' _TS output GIS layers. Not full
featured (no axis names, does not populate time slider, no secondary axis etc)
TUFLOW Viewer - User option added to view/hide inactive areas in 1D
cross-sections
TUFLOW Viewer - Cross-section source reference with a leading '/' will now be
interpreted the same as './'
TUFLOW Viewer - animation exporter will now update temporal properties of all
map windows (allows for insets)
1D Integrity Tool - Now produces a warning instead of an error if the input
layer doesn't look like a 1d_nwk type
ARR to TUFLOW - If storm loss values are NaN from the datahub, the tool will now
assume zero and produce an error message for the output log file
ARR to TUFLOW - Added additional columns ("Storage Reduction Factor" and
"Fraction Impervious") to material.csv output
TUFLOW Styling - added custom styling for VZSH_ZPT_CHECK
TUFLOW Styling - NWK_C check styling now has purple "all else" style visible by
default
TUFLOW Utilities - Increased width of timesteps combobox for "TUFLOW to GIS"
common tools

- Bug Fixes -
TUFLOW Viewer - fixed bug that caused map to not update when clicking different
result types after loading from a project
TUFLOW Viewer - was converting all length units to metres for 2D/3D
cross-section plotting. Will now use map canvas units
TUFLOW Viewer - fixed a bug that would incorrectly show the maximum water level
on 1D cross-sections
TUFLOW Viewer - New method of loading result from TCF was sometimes incorrectly
loading in results that weren't selected by the user
Import Empty - Fixed bug when choosing option to 'Convert to GPKG' that wouldn't
correctly create a GPKG layer with TUFLOW attributes or projection
Load Layers From TCF - fixed loading GPKG layers that would sometimes fail to
load
Configure Project - Fixed 'OK' button that was disabled within the select CRS
dialog

--- 3.3---
- New Features and Updates -
GPKG compatibility added to relevant tools - Functionality added for the 2022
TUFLOW release - keep watch for beta release coming soon!
Processing Toolbox - Added TUFLOW Processing Toolbox
Processing Toolbox - Added "Convert TUFLOW Model GIS Format" script
TUFLOW Viewer - New approach when loading from TCF - all possible results listed
to user rather than possible scenarios. Old method still available via Settings
> Defaults.
TUFLOW Viewer - cross section / long plots in animation now gives user options
to set axis limits different ways. Opening plot properties will no longer
trigger axis limit calculation which could sometimes take a while.
TUFLOW Viewer - added hover over channel names to 1D results for long plotting -
similar to culvert hover over labelling
TUFLOW Viewer - use blitting to make hover over labelling a lot quicker and
hopefully now feels 'snappier'
TUFLOW utilities - TUFLOW to GIS now has option to load header information from
an XMDF file to populate available result types and timesteps
Apply GPKG Names - New Tool - renames GPKG layers in QGIS Layers Panel to match
their name in the GPKG database
Auto Styling - now supports GPKG layers
Import Check Files - now supports check files written as GPKG
Import Empty - now supports GPKG empty files and an option to convert SHP empty
file to GPKG
Insert TUFLOW Attributes - now supports GPKG empty files and an option to
convert SHP empty file to GPKG
Configure Project - now supports GPKG option (requires TUFLOW 2022 release)
About Dialog - now has QGIS and Python version also listed for convenience
1D Integrity Tool - Added additional 'magnitude' column to 'output' GIS layer
that defines how far big the error is based on respective tool (bigger magnitude
= bigger issue)
1D Integrity Tool - Added auto symbology for the 'output' GIS layer that uses a
graduated size based on the 'magnitude'
1D Integrity Tool - styling is automatically applied to 'output' layer
1D Integrity Tool - option will be given to automatically replace inputs with
tool outputs after running certain tools
1D Integrity Tool - updated GUI with links to documentation and reduced the
height
1D Integrity Tool - output tmp layers automatically copy the style of input
layers
1D Integrity Tool - Significantly improved the speed of the long plot generator
in the flow trace tool - will be most noticeable on big datasets
1D Integrity Tool - Can now limit flow trace and long plot to particular section
of network by selecting 2+ channels to connect between
1D Integrity Tool - long plot - added basic plotting tools and interaction
1D Integrity Tool - long plot - hover over labelling now shows more information
on the channel
1D Integrity Tool - long plot - hover over labelling now shows more information
on continuity flags
1D Integrity Tool - long plot - added export/copy data options in context menu
1D Integrity Tool - long plot - can toggle legend on/off in context menu
1D Integrity Tool - long plot - can toggle continuity flags on/off in context
menu
1D Integrity Tool - long plot - current pipe at mouse position is shown in QGIS
map window
1D Integrity Tool - long plot - can zoom to current channel in map window using
context menu
1D Integrity Tool - long plot - can zoom to selected path extent using context
menu
1D Integrity Tool - long plot - pipe labels now try and avoid overlapping

- Bug Fixes -
TUFLOW Viewer - prevent scrambling of datasets in plot window due to bug in
matplotlib 3.5.1 (packaged with QGIS 3.24.1)
TUFLOW Viewer - colour bar is now always displayed for curtain plot (if legend
is on) - previously if there was no data (i.e. section was dry) the colour bar
wasn't shown. Mostly affects animations.
TUFLOW Viewer - fixed colour bar label which broke with an update to the
matplotlib library
TUFLOW Viewer - TUFLOW FV XMDF outputs now will correctly show maximums
TUFLOW Viewer - Fixed bug that could cause Python error if _PLOT_ layers were
removed from workspace while TUFLOW Viewer was closed
TUFLOW Viewer - Fixed bug with icon size setting introduced in v3.2 for QGIS
versions < 3.16 that would cause error when trying to load
TUFLOW Viewer - Hover over labelling is broken in latest QGIS python/matplotlib
version - now fixed
TUFLOW Viewer - fixed bug that could occur when loading from a qgz/qgs
ReFH2 Tool - fixed bug that broke ReFH2 GUI from opening in previous release
Import Empty - TUFLOW empty type list will be properly updated after user uses
'browse' to select a directory
Insert TUFLOW attributes - TUFLOW empty type list will be properly updated after
user uses 'browse' to select a directory
Configure Project - Displayed paths now show correct operating system slashes
TUFLOW utilities - Common functions - can now specify an output name without
specifying an output directory
TUFLOW utilities - Common functions - output name in TUFLOW_to_GIS was not
working
1D Integrity Tool - No longer need a line layer to check for empty geometries in
points or cross section layers
Load From TCF - Will now load layers from 'Create TIN Zpts' command
Auto Label - Fixed tooltip when mouse hovers over toolicon in plugin toolbar
SCS Tool - now unloads properly
TUFLOW Menu under Plugins - now unloads properly


--- 3.2 ---
- New Features and Updates -
TUFLOW Viewer - Added option to copy and paste scalar and vector styling within
TUFLOW Viewer
TUFLOW Viewer - Icon size can now be changed in TUFLOW Viewer > Setting >
Options
TUFLOW Viewer - Icon size should be corrected for Ultra HD monitors
TUFLOW Viewer - Hover over pipe labels added to cross-section plotting tab
TUFLOW Viewer - Long sections from 1D results now allow users to generate
sections along non-primary flow paths by selecting an upstream and downstream
section to go between
TUFLOW Viewer - If cross-section CSV is missing, copying the CSV to correct
location and refreshing the plot will now correctly reload from CSV
TUFLOW Viewer - Added icons to plotting tab headings. Changed long-profile icon
for time series results to be the cross-section icon
1D Integrity Tool - Added new tool: Empty Geometry (find and fix)
1D Integrity Tool - Added new tool to find and fix duplicate IDs or empty IDs
1D Integrity Tool - Added check in most tools that stops the tool from running
if there are duplicate or empty IDs as this can cause errors or funny behaviour
in most of the tools
1D Integrity Tool - Gave all output layers a consistent naming convention -
'original_lyr_name_tmp'
Import Empty - Tooltips updated to include some missing empty types and updated
to link to the 2018 Manual.
Import Empty - User can now save the current empty directory to the project or
globally
Auto Labelling - Added _PLOT_L and _PLOT_P custom label rules
Insert TUFLOW Attributes - User can now save the current empty directory to the
project or globally
Load From TCF - Now supports GPKG vector and raster format
Load From TCF - Now supports TIF raster format
TUFLOW Styling - Added 2d_rf style
TUFLOW Styling - Updated 2d_sa style with to have more transparency

- Bug Fixes -
TUFLOW Viewer - Save default style fixed
TUFLOW Viewer - Load scalar and vector datasets correctly for xmdf results
outside of velocity and unit flow
TUFLOW Viewer - Fixed bug in time series results that could load groundwater
results incorrectly as surface results e.g. 'groundwater level' as 'level'
TUFLOW Viewer - Fixed bug that could cause python error or unusual plotting
behaviour if time series results was removed then re-added with
updated/different output types
TUFLOW Viewer - Fixed bug that user to have to deselect result in 'Results' list
a couple of times to toggle it off after loading time series results only
[similar to bug fixed in 3.1.10]
TUFLOW Viewer - Fixed bug that would cause Python error when plotting 'US Level'
or 'DS Level' when a point object from PLOT_P was also selected
TUFLOW Viewer - Default font size is now correctly shown in options dialog after
it is changed without having to restart TUFLOW Viewer
TUFLOW Viewer - Fixed bug that could occur when loading from a project can cause
Python error when time series results are in the project
TUFLOW Viewer - Fixed bug that could cause water level results to not appear on
cross-section
TUFLOW Viewer - Fixed bug for viewing cross-section that would not correctly
handle column names in the GIS layer
TUFLOW Viewer - Time series long plot will now check for circular references in
the 1D channel system. Previously this could cause QGIS to hang.
Import Empty Tool - Fixed and issue where older versions of QGIS (older than
3.10.3) had stopped working due to the use of new modern methods.
Increment Layer Tool - Fixed and issue where older versions of QGIS (older than
3.10.3) had stopped working due to the use of new modern methods.
TUFLOW Styling - Fixed bug that would cause a Python error if no layer was
selected
Load from TCF - Fixed bug that would cause Python error when a command had '=='
as a comment.

--- 3.1.10 ---
TUFLOW Viewer - Cursor location on cross-section plot is now projected onto map
canvas
TUFLOW Viewer - Added hover over labels on curtain plot
TUFLOW Viewer - Fixed load from TCF that would fail if more than 2 variables
were used in a row in output folder name
TUFLOW Viewer - Fixed bug that could cause QGIS to crash when removing particle
and map output results from Layers Panel at the same time
TUFLOW Viewer - Active result type(s) are now retained as 'off' if the result is
toggled in the 'Results' list
TUFLOW Viewer - Active time is retained if the result is toggled in the
'Results' list
TUFLOW Viewer - Fixed bug that could cause result type not to render if maximum
value was toggled on in a previous open result and current result does not
contain a maximum
TUFLOW Viewer - Fixed bug that user to have to deselect result in 'Results' list
a couple of times to toggle it off after loading from a project file
TUFLOW Viewer - Particle results are now only displayed if the result is
selected in 'Results' list
TUFLOW Viewer - Fix bug that could cause QGIS to crash on close if particle
results were loaded with map output results
TUFLOW Viewer - Fix bug that would cause curtain plot colour bar legend to not
show if there was a result on the secondary axis
TUFLOW Viewer - Curtain plot colour bar will now be removed if the user toggles
off legend
TUFLOW Viewer - Fix bug that could cause hydraulic table to display properties
from incorrect channel
TUFLOW Viewer - Sped up curtain plots on xmdf / dat results by saving bed
elevation data after first plot
TUFLOW Viewer - Fixed bug that could occur sometimes when selecting/deselecting
result types that would cause some muddling of plotting and displayed results
TUFLOW Viewer - Fixed bug in hover over label routine that would sometimes cause
plot to relimit when user's mouse enters the plot area
TUFLOW Viewer - Fixed bug where unrecognised flow regime typese would cause
python error - more types inlcuded, but won't error when encounters unknown
TUFLOW Viewer - Added units on axis name for sediment, Q SED, Q TRACE, Q SALT
TUFLOW Viewer - Updated hover snapping to hopefully be nicer - will check other
datasets for closer values (previously would stop at first found)
TUFLOW Viewer - Different Time Series geometry types can be viewed at the same
time now - e.g. flow from 2d_po line and level from 2d_po point
TUFLOW Viewer - Fixed bug loading time series where timesteps were sometimes
being loaded incorrectly
TUFLOW Viewer - Sped up curtain plot updating (e.g. updating the time) a little
by saving mesh interesects / faces
TUFLOW Viewer - Added TUFLOW FV time series outputs
Load from TCF - Quadtree control file will now be loaded
TUFLOW Styling - Fixed _sac_check_R style

--- 3.1.9 ---
TUFLOW Viewer - Added hover-over labelling on plots
TUFLOW Viewer - Toggling 'Show as Dates' will no longer reload default mesh
styles - previously this would override any changes in style the use had made to
the mesh
TUFLOW Viewer - Toggling 'Show as Dates' could sometimes badly relimited curtain
plot axis if the Long Plot plot wasn't the active plot when toggled
TUFLOW Viewer - Curtain plot retains colour bar name changes
TUFLOW Viewer - Cross section / long profile plot will now correctly reset user
colour changes (when requested through the View menu)
TUFLOW Viewer - Fixed bug in FM time series import
TUFLOW Viewer - 3D to 2D depth average time series plotting working again
TUFLOW Viewer - Curtain plot should now auto update extent correctly in QGIS
3.20
TUFLOW Viewer - Fixed bug when opening mesh layer properties with multiple
results selected which would cause python error after selected a mesh layer
TUFLOW Viewer - Animation tool will now correctly animate only the selected
result in animation dialog
TUFLOW Viewer - Fixed an error that could occur when saving default vector style
while viewing netcdf results
TUFLOW Viewer - FV netCDF results now correctly show dry areas when plotted
Load From TCF - Rainfall control file now included
Auto label - Fixed labelling tool so it correctly applies _messages.txt label
properties to messages.shp
1D Integrity Tool - Added label option to flow trace long section
1D Integrity Tool - Fixed a bug that would result in an 'unexpected error'
Import Empty - Added _pts to empty list
ARR Tool - Fixed bug that would cause an error when adding additional temporal
patterns due to areal temporal patterns not being downloaded correctly
ARR Tool - Fixed bug that would not output 30m duration storm if 30h storm was
also selected
ARR Tool - Python version independent
ARR Tool - Changed plotting backend to qt5agg
Fixed bug that would cause TUFLOW plugin to not load if the netCDF4 Python
library was not installed

--- 3.1.8 ---
SWAN GIS Tools - Added tool as beta to plugin
TUFLOW Viewer - fixed bug that could occur when 'min_' was in the result type
name that caused results to not load properly - usually resulting from outputs
from res_to_res.exe
TUFLOW Viewer - fixed bug that would cause Python error when exporting or
copying plot data containing null x values and a datetime axis
TUFLOW Viewer - Fixed bug that could cause 1D velocity TS to not plot if several
results with different number of output times were selected
TUFLOW Viewer - Added 'Redock TUFLOW Viewer' option under Settings menu in case
TUFLOW Viewer gets stuck as a floating window and unable to dock
TUFLOW Viewer - Export animation tool can once again automatically download
ffmpeg.exe for Windows
TUFLOW Viewer - Time slider will update properly when user switches between
results (previously required user to change time to get it to update)
TUFLOW Viewer - Updated the plot right-click context menu signal unloading to
try and stop errors occuring when upgrading the plugin
TUFLOW Viewer - Rename result functionality broke in QGIS 3.20 due to Python
version upgrade
ARR Tool - removed qt4agg backend dependency for plot generation - this could
produce a warning message after running the tool
TUFLOW Styling - Tweaked Flood Modeller result styling
TUFLOW Styling - Added styling for lfcsh_uvpt_check

--- 3.1.7 ---
Auto Label - Added auto label rules for the _messages GIS layer
TUFLOW Viewer - Fixed a bug that could occur when exporting plot to csv
TUFLOW Viewer - Now catch issue when plot is empty when exporting or copying
data - also added more messaging
TUFLOW Viewer - Fixed a bug that could occur if more than 6 results were loaded
at once that would cause TUFLOW Viewer to hang indefinitely
TUFLOW Viewer - Fixed bug that would cause problems if mesh layer was renamed in
QGIS layer panel
TUFLOW Viewer - Fixed bug with map output cross-section plotting that could
occur when output timesteps precision was finer than 1 second
TUFLOW Viewer - Changed behaviour of plot when using 'show current time' - the
vertical bar no longer affects plot extents and won't force plot to refresh
TUFLOW Viewer - Unchecking legend position will also turn plot legend off
ARR to TUFLOW - Updated routine that collects rainfall data from BOM
ARR to TUFLOW - Added all column headers to output bc_dbase.csv

--- 3.1.6 ---
ARR tool - Fix bug that would not calculate burst initial loss correctly with
user specified loss and probability neutral loss
ARR tool - Probability neutral losses and complete storm check boxes are now
mutually exclusive options in dialog
Load TUFLOW Layers from TCF - MIF layers will automatically open all geometry
types without user prompt
Load TUFLOW Layers from TCF - Raster layers will be automatically be given the
projection of first loaded vector layer if it doesn't have one
TUFLOW Viewer - Fixed bug in 'Remove - Map Outputs' that would remove the layer
from QGIS but not from TUFLOW Viewer
TUFLOW Viewer - Load FM time series results will now create cross-sections based
on gxy file if not already georeferenced
TUFLOW Viewer - Load FM time series results corrected fixed field error in
reading dat file that would cause incorrect unit names
TUFLOW Viewer - Fixed vertical profile plotting when adding to an animation
TUFLOW Viewer - Fixed a few bugs in batch map export tool, mainly fixes for
latest QGIS API
TUFLOW Viewer - Fixed dat file loading
TUFLOW Viewer - Fixed TUFLOW FV xmdf loading
TUFLOW Viewer - Narrow view will now remember last docked location (if set as
default layout)
TUFLOW Viewer - Fixed bug - first time results are loaded, the times are offset
by user's time zone
TUFLOW Viewer - Batch export plots will now remove any mesh results when
finished plotting from them that were loaded by the tool
TUFLOW Viewer - Plot right-click context menu will no longer appear if plot pan
or zoom tools are in use
TUFLOW Viewer - Re-organised 'Settings >> Options' dialog box in a new tab
layout
TUFLOW Viewer - Added legend font size option, axis font size option, axis label
font size option
TUFLOW Viewer - Added option to set a default plot font size
TUFLOW Viewer - Fixed a bug that would cause python error when user selected
'Show as dates' when 'show current time' was on and secondary axis was also in
use
TUFLOW Viewer - Fixed bug that would cause python error if user 'cleared plot'
while in the middle of drawing a plot location
TUFLOW Viewer - Added user defined plot background colour (in settings >>
options)
TUFLOW Viewer - Added more customisable legend options (position, orientation)
TUFLOW Viewer - Exporting drawn plot lines / points to shp is now exported to a
2d_po format
TUFLOW Viewer - Fixed axis mis-naming when plotting flow regime (was incorrectly
using flow units)
TUFLOW Viewer - Fixed bug when trying to plot with dates after toggling on/off
secondary axis
TUFLOW Viewer - Fixed bug in User Plot Data Manager that would cause issues if
user changed dataset name
TUFLOW Viewer - Fixed bug that would only display User Plot Data on time series
plot (regardless of selected 'plot type')
TUFLOW Viewer - Fixed bug that would cause python error when trying to view user
plot data in manager if selection was on the 'plot type'
TUFLOW Viewer - Fixed bug when loading from TLF that would prevent load if there
were periods in file name

--- 3.1.5.5 ---
TUFLOW Viewer - Added plot value display when plot is clicked

--- 3.1.5.4 ---
ARR tool - fixed ARF for catchments less than 10km2 that caused python error
(introduced in 3.1.5)

--- 3.1.5.3 ---
TUFLOW Viewer - Fixed bug that would cause python error when changing 'zero
date'
TUFLOW Viewer - Fixed bug that would cause python error if 1D 'losses' plot
option was selected with a 2D plot object selected
TUFLOW Viewer - Fixed bug that would make mesh disappear when switching between
results if "show grid" was on
Import Empty Tool - Fixed bug that would cause error if overwriting existing
file
Import Empty Tool - Fixed typo in error message "No Empty File T specified"
should be "No Empty File specified"

--- 3.1.5 ---
SCS Curve number calculation and export to TUFLOW tool added (beta)
ReFH2 tool - ReFH2 engine 2.3 option added
ReFH2 tool - Added climate change options
ReFH2 tool - Added urban area input option
ReFH2 tool - Added version and BFIHOST19 input check
ReFH2 tool - Added engine version option
ARR tool - NSW datahub continuing loss multiplied by 0.4
ARR tool - let users set event independent continuing loss
ARR tool - now recognises NaN rainfall loss values from the datahub and sets
losses to zero
ARR tool - Fixed bug that miscalculated ARF for short durations for catchments
between 1 - 10km2
TUFLOW Viewer - Import FM timeseries results added
TUFLOW Viewer - Fixed bug that would incorrectly flag layers as 1D cross section
and cause QGIS to hang
TUFLOW Viewer - Customising plot 'select axes' dialog has nicer labels 'primary
axis' and 'secondary axis'
TUFLOW Viewer - Minimums fixed for TUFLOW Classic results when importing XMDF
TUFLOW Viewer - Fixed a bug in animation tool that would error when adding plots
if current time was already displayed in time series plot window
TUFLOW Viewer - Fixed an issue with connection signals trying to persist after
tuflow viewer is completely closed
TUFLOW Viewer - Fixed vertical profile plotting - broke with new python version
TUFLOW Viewer - For QGIS 3.16+ TUFLOW viewer now adopts absolute time as default
(internal workings - no change for users)
TUFLOW Utilities tool - Fixed the downloader - exe location was not being
correctly input
TUFLOW Utilities tool - Made further improvements to error checking
Import check files tool - Fixed bug in import all check files from a folder
where it would duplicate layers
Reload layer tool -  no longer produces an error for non-vector layers - it
still only works for vector layers
Many small bug fixes

--- 3.1.4.1 ---
Uninstalling plugin should now work unless the ReFH2 tool has been run

--- 3.1.4 ---
Prj string for shp files are retained with increment and import empty tools
Maximums in TUFLOWFV dat files now handled
Fixed bug that would cause python error when saving project after updating
colour ramp options for curtain plots
Utility download links updated to reflect new website
Fixed bug in ARR tool that would cause tool to crash when using probability
neutral losses

---  3.1.3 ---
Fixed 'Close TUFLOW Viewer completely
Fixed bug in curtain plots with quadtree results
Further plugin unloading improvements
Fixed a few bugs in batch export
Fixed bug where saving a project would stop user from being able to change zero
time (tuflow classic)

---  3.1.2.3 ---
Mulitple curtain plots (lines and result types) now supported - useful for
animations

---  3.1.2.2 ---
Batch export plot now supports selecting results not yet loaded into QGIS

---  3.1.2.1  ---
Fixed bug when curtain plotting TUFLOW FV results
Fixed datetime bug in animation tool

---  3.1.2  ---
XS viewer will now load null or blank entries
Depth time series added
Added reset all plot colours to settings menu
Fixed issue with unloading plugin
Fixed qgs temporal controller interaction
Fixed errors when saving and loading project settings
Fixed bug when plotting flow from cell centred netcdf results
Fixed bug for QGIS 3.14+ when using small output intervals
Fixed a couple of errors with loading default styles
Fixed bug in animation tool when adding a plot with a secondary axis
Fixed issue when loading in time series results with '[' in run name
TUFLOW styling will check style folder first before applying any defaults

---  3.1.1  ---
Fixed backward compatibility

---  3.1.0  ---
Compatible with QGIS temporal controller
Added new plotting types for 3D datasets
Added Cross section viewing capabilities
Added ability to load 1D hydraulic check files
Added particle tracking loading / viewing
Added further error checking / messaging to 1D integrity tool
Fixed bug in ARR tool that would occur when adding additional temporal patterns
with large catchments that required Areal TP
Fixed minor bug with case sensitivity when loading results through TCF file
Removed message window "appended .shp to output" from increment tool