# This file should be included when you package your plugin.

# Mandatory items:


[general]
name=TUFLOW
qgisMinimumVersion=3.6
description=A collection of utilities for TUFLOW flood and coastal simulation in QGIS
about=A collection of utilities for TUFLOW flood and coastal simulation in QGIS.
      Includes visualisation of results / inputs
      Editing tools
      Styling tools
version=3.3
author=Phillip Ryan, Ellis Symons, Pavlina Monhartova
email=support@tuflow.com

# end of mandatory metadata

# Optional items:

# Uncomment the following line and add your changelog entries:
changelog=--- 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

# tags are comma separated with spaces allowed
tags=TUFLOW, simulation, flood, hydraulic modelling, MDAL, mesh, xmdf, dat, 2dm, Australian Rainfall & Runoff, ARR, ReFH2

homepage=https://wiki.tuflow.com/index.php?title=TUFLOW_QGIS_Plugin
tracker=https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin/issues
repository=https://github.com/TUFLOW-Support/QGIS-TUFLOW-Plugin
icon=tuflow.png
# experimental flag
experimental=False

# deprecated flag (applies to the whole plugin, not just a single version)
deprecated=False

