View source for TUFLOW SWMM Tutorial M03

= Introduction =
This tutorial, Module 3 of the TUFLOW SWMM tutorial dataset demonstrates how to add SWMM urban hydrology to a 1D / 2D SWMM stormwater pipe network, TUFLOW HPC catchment model. TUFLOW SWMM Tutorial Module 3 builds from the model created in <u>[[TUFLOW_SWMM_Tutorial_M02|TUFLOW SWMM Tutorial Module 2]]</u>. The completed TUFLOW SWMM Module 2 model is provided in the '''''TUFLOW_SWMM_Module_02\TUFLOW''''' folder of the download dataset as the starting point for this tutorial. If you are not already familiar with TUFLOW SWMM linking, we recommend first completing Module 1 and 2 before this tutorial. <br>

= Project Initialization =
==QGIS==
QGIS Version 3.34 or newer, and QGIS TUFLOW Plugin 3.9.0.49 or newer are required to access the SWMM Processing Tools described in the following sections. For installation, see <u>[https://wiki.tuflow.com/index.php?title=TUFLOW_QGIS_Plugin#Installation_of_Plugin Installation of TUFLOW Plugin]</u>.<br>
Define the Coordinate Reference System (CRS), also called ‘Projection’, for the QGIS workspace:
<ol> 
<li>Open QGIS.
<li>Go to Project > Properties… 
<li>In the CRS tab, type ‘WGS 84 / UTM Zone 60S’.
<li>Select the matching projection in the 'Predefined Coordinate Reference Systems' section.
<li>Click ‘Apply’ and ‘OK’.
<li>Ensure that the projection is set correctly by viewing the bottom right hand corner of the workspace. It should read ‘EPSG:32760’.
</ol>
<br>
{{Video|name=Animation_TS1_Initialization_01a.mp4|width=1235}}<br>

==TUFLOW Plugin==
Next we need to configure the QGIS TUFLOW Plugin settings to link with the project folder where we will build our model:<br>
<ol>
<li>Go to Plugins > TUFLOW > Editing > Configure / Create TUFLOW Project.
<li>Change the folder which contains TUFLOW to the '''TUFLOW_SWMM_Module_03''' folder. 
<li> Set the GIS Format to '''GPKG'''.
<li>Click 'OK' and save the workspace by selecting Project > Save As.<br>
<br>
'''<<image>>'''<br>
</ol>
<br>

==TUFLOW Model==
===Load and Style TUFLOW Model Files===
Load in the project GIS layers:
<ol>
<li>Click on the ‘Load TUFLOW Layers from TCF’ symbol from the TUFLOW Plugin toolbar.
<br>
[[File: Tuflow_plugin_load_tcf_layers.png]]<br>
<br>
<li>In File Explorer, navigate to the '''TUFLOW_SWMM_Module_03\TUFLOW\runs''' folder and select '''TS02_5m_001.tcf'''.
<li>In the Load Layers window, select:
* Ordering Options: Alphabetical
* Grouping Options: Group by control file
* Raster Load Options: Load Normally 
<li>Click ‘Open’ and ‘OK’.
</ol>
<br>
Style the TUFLOW layers. Suggested styling steps were provided in <u>[[TUFLOW_SWMM_Tutorial_M01#QGIS_Project_Initialization|TUFLOW SWMM Tutorial M01]]</u>. They have not been duplicated here.<br>
<br>
=== Increment TUFLOW GeoPackage File === 
Save a copy of TS02_001.gpkg with a new name (TS03_001.gpkg). This project initialization step is recommended so prior model versions from a project are not broken as a result of changes being made to GIS inputs.

<ol>
<li> Left click '''2d_sa_M01_001_L''' in the QGIS Layers panel.
<li> Select the TUFLOW Plugin '''Increment Selected Layer''' tool.
<li> Set the new Output Database name to '''TS03_001.gpkg'''.
<li> Scroll to the pre-filled entry in the "Incremented Layer" list. Set the new layer name to '''2d_sa_TS03_001_R'''. We will edit this layer in a later step of this tutorial.
<li> Select '''Remove Source Layer from Workspace'''.
<li> Select '''Increment Layer and Preserve Database'''.
<li> Select '''OK'''.
</ol>
'''<<image>>'''<br>

===Save QGIS Project Workspace===
Save the QGIS Workspace:
<ol>
<li>Go to Project > Save As.
<li>Navigate to the '''TUFLOW_SWMM_Module_03''' folder and type '''SWMM_M03''' as the filename with the extension .qgz.
</ol>
<br>

= SWMM Inputs =
==Create SWMM GeoPackage Spatial Database== 
We will create a new SWMM GeoPackage database for our pipe network feature entries:
<ol> 
<li>Go to '''Processing > Toolbox''' from the top dropdown menu options to open the Processing Toolbox Panel.
<li>Go to '''TUFLOW > SWMM''' in the processing tool list and select 'GeoPackage - Create'. This opens the dialog shown below.
:*To set the ‘CRS for GeoPackage’: Click the drop down menu and select ‘Project CRS: EPSG:32760 - WGS 84 / UTM zone 60S’.
:*To set the ‘Initial SWMM Sections’: Click the …, and tick on: 
:**'''Hydrology--Raingages''', '''Hydrology--Subcatchments'''
:*To define the ‘GPKG filename to create’: Click the …, select ‘Save to File’. Navigate to the '''TUFLOW\model\swmm''' folder and save the GeoPackage Database as '''sw03_001.gpkg'''.
''Note: In Module 1 we included '''Project--Options''' in the GeoPackage file. Project--Options define the SWMM simulation controls, such as hydrology computation timestep. Project--Options are not required in the new geopackage database we are creating for this Tutorial. This is because this model will be constructed from multiple SWMM input (INP) files: ''
''* The SWMM INP file created during Module 1 (road culverts).'' 
''* The SWMM INP file careted for Module 2 (underground pipe network inputs). ''
''* This Module's SWMM INP (SWMM urban hydrology).''
''When TUFLOW processes SWMM inputs, it combines the multiple INP files into one single INP prior to simulation. For this model, the simulation control parameters defined in the Module 1 '''Project--Options''' will apply. Options relevant to this tutorial that have already been defined in the Module 1 input were '''flow_units''':set to metric, '''infiltration''' method: set to Green Ampt,'''wetstep''' hydrology timestep: set to 1 minute and '''dry step''' hydrology timestep: set to 1 minute.'' <br>
<li>Click 'Run'.
<li>Once to tool has finished, click ‘Close’.
<li>In File Explorer, navigate to the '''TUFLOW\model\swmm''' folder and drag and drop '''sw03_001.gpkg''' into QGIS. 
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select 'Add Layers' to open all vectors within '''sw03_001.gpkg'''. By default, all items in the available list should have been selected. 
<li>In the QGIS Layers panel, move '''sw03_001.gpkg''' to the top of the list. This will ensure the data within this database file is displayed above all other layers in the project. 
<br><br>
'''<<Video>>'''
</ol>
<br>

== GIS Data Entry ==

A GeoPackage called '''Urban_Hydrology.gpkg''' is provided in the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. It contains one SWMM input layer: 
:*'''SWMM_Subcatchments''': defining the 1D SWMM urban hydrology subcatchment delineation and associated parameters.
It also contains a TUFLOW input layer
:*'''TUFLOW_Subcatchments''': defining the remaining 2D TUFLOW catchment hydrology subcatchment delineation.<br>

===SWMM===
To populate the SWMM GeoPackage created in the previous section:
<ol>
<li>In Windows Explorer, navigate to the '''TUFLOW_SWMM_Module_03\Tutorial_Data''' folder. Drag and drop the '''Urban_Hydrology.gpkg''' into QGIS. 
<li>When prompted by QGIS, under 'Options', tick on 'Add layers to group', then select '''Subcatchments'''. Click 'Add Layers'.
<li>In the QGIS Layers panel, right click on the '''Subcatchments''' layer and select 'Zoom to Layer'.
<li>Use the 'Select Features' tool to highlight all items included in '''Subcatchments'''.
<li>Select 'Edit' from the top QGIS tab and 'Copy Features' from the drop down menu. 
<li>Select the '''Hydrology--Subcatchments''' layer in the Layers panel by left clicking on it once. 
<li>Make the '''Hydrology--Subcatchments''' layer editable by clicking the 'Toggle Editing' symbol [[File:toggle_editing_icon.png|27x27px]].
<li>Select 'Edit' from the top QGIS tab and click 'Paste Features' from the drop down menu.
<li>Toggle the editing off to save the edits.
<li>Remove '''Urban_Hydrology.gpkg''' from QGIS.
<br><br>
'''<<Video>>'''<br>
<br>
</ol>

===TUFLOW===
The TUFLOW entry requires more than simply, Copy/Pasting. The GIS data transfer will be covered later in the TUFLOW Hydrology section of this tutorial.

==GIS Data Updates==
===Update SWMM Hydrology--Raingage===
The information within '''Hydrology--Raingage''' (Note: 'Gage' is the American spelling of 'Gauge' in Oxford English) defines the pluviographs in the catchment. We will link to two different rain gages in this example. 

<ol>
<li> In the QGIS Layers panel, select (left click) Hydrology--Raingage and toggle on editing.
<li> Right click Hydrology--Raingage and select 'Open Attribute Table'.
<li> Click 'Add Feature'. Enter the following attributes (leave all other fields as NULL):
{| class="wikitable" width="60%"
!style="background-color:#005581; font-weight:bold; color:white;"| Name 
!style="background-color:#005581; font-weight:bold; color:white;"| Form 
!style="background-color:#005581; font-weight:bold; color:white;"| Intevl 
!style="background-color:#005581; font-weight:bold; color:white;"| SnowCatchDeficiency
!style="background-color:#005581; font-weight:bold; color:white;"| Format 
!style="background-color:#005581; font-weight:bold; color:white;"| Tseries 
|-
| RF_G1 || Volume || 0.15 || 1 || TIMESERIES || RF_FC04 
|-
| RF_G2 || Volume || 0.15 || 1 || TIMESERIES || RF_FC07 
|}
Remaining attributes remain blank.<br>
SWMM entries are case sensitive. If the input above uses upper case, please double check your data entry does too. 
<li> Turn off editing and save the information.
</ol>

For a summary of the attributes associated with '''Hydrology--Raingage''', refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Raingages TUFLOW 2023-03-AD Release Notes (Table A.11)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]</u>.

===Update SWMM Hydrology Subcatchments===
<ol>
<li>Inspect the attribute information within '''Hydrology--Subcatchments''' to familiarize yourself with the data. A summary of the attributes associated with the Layer, refer to <u>[https://docs.tuflow.com/classic-hpc/release/2023-03-AD/SWMM-Input-Detailed-1.html#tab:tab-SWMM-Input-Subcatchments TUFLOW 2023-03-AD Release Notes (Table A.38)]</u> and the <u>[https://downloads.tuflow.com/SWMM/SWMM5_Reference_Manual_Volume1_Hydrology_P100NYRA.pdf SWMM5 Reference Manual - Volume 1 (Hydrology)]</u>. 
<li> All required data entries have been pre-filled in the supplied dataset except the Area information. SWMM requires the hydrology subcatchment area information in hectares.
<li>

<li> Select Area and the update field.
<li> Typic the claculation expression: $area / 10000
<li> Click, Update All

<br><br>
'''<<Video>>'''<br>
</ol>

===SWMM Options===

===TUFLOW Hydrology Subcatchments===

== Export SWMM INP File ==
We will now create a new INP file for the SWMM pipe network inputs. To do this, we need to convert '''sw03_001.gpkg''' into a SWMM INP file.

<ol>
<li>In the Processing Toolbox, go to TUFLOW > SWMM and select 'GeoPackage - Write to SWMM inp'. This opens the dialog shown below.
:*GeoPackage Input File: Navigate to the '''TUFLOW\model\swmm''' folder and select '''sw03_001.gpkg'''.<br>
<li>By default, this tool will save the SWMM inp file in the same folder location and with the same name as the GeoPackage input file. In this case, it will save '''sw03_001.inp''' to the '''TUFLOW\model\swmm''' folder. 
<li>Click 'Run'.
<li>Once the tool is finished, click 'Close'.
<br><br>
'''<<Video>>'''
<br>
</ol>

==TUFLOW Boundary Updates==

Comment our direct rainfall

Add SA_RF

==TUFLOW Geometry Update==
=Simulation Control Files=
==TUFLOW Control File (TCF)==
==TUFLOW Geometry Control File (TGC)==
==TUFLOW Boundary Control File (TBC)==
==TUFLOW SWMM Control File (TSCF)==
=Running the Simulation=
=Check Files and Results Output=