Tuflow

TUFLOW Viewer: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
No edit summary
 
(241 intermediate revisions by 9 users not shown)
Line 1:
TUFLOW Viewer replaces Crayfish and TUPLOT as the TUFLOW result viewer for QGIS<u>[[QGIS_Tips for| QGIS]]</u> (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>
<br><br>
__TOC__
<br>
__TOC__
=Getting Started=
==Installation==
TUFLOW Viewer is a free tool that comes as part of the TUFLOW plugin in QGIS. For instructions on how to install the plugin, read the following wiki page:<br><br>
[[TUFLOW_QGIS_Plugin#Installation_of_Plugin | How to install the TUFLOW plugin]]<br><br>
There are also instructions on installing plugins in the QGIS documentation - if you choose to follow the QGIS documentation, the plugin is called "TUFLOW" in the repository:<br><br>
[https://docs.qgis.org/3.16/en/docs/training_manual/qgis_plugins/fetching_plugins.html Link to QGIS Documentation - Installing and Managing Plugins]<br><br>
 
=Getting Started=
==QGIS Version==
<b>''A few notes on the recommended QGIS version:''</b><br>
 
It is generally recommended to use the latest version of QGIS. The reasons for this are:
* TUFLOW Viewer is developed using the latest version, and although backwards compatibility is maintained as best as possible, TUFLOW Viewer is generally tested mostmore frequently on the latest QGIS version.
* The mesh data provider (MDAL) and the temporal controller (which now underpins the mesh datasets in QGIS) are both relatively new in comparison to other libraries (e.g. GDAL) and are therefore generally updated more regularly updated with new features, enhancements, and bug fixes whichby arethe QGIS developers. TUFLOW Viewer takentakes advantage of bythese TUFLOW Viewerupdates.<br>
 
Although TUFLOW Viewer has been developed in an attempt to havebe consistent behaviour across QGIS versions, it is not always possible. andSome QGIS developments and behaviour changes have leadled to TUFLOW Viewer behaviour also changing either through necessity or to keep in-line with the QGIS development direction. The below is a current list of known behaviour changes due to QGIS version:<br>
<ol>
<li> '''Date-time format within TUFLOW Viewer''' - QGIS 3.14 introduced the '''temporal controller'''<br>
* priorPrior to QGIS 3.14, TUFLOW Viewer stored all results internally as relative time. and theThe user could display as date-time and the reference time by changing '''Zero Date''' in '''Settings >> Options'''.
* QGIS 3.14, TUFLOW Viewer tried to mimmickmimic the behaviour of previous versions but the reference time could also be altered natively in the mesh layer '''Properties'''. Note on this version, this is the first QGIS release with the '''temporal controller''' and as a consequence some of the functionality matured and changed in subsequent versions. Users may experience strange behaviour when using TUFLOW Viewer with the versionQGIS 3.14 if using date-time format. It is recommended to upgrade to later versions of QGIS if date-time format is required.
* postPost QGIS 3.14 TUFLOW Viewer stores all results internally as absolute time and the user must change the reference time in the native properties of the mesh layer to alter the dates being displayed. '''Zero Date''' now only changes how the relative time is displayed in TUFLOW Viewer and doesn't change the mesh layer reference time.
* Please follow the link below on how to use isodate (date-time) format in TUFLOW Viewer in QGIS 3.16+ (recommended minimum version if using date-time format): <bru>[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format | Working With Isodate (Date-Time) format]]</u>.
</ol>
: [[TUFLOW_Viewer#Working_With_Absolute_Time_.28Date-Time.29 | Working With Absolute Time (Date-Time)]]
</ol><br>
 
'''Other Known Issues'''<Br>
==Opening TUFLOW Viewer==
* QGIS 3.24 uses Matplotlib v3.5.1 which contains the following known bug which may affect users when re-labelling datasets within the TUFLOW Viewer plot window:<Br>
Once the TUFLOW plugin is installed, the TUFLOW Viewer tool can be opened by clicking the following icon in the plugin toolbar:<br>
: [[TUFLOW_Viewer_Matplotlib_v3.5.1_Bug | TUFLOW Viewer - Matplotlib v3.5.1 bug]]<br>
[[File: TUFLOW_Viewer_In_Toolbar.PNG]]<br><br>
* "ValueError: Failed to find font DejaVu Sans:style=normal:variant=normal:weight=normal:stretch=normal:size=10.0, and fallback to the default font was disabled"
: [[TUFLOW_Viewer_Matplotlib_Font_Error | TUFLOW Viewer - Matplotlib Font Error]]<br>
 
==Installation or Version Upgrade==
==Upgrading The Plugin==
===Installation===
It's recommended to upgrade the plugin whenever a new version is released. The upgrade process is typically done via the Plugin Manager.<br>
TUFLOW Viewer is a free tool that comes as part of the TUFLOW plugin in QGIS. For instructions on how to install the plugin, please follow these steps: <u>[[TUFLOW_QGIS_Plugin#Installation_of_Plugin |Installation of Plugin]]</u>.<br>
There are also instructions on installing plugins in the QGIS documentation - if you choose to follow the QGIS documentation, the plugin is called "TUFLOW" in the repository: <u> [https://docs.qgis.org/3.16/en/docs/training_manual/qgis_plugins/fetching_plugins.html Link to QGIS Documentation - Installing and Managing Plugins]</u>.<br>
 
===Plugin Upgrades===
===Error While Upgrading the Plugin===
It's recommended to upgrade the plugin whenever a new version is released. The upgrade process is typically done via the Plugin Manager ('''QGIS Drop Menu: Plugins >> Manage and Install Plugins''').<br>
[[ TUFLOW_QGIS_Plugin#Error_While_Upgrading_Plugin | Error_While_Upgrading_Plugin ]]<br>
<br>
[[File: TUFLOW_Plugin_Update_01.png]]<br><br>
If you encounter an error while upgrading the plugin please follow these steps: <u>[[ TUFLOW_QGIS_Plugin#Error_While_Upgrading_Plugin | Error While Upgrading Plugin ]]</u>.
 
==Development Version==
==Getting a Python Error==
It's possible to test out the latest development version of the plugin and TUFLOW Viewer by following the instructions here: <u>[[Installing_the_Latest_Development_Version_of_the_TUFLOW_Plugin | Installing the Latest Development Version of the TUFLOW Plugin]]</u>.
Occasionally the TUFLOW plugin will throw an exception and this will produce a '''Python Error''' which is displayed either as a yellow banner at the top of the map window or a window may appear stating than an 'Error has occurred while executing Python code'.<br>
[[File: PythonError.PNG]]<br>
===What Does This Mean?===
This means that the TUFLOW plugin has encountered something unusual or a situation that it does not know how to handle i.e. it has reached a line in the code that has failed to execute and as a consequence Python has bailed out. This means that all the code below this point that was meant to be executed has not. This can have knock on consequences as variables may not exist or be set to incorrect values and signal handling (e.g. what happens when a menu item is clicked) may be broken. So a python error can lead to further python errors that would normally not have occurred, so the first python error is usually the most important.<br>
 
=Using TUFLOW Viewer=
===What To Do===
==Opening the TUFLOW Viewer==
<ol>
After installing the QGIS TUFLOW plugin, the TUFLOW Viewer tool can be opened by clicking the following icon in the plugin toolbar:<br>
<li> Email the '''Stack Trace''' to [mailto:support@tuflow.com support@tuflow.com] with a description of the steps that produced the python error (as best you can describe it). This is to help us identify bugs and fix the plugin so that it catches this exception in the future.
<br>
<li> If you find that you are now experiencing further python errors (probably caused by the initial error) you can try the following in order of severity:
[[File: TUFLOW_Plugin_Toolbar_TUFLOW_Viewer_01.png]]<br>
<ol>
<li> On the TUFLOW Viewer menu bar '''File >> Reload TUFLOW Viewer''' - this will reload TUFLOW Viewer, resetting all variables and signals. You will be required to load in any time series results again and other settings may also be reset. Map output results will remain in the workspace and be reloaded into TUFLOW Viewer.
<li> Save the workspace (.qgz) and restart QGIS
<li> Restart QGIS - you can save the workspace (.qgz), however you should first select on the TUFLOW Viewer menu bar '''File >> Close TUFLOW Viewer Completely''' - this will close the viewer and also remove all settings associated with it from the workspace so that the problematic variable is not accidentally reloaded with the workspace
<li> The nuclear option - Restart QGIS and load a new workspace from scratch (do not load a saved workspace)
</ol>
</ol><br><Br>
 
==Loading Results==
ResultsTUFLOW simulation results can be loaded severaltwo ways:<br><br>
<ol>
'''Option 1'''
:<li> Select '''File >> Load Results''' from the TUFLOW Viewer drop down menu.<br>
'''Option 2'''
: Right Click in '''Open Results >> Load Results'''<Br>
<br>
[[File:TUFLOW_Viewer_Load_Results_01a.png]]<br>
The following options are available for loading into TUFLOW Viewer:
<br>
<li> Right Click in the '''Open Results''' panel and select '''Load Results'''.<br>
<br>
[[File: TUFLOW_Viewer_Load_Results_02a.png]]<br>
<br>
</ol>
Using either of the above methods, the following result load options are available:
<ol>
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results | Load All Results]]'''</u> --> This is done via a TCF, TLF, or FVC (TUFLOW FV)TLF file and will load in all results (Map Outputs and ESTRY Time Series). ''Note: the Load All Results feature is not yet enabled for TUFLOW FV FVC files.''
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Map_Outputs | Load Results - Map Outputs]]'''</u> --> Select map output mesh results file ('''*.xmdf, *.dat, *.2dm, *.xmdf.sup, *.dat.sup, *.nc''' ''(supports netCDF format from TUFLOW FV output only)'').
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Time_Series | Load Results - Time Series]]'''</u> --> Select ESTRY / SWMM time series output results ('''*.tpc *.gpkg''').
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Time_Series_FM | Load Results - Flood Modeller Time Series FM]]'''</u> --> Load Flood Modeller results. This requires a '''*.gxy''' and result '''*.csv''' file to be exported from Flood Modeller.
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Particles | Load Results - ParticlesParticle Tracking Module]]'''</u> --> Select output from particle module ('''*.nc''') which will typically be suffixed with '''_ptm'''.
<li> <u>'''[[TUFLOW_Viewer_-_Import_1D_Hydraulic_Tables_Load_Results_-_NetCDF_Grid | ImportLoad 1DResults Hydraulic- NetCDF TablesGrid]]'''</u> --> SelectLoad aTUFLOW '''_1d_ta_tables_check.csv'''NC checkor fileHRNC map output results.
<li> <u>'''[[TUFLOW_Viewer_-_Import_1D_ESTRY_Cross_-_Sections_Import_1D_Hydraulic_Tables | Import 1D ESTRYHydraulic Cross-SectionsTables]]'''</u> --> ThisSelect willa automatically'''_1d_ta_tables_check.csv''' happencheck if an appropriate TUFLOW input is opened in QGIS while TUFLOW Viewer is open (efile.g. 1d_xs)
<li> <u>'''[[TUFLOW_Viewer_-_Import_2D_BC_Tables | Import 2D BC Tables]]'''</u> --> Select a '''_2d_bc_tables_check.csv''' check file.
<li> <u>'''[[TUFLOW_Viewer_-_Import_1D_ESTRY_Cross_-_Sections | Import 1D ESTRY Cross-Sections]]'''</u> --> This will automatically happen if an appropriate TUFLOW input is opened in QGIS while TUFLOW Viewer is open (e.g. 1d_xs).
<li> <u>'''[[TUFLOW_Viewer_-_Importing_a_User_Defined_Time_Series_To_Display_On_The_Plot | Importing a User Defined Time Series Dataset To Display In The Plot Window]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Import_FV_Tide_BC_NetCDF | Import FV Tide BC NetCDF]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Loading_Results_While_TUFLOW_is_Running | Loading Results While TUFLOW is Running]]'''</u>
</ol>
<br>
[[File: LoadResults_Eg_img.PNG]]<br>
 
===Troubleshooting===
'''If I Receive an Error?'''<br>
If you receive an error similar to that shown below when tryingattempting to load results from a TCF you will need to fix the encoding of your TUFLOW control files:<br>
<pre>
UnicodeDecodeError: 'utf-8' codec can't decode byte 0x92 in position 626: invalid start byte
</pre>
This usuallyerror resultsis fromcaused inconsistentby incompatible encoding of the TUFLOW control files. You can fixresolve this issue by changing the encoding of all your TUFLOW control files to a single type - (typically UTF-8). You can do this using Notepad++,. pleasePlease see belowthe following link for instructions on how to do this (refer last image): <u>[[TUFLOW_Message_0060 | TUFLOW Message 0060]]</u>.<br>
 
[[TUFLOW_Message_0060]]<br>
== TUFLOW-SWMM Results ==
Results from a linked TUFLOW-SWMM model can be loaded via the standard menu options (available from the TUFLOW plugin version 3.10):
* <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Time_Series | Load Results - Time Series]]'''</u> To load the GPKG time series format (_swmm_ts.gpkg) by itself. The GPKG time series format is a new format similar to the .tpc with some additional functionality. More information can be found in the <b><u>[[#GPKG_Time_Series_Format | GPKG Time Series Format]]</u></b> section.
* <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Map_Outputs | Load Results - Map Outputs]]'''</u> To load in 2D map output results
* <u>'''[[TUFLOW_Viewer_-_Load_Results | Load Results]]'''</u> To load all available results from the model. This includes .xmdf, .tpc, and .gpkg results which could all be available for a given model run. Note that .tpc and .gpkg are both time series type results and will load separate GIS _PLOT_ layers.
 
== GPKG Time Series Format ==
The GPKG time series format is a new format similar to the .tpc with enhanced temporal functionality. Currently the GPKG time series format is only supported as an output from SWMM in TUFLOW-SWMM linked models and only supported in TUFLOW Plugin version 3.10+ and QGIS 3.16+.<Br>
<br>
The GPKG format is different from the TPC format as it supports temporal styling in QGIS. As an example, the line width of the channels can be varied by both time and flow, with wider lines showing higher flow than thinner lines at a particular timestep. The format is fully compatible with the QGIS temporal controller and reacts dynamically as the temporal controller is updated. This results in a dynamic, and intuitive, method of showing the user the flood progression in the 1D system. Another benefit of being compatible with the core QGIS temporal capabilities is that the styling will also be dynamically updated if included in an animation export. TUFLOW Viewer's animation export tool has been updated to enable GPKG results to be exported with 2D results or even by itself.<br>
<br>
The layer's styling can be automatically set using the TUFLOW Plugin via the layer's right-click context menu (under the TUFLOW submenu) or will automatically by styled if the results are loaded via TUFLOW Viewer. Examples of this format in QGIS are linked below:
* <b><u>[[Automatically_Styling_GPKG_Time_Series | Styling layers from the GPKG time series output]]</u></b>
* <b><u>[[TUFLOW_Viewer_-_Load_Results_-_GPKG_Time_Series | Loading results via TUFLOW Viewer]]</u></b>
The GPKG time series format is an open format and the specification is detailed at the below link:
* <b><u>[[GPKG_Time_Series_Format_Specification | GPKG Time Series Format Specification]]</u></b>
 
== Data Selection, Display and Styling==
=Map Outputs=
===Map Output===
Map outputs are the 2D result outputs from TUFLOW (or 3D outputs from TUFLOW FV). Basic interaction with the map output results in TUFLOW Viewer are described below:
Map Outputs are the time varying 2D result outputs from TUFLOW (or 3D outputs from TUFLOW FV). Data selection, display, styling and plotting instructions for Map Output results in TUFLOW Viewer are described below:
<ol>
<li> Load Map Output results either via:
<ol>
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Changing_Results_Load_Results | ChangeLoad All Results]]''' --</u>, changing between different simulation results is done by selecting the result name(s) in the 'Open Results' widgetor
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs__Load_Results_-_Changing_Result_Type_Map_Outputs | ChangeLoad ResultResults Type- Map Outputs]]''' --</u> changing between different result types is done using the 'Result Type' widget
</ol>
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Displaying_Maximum | Display Maximum]]''' --> if available, maximums can be toggled on/off for the different result types
<li> <u>'''[[TUFLOW_Viewer_-_Reload_Results | Reload Results]]'''</u> --> Reload and update results
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Displaying_Vectors | Display Vectors]]''' --> vector results can be displayed in combination with any of the scalar result types e.g. velocity vectors can be displayed with depth
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Styling_Scalar_Types_Change_Result_Selection | StyleChange ScalarSimulation MapResult OutputsSelection]]'''</u> --> stylingChanging scalarbetween mapdifferent outputsimulation results is similardone toby stylingselecting rasterthe layers in QGIS and can be done via QGIS propertiesresult name(right click >> propertiess) or pressing F7 to openin the properties'Open dockingResults' windowwidget.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Styling_Vector_Types_Changing_Result_Type | StyleChange VectorResult MapType OutputsSelection]]'''</u> --> similarChanging tobetween thedifferent stylingresult thetypes scalaris mapdone outputs,using therethe are'Result a range of options for styling the vectorType' layerswidget.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Saving_Default_Styles_Displaying_Maximum | SaveDisplay DefaultResult StylesMaximum]]'''</u> --> usersIf available, maximums can savebe defaulttoggled styleson/off for the different result types so that they are automatically applied each time results are imported using TUFLOW Viewer.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Displaying_The_Mesh_Displaying_Vectors | Display The MeshVectors]]'''</u> --> theVector quickestresults waycan tobe toggledisplayed thein meshcombination iswith toany clickof the gridscalar boxresult intypes (e.g. velocity vectors can be displayed TUFLOWwith Viewerdepth).
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaging_Method_Styling_Scalar_Types | 3DStyle to 2DScalar DepthMap AveragingOutputs]]'''</u> --> ForStyling 3Dscalar map output results, theis 3Dsimilar to 2Dstyling depthraster averaging method can be changedlayers in the layer propertesQGIS.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Styling_Vector_Types | Style Vector Map Outputs]]'''</u> --> Similar to the styling the scalar map outputs, there are a range of options for styling the vector layers.
<li> '''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps | Locking Output Timesteps to Map Output Only]]'''
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Saving_Default_Styles | Save Default Styles]]'''</u> --> Users can save default styles for result types so they are automatically applied each time results are imported using TUFLOW Viewer.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Displaying_The_Mesh | Display The Mesh]]'''</u> --> The quickest way to toggle the mesh is to click the grid box in TUFLOW Viewer.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaging_Method | 3D to 2D Depth Averaging]]'''</u> --> For 3D map output results, the 3D to 2D depth averaging method can be changed in the layer properties.
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps | Lock/Unlock Output Time Steps from Different Result Datasets]]'''</u> --> Locking Plot Output Timesteps to the Map Output Interval.
<li> <u>'''[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format | Working With Isodate (Date-Time) Format]]'''</u> --> View results using absolute time format (dd/mm/yyyy hh:mm:ss) instead of relative time format (hh:mm:ss).
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Time_Series | Map Output Plot - Plotting Time Series]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Cross-Sections_And_Longitudinal_Profiles | Map Output Plot - Plotting Cross-Sections and Longitudinal Profiles]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Flow | Map Output Plot - Plotting Flow]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Curtain_Plot | Map Output Plot - 3D Curtain Plot]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Vertical_Profile | Map Output Plot - 3D Vertical Profile]]'''</u> --> Plotting Map Output results --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaged_Time_Series | Map Output Plot - Plotting 3D to 2D Depth Averaged Time Series]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaged_Cross-Sections | Map Output Plot - Plotting 3D to 2D Depth Averaged Cross-Sections]]'''</u> --> Plotting Map Output results.
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_From_Vector_Layer | Map Output Plot - Plotting From Vector a Layer (e.g. shp file)]]'''</u> --> Plotting Map Output results.
 
</ol>
<br>
Line 103 ⟶ 133:
<br>
 
===Time Series OutputsOutput===
Time series outputs are typically 1D result outputs from TUFLOW but can also includeor 2D time series results (plot outputs or reporting locations) if any exist. Time series results consist of atwo elements, the result datasets and GIS layerlayers that the user can interact with to plotcustomise the resultsplot selection in TUFLOW Viewer, and of course the results themselves.
<ol>
<li> Load time series output results either via:
<li> '''[[TUFLOW_Viewer_-_ESTRY_Time_Series_Outputs | ESTRY Time Series Results]]'''
<li> '''[[TUFLOW_Viewer_-_ESTRY_Time_Series_Outputs_-_2013_TUFLOW_Release | ESTRY Time Series Results - 2013 TUFLOW Release]]'''
<li> '''[[TUFLOW_Viewer_-_Flood_Modeller_Time_Series_Outputs_And_Cross-Sections | Flood Modeller Time Series Results And Cross-Sections]]'''
<li> '''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps | Viewing All Available Output Timesteps]]'''
</ol><Br>
[[File: TimeSeries_HeaderImg.PNG|650px]]<br>
<br>
 
=Particle Outputs=
Outputs from the particles module can be loaded into TUFLOW Viewer and viewed along side hydrodynamic the results. The below lists the basic interaction with particle outputs:
<ol>
<li> <u>'''[[TUFLOW_Viewer_-_Particle_Outputs_Load_Results | ParticleLoad OutputsAll Results]]'''</u>, or
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps_Load_Results_-_Time_Series | ViewingLoad AllResults Available- OutputTime TimestepsSeries]]'''</u> for TUFLOW models, or:
<li> <u>'''[[TUFLOW_Viewer_-_Load_Results_-_Time_Series_FM | Load Results - Time Series Flood Modeller]]'''</u> for TUFLOW linked Flood Modeller 1D models.
</ol>
<li> <u>'''[[TUFLOW_Viewer_-_Time_Series_Outputs_GIS_Data | Time Series Output - GIS Data]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_Time_Series | Time Series Output - Plotting Time Series]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_Longitudinal_Profiles | Time Series Output - Plotting Longitudinal Profiles]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Showing_Selected_Elements_And_Selecting_Sub-Sets | Identifying Selected Elements and Selecting Sub-Sets]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_1D_Cross-Section_Inputs | Plotting 1D Cross-Section Inputs (with / without results)]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_1D_Hydraulic_Table_Check_Files | Plotting 1D Hydraulic Table Check Files]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Extracting_Median_And_Mean_Time_Series | Extracting Median and Mean Time Series - Australian Rainfall and Runoff]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Plotting_1D_Flow_Regime | Plotting 1D Flow Regime]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Import_2D_BC_Tables | Plotting 2D Boundary Condition Tables]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps | Lock/Unlock Output Time Steps from Different Result Datasets]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Isodate_(Date-Time)_Format | Working With Isodate (Date-Time) Format]]'''</u>
</ol><br>
[[File: Particles_HeaderImgTimeSeries_HeaderImg.PNG | 650px ]]<Brbr>
<br>
 
===Particle Tracking Output===
=Plotting Results=
TUFLOW Viewer supports numerous plotting options to help users interrogate results.
<ol>
<li> <u>'''[[TUFLOW_Viewer_-_Summary_of_Plotting_Toolbar_Particle_Outputs | SummaryParticle ofTracking Plotting ToolbarOutputs]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs__Isodate_(Date-_Plotting_Time_SeriesTime)_Format | MapWorking OutputWith Isodate (Date- Plotting Time) SeriesFormat]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Cross-Sections_And_Longitudinal_Profiles_Toggling_Between_Output_Timesteps | MapLock/Unlock Output -Time PlottingSteps Cross-Sectionsfrom andDifferent LongitudinalResult ProfilesDatasets]]'''</u>
</ol>
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Flow | Map Output - Plotting Flow]]'''
[[File: Particles HeaderImg.PNG|650px]]<br>
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Curtain_Plot | Map Output - Curtain Plot]]'''
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Vertical_Profile | Map Output - Vertical Profile]]'''
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaged_Time_Series | Map Output - Plotting 3D to 2D Depth Averaged Time Series]]'''
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_3D_to_2D_Depth_Averaged_Cross-Sections | Map Output - Plotting 3D to 2D Depth Averaged Cross-Sections]]'''
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_Multiple_Locations | Map Output - Plotting Multiple Locations]]'''
<li> '''[[TUFLOW_Viewer_-_Map_Outputs_-_Plotting_From_Vector_Layer | Map Output - Plotting From Vector a Layer (e.g. shp file)]]'''
<li> '''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_Time_Series | Time Series Output - Plotting Time Series]]'''
<li> '''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_Longitudinal_Profiles | Time Series Output - Plotting Longitudinal Profiles]]'''
<li> '''[[TUFLOW_Viewer_-_Showing_Selected_Elements_And_Selecting_Sub-Sets | Showing Selected Elements and Selecting Sub-Sets]]'''
<li> '''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_1D_Cross-Section_Inputs | Plotting 1D Cross-Section Inputs (with / without results)]]'''
<li> '''[[TUFLOW_Viewer_-_Time_Series_Outputs_-_Plotting_1D_Hydraulic_Table_Check_Files | Plotting 1D Hydraulic Table Check Files]]'''
<li> '''[[TUFLOW_Viewer_-_Importing_a_User_Defined_Time_Series_To_Display_On_The_Plot | Importing a User Defined Time Series To Display On The Plot]]'''
<li> '''[[TUFLOW_Viewer_-_Using_A_Secondary_Axis | Using a Secondary Axis]]'''
<li> '''[[TUFLOW_Viewer_-_Using_A_Date_Axis | Using a Date Axis]]'''
<li> '''[[TUFLOW_Viewer_-_Showing_The_Current_Time | Showing the Current Time]]'''
<li> '''[[TUFLOW_Viewer_-_Plotting_1D_Flow_Regime | Plotting 1D Flow Regime]]'''
<li> '''[[TUFLOW_Viewer_-_Exporting_And_Copying_A_Plot | Exporting and Copying A Plot]]'''
<li> '''[[TUFLOW_Viewer_-_Exporting_The_Drawn_GIS_Plot_Features | Exporting The Drawn GIS Plot Points / Lines]]'''
<li> '''[[TUFLOW_Viewer_-_Customising_The_Plot_Legend | Customising The Legend]]'''
<li> '''[[TUFLOW_Viewer_-_Customising_The_Plotting_Styles | Customising The Plotting Styles]]'''
<li> '''[[TUFLOW_Viewer_-_Customising_The_Plot_Axes | Customising The Plot Axes]]'''
<li> '''[[TUFLOW_Viewer_-_Toggling_Plot_Grid_Lines | Toggling Plot Grid Lines]]'''
<li> '''[[TUFLOW_Viewer_-_Importing_a_Custom_Colour_Ramp_For_The_Curtain_Plot | Importing a Custom Colour Ramp For The Curtain Plot]]'''
<li> '''[[TUFLOW_Viewer_-_Navigating_And_Querying_The_Plot | Navigating And Querying The Plot]]'''
<li> '''[[TUFLOW_Viewer_-_Batch_Exporting_Plots | Batch Exporting Plots]]'''
<li> '''[[TUFLOW_Viewer_-_Extracting_Median_And_Mean_Time_Series | Extracting Median and Mean Time Series - Australian Rainfall and Runoff]]'''
<li> '''[[TUFLOW_Viewer_-_Auto_Update_Plot_From_Cursor_Location | Auto Update Plot From Cursor Location]]'''
<li> '''[[TUFLOW_Viewer_-_Viewing_The_Vertical_Mesh | Viewing the Vertical Mesh]]'''
</ol><br>
[[File: Plotting_HeaderImg.PNG | 650px ]]<br>
<br>
 
==General Plot Display Options==
=Working With Absolute Time (Date-Time)=
<ol>
<li> <u>'''[[TUFLOW_Viewer_-_Working_With_Date-Time_-_Map_Outputs_Summary_of_Plotting_Toolbar | WorkingSummary Withof Date-Time -Plotting MapToolbar OutputsOptions]]'''</u><br>
<li> <u>'''[[TUFLOW_Viewer_-_Working_With_Date-Time_-_Time_Series_Outputs_Using_A_Secondary_Axis | Working With Date-Time -Using Timea SeriesSecondary OutputsAxis]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Working_With_Date-Time_-_Particle_Outputs_Using_A_Date_Axis | WorkingUsing Witha Date-Time - Particle OutputsAxis]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Working_With_Date-Time_-_User_Defined_Time_Series_Showing_The_Current_Time | WorkingDisplaying Withthe Date-Time - User DefinedCurrent Time Series]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Customising_The_Plot_Legend | Customising The Legend]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Customising_The_Plotting_Styles | Customising The Plotting Styles]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Customising_The_Plot_Axes | Customising The Plot Axes]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Plot_Grid_Lines | Plot Grid Line Display]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Importing_a_Custom_Colour_Ramp_For_The_Curtain_Plot | Importing a Custom Colour Ramp For The Curtain Plot]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Navigating_And_Querying_The_Plot | Navigating And Querying The Plot]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Auto_Update_Plot_From_Cursor_Location | Auto Update Plot From Cursor Location]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Viewing_The_Vertical_Mesh | 3D Mesh Vertical Layer Display]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Hiding_The_Plotting_Window | Hiding the Plot Window]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Customising_The_Plot_Background_Colour | Customising the Plot Background Colour]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Setting_The_Plot_Default_Font_Size | Setting the Default Font Size For the Plot]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps | Lock/Unlock Output Time Steps from Different Result Datasets]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Changing_Icon_Size | Changing the Icon Size]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Summary_Of_Options | Settings Options]]'''</u>
</ol>
 
<br>
: [[File: DateTime_Cover_ImagePlotting_HeaderImg.PNG | 300px650px ]]<br>
<br>
 
==Exporting Animations, Data, Plots and Maps ==
=Customising Dock Appearance=
TUFLOW Viewer offers the ability to export animations, data interegation points/lines, maps and plots:<br>
<ol>
<ol>
<li> '''[[TUFLOW_Viewer#Working_With_Absolute_Time_.28Date-Time.29 | Displaying Time in Absolute Date-Time Format]]'''
<li> <u>'''[[TUFLOW_Viewer_-_Hiding_The_Plotting_Window_Exporting_An_Animation | HidingExporting theAn Plot WindowAnimation]]'''</u><br>
: [[File: Animation_cover.gif]]<br>
<li> '''[[TUFLOW_Viewer_-_Customising_The_Plot_Background_Colour | Customising the Plot Background Colour]]'''
<li> <u>'''[[TUFLOW_Viewer_-_Setting_The_Plot_Default_Font_Size_Exporting_And_Copying_A_Plot | SettingExporting theand DefaultCopying Font Size For thea Plot]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Toggling_Between_Output_Timesteps_Exporting_The_Drawn_GIS_Plot_Features | TogglingExporting OutputThe TimestepsDrawn GIS Plot Points / Lines]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Batch_Exporting_Maps | Batch Exporting Maps]]'''</u>
<li> <u>'''[[TUFLOW_Viewer_-_Batch_Exporting_Plots | Batch Exporting Plots]]'''</u>
</ol>
: [[File: Maps_Cover_Image.PNG | 550px]]<br><br>
<br>
[[File: Interface_CoverImage.PNG | 650px ]]<br>
<br>
 
= Python Error Troubleshooting =
=Summary of Options=
Occasionally the TUFLOW plugin will throw an exception and this will produce a '''Python Error''' which is displayed either as a yellow banner at the top of the map window or a window may appear stating than an 'Error has occurred while executing Python code'.<br>
Use the link below to see a list and description of the available setttings in '''Settings >> Options'''. Older versions of the plugin may look slightly different, however most options will still be available.
[[File: PythonError.PNG]]<br>
When this occurs it means that the TUFLOW plugin has encountered something unusual or a situation that it does not know how to handle (i.e. it has reached a line in the code that has failed to execute and as a consequence Python has bailed out). This means all the code below this point that was meant to execute has not. This can have knock-on consequences as variables may not exist or be set to incorrect values and signal handling (e.g. what happens when a menu item is clicked) may be broken. As such, a python error can lead to further python errors that would normally not have occurred. Because of this flow-on effect the first python error is usually the most important.<br><br>
 
If you encounter a python error please:
<ol>
<li> Email the '''Stack Trace''' to <u>[mailto:support@tuflow.com support@tuflow.com]</u> with a description of the steps that produced the python error (as best you can describe it). This is to help us identify bugs and fix the plugin so that it catches this exception in the future.
<li> '''[[TUFLOW_Viewer_-_Summary_Of_Options | Summary of Options]]'''
<li> If you find that you are now experiencing further python errors (probably caused by the initial error) you can try the following alternative in order of severity (least to worst):
<ol>
<li> On the TUFLOW Viewer menu bar '''File >> Reload TUFLOW Viewer''' - this will reload TUFLOW Viewer, resetting all variables and signals. You will be required to load in any time series results again and other settings may also be reset. Map output results will remain in the workspace and be reloaded into TUFLOW Viewer.
<li> Save the QGIS workspace (.qgz) and restart QGIS.
<li> Restart QGIS - you can save the workspace (.qgz), however you should first select on the TUFLOW Viewer menu bar '''File >> Close TUFLOW Viewer Completely''' - this will close the Viewer and also remove all settings associated with it from the workspace so that the problematic variable is not accidentally reloaded with the workspace.
<li> The last resort option is to restart QGIS and load and create a new workspace from scratch (do not load a saved workspace).
</ol>
</ol>
<br>
{{Tips Navigation
[[File: Options_Cover_Picture.PNG]]<br>
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
}}
<br>
 
=Creating an Animation=
Coming soon
<br>
 
=Batch Exporting Maps=
Coming soon
<br>
{{Tips Navigation
|uplink=[[Main_Page| Back to Wiki Main Page]]
}}
Retrieved from "https://wiki.tuflow.com/TUFLOW_Viewer"