ARR to TUFLOW¶
Experimental
This tool is labelled experimental. Outputs should be checked carefully.
The layout and functionality of the tool may change in a future version without providing backward compatibility to prior functionality.
Feedback is welcome. During the initial phases of the tool's release, feedback will greatly influence the functionality and look of this new version of the tool. Contact support@tuflow.com with any feedback.
The
ARR to TUFLOW tool converts Australian Rainfall and Runoff rainfall and loss data from the ARR Data Hub into TUFLOW model input files (Event_File.tef, bc_dbase.csv, rf_inflow/*.csv, .tsoilf).
This tool is a clean rewrite of the ARR to TUFLOW tool, now referred to as the ARR to TUFLOW (legacy) tool. The rewrite allows the legacy tool to co-exist, enabling backward compatibility and an easy access point to the legacy ARR Data Hub. This also allows the replication of outputs from the tool prior to the 2026 v1 ARR Data Hub update.
Usage¶
The ARR to TUFLOW tool can be opened by clicking the icon in the plugin toolbar.
The new tool and legacy tool share the same toolbar spot
Use the drop down arrow to switch between the new and legacy ARR to TUFLOW tools.
The ARR to TUFLOW tool window is split into several tabs for different setting groups. At its simplest, only the Required Settings tab needs to be reviewed and all other tabs can be left as default, noting that defaults aren't necessarily going to be best for all catchments or in perpetuity.
Below is a basic workflow to run the tool. For further details on the inputs, refer to the Configuration Options section of the documentation.
- Load a catchment GIS polygon file into QGIS.
- Select the catchment layer in the Populate table from layer combobox and the select the naming field in the Catchment identifier field combobox.
-
Click to populate the catchment table with the catchment.
-
Select an output location for the TUFLOW files.
-
Select at least one AEP and one duration event.
-
Click Run and wait for the tool to finish.
Outputs¶
The tool outputs (with the exception of the working_data outputs) are identical to the legacy tool. The
following example on the TUFLOW Wiki shows the outputs and how they can be used in a TUFLOW model:
wiki.tuflow.com/QGIS_ARR_to_TUFLOW_Example
Log¶
Logged messages are written to the Log widget at the very bottom of the tool. Messages will not be cleared when the tool is run, and new messages will be appended at the bottom after messages from any previous runs. Messages will not be saved between QGIS sessions and the log widget will be cleared if QGIS is closed.
If an error or warning occurs, the log widget will automatically expand showing the error/warning message. It is also considered good practice to open the log widget, even after a successful run, to check for informational messages.
Messages produced by the interface are also written here. Checking the log widget for any messages is a good place to start when troubleshooting any aspect of the tool.