View source for TUFLOW Viewer

=TUFLOW Viewer=
TUFLOW Viewer replaces Crayfish and TUPLOT as the TUFLOW result viewer for QGIS for version 3.6 onwards. It uses the Mesh Data Abstraction Library (MDAL) available in QGIS to display and interact with TUFLOW map output results, and the TUFLOW results python library (the same library used by TUPLOT in earlier versions of QGIS) for viewing TUFLOW time series results.<br>
=How To Use=
==Basics==
Some of the basic functionality are listed below this section and describe how to:<br>
<ol>
<li> [[ #Loading_Results | Load Results ]]
<li> [[ #Changing_Result_Type | Change Result Type ]]
<li> [[ #Showing_Maximum | Show Maximum ]]
<li> [[ #Showing_Vectors | Show Vectors ]]
<li> [[ #Styling_Layer | Style Layer ]]
<li> [[ #Saving_Default_Style | Save As Default Style ]]
<li> [[ #Plotting_From_Map_Outputs | Plot From Map Outputs ]]
<ol>
<li> [[ #Time_Series | Time Series ]]
<li> [[ #Cross_Section | Cross Section / Long Plot ]]
<li> [[ #Plotting_Flow | Flow ]]
<li> [[ #Clear_Plot | Clear the Plot and Graphic Layers (coming soon) ]]
</ol>
<li> [[ #Plotting_From_Time_Series_Outputs | Plot From Time series Output ]]
<li> [[ #Using_a_Secondary_Axis | Use a Secondary Axis ]]
<li> [[ #Changing_Plot_Properties | Change Plot Properties ]]
<li> [[ #Export_Plot | Export The Plot as an Image or CSV (coming soon) ]]
</ol>

==Advanced==
Some more advanced use is described in the following pages:
<ol>
<li> Animations (coming soon)
<li> Maps (coming soon)
<li> Using a Date Axis (coming soon)
<li> Importing Calibration Data (coming soon)
<li> Batch Exporting Plots (coming soon)
</ol>

=Loading Results=
'''Option 1'''
: '''File >> Load Results'''<br>
'''Option 2'''
: Right Click in '''Open Results >> Load Results'''<Br>
<br>
There are 3 options for loading in results:
<ol>
<li> '''Load Results''' --> This is done via a TCF, TLF, or FVC file and will load in all results (Map Outputs and Time Series)
<li> '''Load Results - Map Outputs'''  --> Select map output mesh results file (*.xmdf, *.dat, *.2dm, *.xmdf.sup, *.dat.sup)
<li> '''Load Results - Time Series'''  --> Select time series output results (*.tpc)
</ol>
<br>

[[File:LoadingResultsTCF.gif]]<br>
<br>

=Changing Result Type=
As simple as selecting a different result type in '''Result Type''' panel. You can only display one '''Scalar''' results and one '''Vector''' result at any given time.
<br><br>
[[File:ChangingResultType.gif]]<br>
<br>

==Showing Maximum==
'''Option 1'''
: Click the '''double up arrow''' next to the result type<Br>
'''Option 2'''
: '''Right click''' the result type >> Check on '''Maximum'''<Br>
<br>
[[File:ToggleMax.gif]]<Br>
<br>

==Showing Vectors==
Select one of the '''Vector''' result types in the '''Result Types''' panel<Br>
<br><br>
[[File:ToggleVectors.gif]]<Br>
<br>

=Styling Layer=
'''Option 1'''
: '''Right Click''' mesh layer in '''Layers Panel''' >> '''Properties... >>''' Navigate to the '''Contour Tab''' at the top '''>>''' Select Colour Ramp in drop down box '''>>''' Click '''Load''' >> Click '''OK'''<br>
'''Option 2'''
: '''Right Click''' result type in '''Result Type Panel''' >> '''Properties... >>''' Navigate to the '''Contour Tab''' at the top '''>>''' Select Colour Ramp in drop down box '''>>''' Click '''Load''' >> Click '''OK'''<br>
<br>
<br>
[[File:ChangeStyles.gif]]<br>
<br>

=Saving Default Style=
Saving a default style for a result type will mean that every time a result type of that name e.g 'Depth' is loaded, TUFLOW Viewer will automatically apply that style.<br>
<br>
There are 2 options:
<ol>
<li> Save Colour Ramp --> This will save the particular colour ramp as default. This means the actual min / max values will be adjusted based on the results. This is useful for results such as '''Bed Elevation''' or '''Water Level''' where the ranges are usually different depending on the model's location
<li> Save Colour Map --> This will save the exact values and associated colours used in the styling. This might be useful for results such as '''Depth''' or '''Velocity''' where a template can be applicable across different models
</ol>
<br>
: '''Right Click''' the result type '''>> Save Style As Default >> Colour Ramp'''<br>
<br>
[[File:SavingDefaultStyles.gif]]<br>
<br>

=Plotting From Map Outputs=
==Time Series==
You can plot one or multiple temporal map output results as a time series.
<ol>
<li> Choose which map outputs to plot --> click on the time series graph down arrow under '''Map Output Plotting''' >> Check on desired result types
<li> Click off the menu
<li> Click the time series graph again (not the down arrow)
<li> Click somewhere on your results
</ol>
<br>
[[File:MapOutputPlotting TS.gif]]<br>
<br>
==Cross Section==
You can plot one or multiple map output results as a cross section for the current time step.
<ol>
<li> Choose which map outputs to plot --> click on the cross-section graph down arrow under '''Map Output Plotting''' >> Check on desired result types
<li> Click off the menu
<li> Click the cross-section graph again (not the down arrow)
<li> Left click somewhere on your results to start the cross-section
<li> Left click to add vertices to your cross-section polyline
<li> Right click to finish
</ol>
<br>
[[File:MapOutputPlotting CS.gif]]<br>
<br>

==Plotting Flow==
You can post calculate flow from the map output results. Note that this approach should be used for approximation only. The preferred method is to use a PO line in TUFLOW.
<ol>
<li> Click on the '''Plot Flux''' button down arrow under '''Map Output Plotting'''
<li> Left click somewhere on your results to start the flux line
<li> Left click to add vertices to your flux line
<li> Right click to finish
</ol>
<br>
[[File:MapOutputPlotting Q.gif]]<br>
<br>

=Plotting From Time Series Outputs=
If time series results are loaded in (e.g. 1D results) you can plot from the outputted types.
<ol>
<li> Select result type e.g '''Flow''' under the ''Time Series'' section in the '''Result Types'''
<li> Use QGIS ''Select Tool'' and select one of the '''PLOT''' GIS features
</ol>
<br>
[[File:TimeSeriesPlotting Q.gif]]<br>
<br>

=Using a Secondary Axis=
If you are plotting multiple result types at once, you may want to plot one or more of the lines on a secondary axis. This can be done 2 ways:<br>
'''Option 1'''
: Click the ''Secondary Axis'' icon on the appropriate result type in the '''Result Types Panel'''<br>
'''Option 2'''
: '''Right Click''' on the appropriate result type in the '''Result Types Panel''' and check on '''Secondary Axis'''<br>
<br>
[[File:ToggleSecondaryAxis.gif]]<br>
<Br>

=Changing Plot Properties=
Plot properties can be changed via<br>
'''Option 1'''
: TUFLOW Viewer '''Settings >> Customise'''<br>
'''Option 2'''
: '''Customise''' tool icon in the plot toolbar<br>
<br>
Using this, properties such as the plot axis, item name in legend, and line / point styling can be modified.<br>
<br>
[[File:PlotProperties 1.gif]]<br>
<br>
[[File:PlotProperties 2.gif]]<br>
<br>
[[File:PlotProperties 3.gif]]<br>
<br>
[[File:PlotProperties 4.gif]]<br>
<br>