QGIS ARR to TUFLOW: Difference between revisions
Content deleted Content added
| (34 intermediate revisions by 6 users not shown) | |||
Line 1:
The ARR to TUFLOW utility has been developed to help users set up a TUFLOW model that uses Australian Rainfall and Runoff (ARR) input parameters and the Australian Bureau of Meteorology (BOM) rainfall by automating the collection and processing of the data. The inputs and outputs of the tool are explained in detail below. '''''Note:''''' this tool helps with data processing, however is not a substitute to reading ARR. Similarly this wiki page discusses the use of the tool and the options, however context should be derived from ARR directly. Please see the [
__TOC__▼
<br>
▲__TOC__
=Getting Started=
===Installation===
Line 9 ⟶ 10:
===QGIS Version===
The ARR to TUFLOW tool is, for the most part
''Note:'' The tool does use QGIS for pre-processing tasks, such as area and centroid calculation as well as reprojection or cartesian to long-lat.
Line 22 ⟶ 23:
<li> Load a catchment GIS file (e.g. shp file) into QGIS - this can either be a polygon or point layer
<li> Open the '''ARR to TUFLOW''' tool
<li> Select the GIS catchment layer in '''Input Catchment File''' dropdown box.<br>
[[File: ARR_dialog_input_catchment_file_01a.png]]<br>
<li> Select the attribute field to use as the catchment name in the '''Unique Catchment Identifier Field''' dropdown.<br>
[[File: ARR_dialog_unique_catchment_identifier_01a.png]]<br>
<br>
<li> Select storm event combinations from the list of magnitudes and durations.<br>
[[File: ARR_dialog_storm_events_01a.png]]<br>
<br>
<li> Choose an output location.<br>
[[File: ARR_dialog_output_location_01a.png]]<br>
<br>
<li> Click '''OK''' and wait for the tool to finish.<br>
[[File: ARR_tool_complete_dialog_01a.png]]
</ol><br><br>▼
</ol>
=Output=
Line 70 ⟶ 76:
===Example: Using the outputs in a TUFLOW model===
* <u>[[QGIS_ARR_to_TUFLOW_Example | Example use of the ARR to TUFLOW tool]]</u>
<br>
=Additional Options=
===Climate Change===
Climate change options can be added by clicking on '''Edit''' under the climate change section. This opens up a table widget that the user can then add/remove climate change scenarios based on the guidance in ARR v4.2. Once a user adds a scenario (green plus), they can double click on the values to change them. For example, double clicking on SSP2-4.5 under the 'SSP' heading will show the available Shared Socioeconomic Pathway (SSP) options. Scenarios added in the table will be displayed in the climate change section (underneath the edit button). Note: each scenario name must be unique and generally the table widget will force unique names. The scenario names will be used throughout the outputs and the user is free to customise the scenario names as they want.<br>
The table columns within the table widget are based on ARR guidelines v4.2 and the examples presented in Book 1, Chapter 6. Please note the following assumptions:<br>
* Near-term horizon = 2030
* Medium-term horizon = 2050
* Long-term horizon = 2090
* Temperature Change - Setting this to -1 will adopt the temperature changes output in the climate change part of the ARR datahub download. If a value or zero or greater is set by the user, this will be adopted instead of the datahub values and it will be assumed that these are changes relative to the pre-industrial period. Note: the temperature change will be stopped from going negative within the calculation.
By adding climate change scenarios, the following outputs will be turned on:
* An extra boundary database file: '''bc_dbase_CC.csv'''
* Climate change inflows will be appended to the end of each event's inflow file
* One additional event option will also be added to the event file for each combination of selected climate change scenarios labelled
* The following CSV files will be written to the '''data''' output folder:
** ''<scen_name>_rainfall_factors.csv''
** ''<scen_name>_rainfall_depths.csv''
** ''<scen_name>_losses.csv''<br><br>
[[File: ARR_dialog_climate_change_01b.png]]<br><br>
[[File: ARR_example_climate_change_rf_inflow_01a.png|1200px]] <br><br>
[[File: ARR_example_climate_change_tef_01a.png]]
<br><br>
===Temporal Patterns===
Temporal pattern options can be found by expanding the '''Temporal Patterns''' section in the dialog.
* '''Manually Specify Point Temporal Patterns (csv)''' - lets the user specify the point temporal patterns which is expected to be in the ARR datahub format
* '''Manually Specify Areal Temporal Patterns (csv)''' - lets the user specify the arealtemporal patterns which is expected to be in the ARR datahub format
* '''Optional Additional Temporal Patterns''' -
** The user can choose to add temporal patterns from other temporal pattern regions. This is only if the user wishes to included ''additional'' temporal patterns. The temporal patterns from the catchment location (taken at the catchment centroid) will always be included. The additional temporal patterns will be included in the inflow files and added to the event file.
** The user can choose to add temporal patterns from other temporal pattern bins within the same region. For point temporal patterns, this would add temporal patterns from the 'frequent', 'intermediate', and 'rare' bins. For areal temporal patterns, this would add temporal patterns from other "Area" bins. The "correct" bin will always make up the first 10 temporal patterns (TP01 to TP10).
*** For Areal temporal patterns - The user has the additional option to choose how many additional areal temporal pattern sets to add. The default is 2 as this matches the number of additional point temporal patterns that would be added (but it doesn't necessarily have to be the same). The "Area" bins chosen will be the next closest in order.
[[File: ARR_Dialog_temporal_patterns_01a.png]]<br><br>
▲<br><br>
[[File: ARR_example_additional_temporal_patterns_rf_inflow_01a.png]]<Br><br>
[[File: ARR_example_additional_temporal_patterns_tef_01a.png]]<br><br>
===Rainfall===
<b><u>[https://data.arr-software.org/limb_specific LIMB Rainfall Data]</u></b><br>
Line 101 ⟶ 124:
<br>
If the user has selected AEP or durations outside of the provided LIMB data range, the tool will use BOM 2016 rainfall data. If the user has selected AEP or durations within the LIMB data range, but the value is not part of the provided IFD, the tool will interpolate the rainfall depth from the provided LIMB data.<br>
[[File:
===Rainfall Losses===
The following sections summarise the available loss options. Please note, as recommended in ARR2019, <u>[https://data.arr-software.org/ ARR datahub]</u> losses are only intended for rural use. They are not for direct use in urban areas. Furthermore, applications in New South Wales and Victoria should consider the following jurisdiction specific guidance:
''Since version v3.5 initial loss for durations greater than 72 hrs is assumed to be the same as the initial loss for 72 hrs. Previous to this version, these losses were output as zeros.''<Br>▼
* <u>[https://data.arr-software.org/nsw_specific NSW Specific Guidance]</u>
* <u>[https://data.arr-software.org/vic_specific VIC Specific Guidance]</u>
▲''Note: Since version v3.5 initial loss for durations greater than 72 hrs is assumed to be the same as the initial loss for 72 hrs. Previous to this version, these losses were output as zeros.''<Br>
=====Probability Neutral Losses=====
Probability neutral losses can be toggled on / off in the dialog (default is on). If 'on', this option will use probability neutral losses for the design burst initial loss rather than using the storm initial loss and pre-
[[File: ARR_dialog_probability_neutral_losses_01a.png]]
<br><br>
Line 117 ⟶ 145:
=====Pre-burst Percentile=====
The pre-burst percentile used to calculate design burst initial loss, or for pre-burst rainfall depth for the complete storm option, can be changed using the dropdown box in the dialog.<br><br>
[[File:
<br><br>
=====User Defined Losses=====
Users can use their own rainfall loss values. The initial loss value will be treated as a complete storm value and not just for the design burst. For most regions, the design burst loss will be calculated my removing the pre-burst depth from the input loss value. If probability neutral losses are available, the burst initial loss will be calculated using the following equation:<br>
: <tt>IL burst = User IL x IL ARR Prob Neutral / IL ARR Complete Storm</tt><Br><br>
[[File:
<br><br>
=====Event Independent Continuing Loss=====
The event independent continuing loss only affects how the TUFLOW output files are written. This option will remove the continuing loss variable and will instead input the value directly. Ths option was added since the continuing loss value is (currently) event independent and therefore simplifies the output and also makes editing this value easier.
Line 130 ⟶ 160:
=====Impervious Losses=====
The impervious loss value adds the impervious loss values to the materials.csv output. This option only affects the rainfall excess loss approach.<br><br>
[[File:
<br><br>
=====TUFLOW Loss Method=====
The loss method used by TUFLOW can be changed using the '''TUFLOW Loss Method''' dropdown box:
* '''Infiltration (soil file)''' - will output files for the infiltration approach in TUFLOW. This approach in TUFLOW applies the total rainfall to the 2D grid and ponded water in the 2D domain can then infiltrate based on the underlying soil type and impervious fraction. See <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> for more information.
* '''Rainfall Excess (material file)''' - will output files for the rainfall excess approach in TUFLOW. This approach removes the losses from the rainfall inflow prior to application so only excess rainfall is added to the model.
<br>
[[File:
<br><br>
=====Initial Losses For Durations Less Than 1 Hour=====
This selects the method for determining intial loss values for events less than 1 hr in duration:
* '''Interpolate to zero''' - will linearly interpolate loss values (assuming a loss value of 0 mm for 0 min)
* '''Log-Interpolate to zero''' - will use a log-linear interpolation (duration will use a log scale) (assuming a loss value of 0 mm for 0 min)
* '''Static Value''' - uses a user defined value for all event magnitudes
* '''Use 60 min Losses''' - uses the 60 min loss values
* '''Rahmen et al 2002''' - uses an equation determined by a study conducted by Rahmen et all in 2002
* '''Hill et al 1996:1998''' - uses an equation determined by a study conducted by Hill et all 1996:1998. This requires the user to provide a mean annual rainfall value.
* '''Interpolate pre-burst''' - will linearly interpolate pre-burst depths (rather than losses) (assuming a depth of 0 mm for 0 min)
* '''Log-Interpolate pre-burst''' - will use a log-linear interpolation on the pre-burst depths (duration will use a log scale) (assuming a depth of 0 mm for 0 min)
<br>
[[File:
<br><br>
<b>An example of the differences in initial losses from a few of the methods:</b><Br>
[[File: arr_to_tuflow_loss_interpolation.png]]
<br><br>
====Output Complete Storm====
The user can choose to output the complete storm (preburst + design burst) rather than just the design burst by checking on the following option (please see ARR Book 2 Chapter 5 [Section 5.9.9] for more information):<br>
[[File:
The complete storm generated by the tool will be the preburst depth (from the '''Preburst percentile''' extracted from the datahub) plus the design burst. The user will be required to select a preburst temporal pattern from the options listed below. The options below have been included at the request of users and are not a direct reference to any specific methodology outline in ARR. If you would like to see another method included, please email
Currently the ARR to TUFLOW tool supports the following preburst temporal pattern methods:
* '''Constant Rate''' - This will apply the preburst depth equally over a given time period. The time period can be specified as an absolute time (either as minutes or hours) or proprotional to the design storm e.g. a proportional value of 0.5 will apply a 30 min preburst to a 1 hr storm and a 15 min preburst to a 30 min storm.
* '''Temporal Pattern''' - This will apply the preburst depth using a temporal pattern obtained from the datahub for a given duration. The preburst duration can either be an absolute time or be proportional to the design storm. The user will need to select which temporal pattern to use (e.g. TP01, TP02,... TP10). Note: there is a minimum preburst duration of 10 min for this method.
** If "design burst" is selected, this will cause the pre-burst temporal pattern to use the same temporal pattern number as the design burst (e.g. TP01 design burst will use TP01 pre-burst, TP02 design burst will use TP02 pre-burst, etc.)
The initial loss value output in this method will be the raw storm initial loss value from the datahub with no post processing. Note, the complete storm option and using probability neutral losses are mutually exclusive and aren't able to be used together.<br>
Preburst temporal pattern and duration details are ignored if the "Use Complete Storm" checkbox is not selected.
<br><br>
====Why Is the Tool Outputting Negative Loss Values?====
The tool will output negative loss values when the preburst depth is greater than the storm initial loss. The tool will not floor loss values at zero since the value may be useful in helping the user determine the appropriate course of action. E.g. if IL = -1mm, this may be considered negligible and can be simply set to zero. An IL = -50mm may be considered significant enough that it simply can't be set to zero and alternate, or sensitivity runs, may need to be carried out, like using a <u
===Areal Reduction Factors===
Line 170 ⟶ 211:
* '''ARF for events < 50% AEP''' - this will calculate ARF values using the same equations used for larger events
<br>
[[File:
<br><br>
Line 178 ⟶ 219:
* '''Output Notation''' - users can toggle between '% AEP' and 'yr ARI' output notation.
<br>
[[File:
<br><br>
Line 186 ⟶ 227:
* BOM_raw_web_<catchment_name>.html
<br>
[[File:
<br><br>
Line 194 ⟶ 235:
* the tool can't access a network location
* there is no internet connection
* the ARR
A useful check if you're unsure if the issue is with the tool or with something else (like the Datahub), is to check if you can manually access and pull data from the Datahub for your catchment site.
<br><br>
The second step is to ensure you're using the latest version of the QGIS plugin.
===Issue With The Tool===
If there's an issue with the tool, or you are unsure, please contact <u>[mailto:support@tuflow.com support@tuflow.com]</u> for help. Please include a description of the problem, the log file, and the GIS catchment layer with your email.<br><br>
===Can't access the websites===
Sometimes the BOM or ARR Datahub websites are down or unable to be accessed by the tool (e.g. sometimes to manage traffic, the Datahub server will limit, or disallow scraping). The below are a set of instructions that can be used as a workaround should this occur:
*<u>[[ARR_DATAHUB_CANNOT_BE_ACCESSED | ARR
<br>
{{Tips Navigation
| |||