Tuflow - User contributions [en]

TUFLOW Viewer - Plotting 1D Flow Regime

2025-07-02T04:41:41Z

Melissa.Moghanloo: /* Example */

===Tool Description===
Flow regime can be a very useful output to understand and debug 1D results, in particular, culverts. 

Flow regime results are output from ESTRY by default (i.e. there is no special output type or command required in the ECF). Since the 2020-01-AA TUFLOW release, flow regime results will be imported into TUFLOW Viewer when time series results are loaded. There are several methods to view the flow regime results:
<ol>
<li>Select 'Flow Regime' in the '''Result Type''' widget (underneath 'Time Series'). 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_1a.png]] 
This will display the flow regime as points and lock the y-axis to the available flow regime types as per the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. The plot will group the types by outlet and inlet control regimes - 'G' is no flow, everything below 'G' on the plot will be inlet control and everything above 'G' is outlet control. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_2a_03.png]] 

<li>Right clicking certain time series results [[File:results_2.png | 15px]] (e.g. 'Flow', 'Level', or 'Velocity') will give the user the option of checking on '''Flow Regime'''. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_3a.png]] 

This will plot the flow regime as letters and map it to the chosen result type, making visualising the result a lot easier. For example, in the image below the small jump in velocity at approximately 0.4 hrs is shown to be a change in flow regime (it goes from 'C' to 'E' then to 'B'. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_4a.png]]
</ol>

'''Flow Regimes (Source: TUFLOW Manual)''' 
[[File:Plotting_TimeSeries_FlowRegime_Legend.PNG]] 

===Example===
{{Video|name=TUFLOW Viewer_Plotting 1D Flow Regime_1a.mp4|width=1350}}
 

{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Time_Series_Output| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Plotting 1D Flow Regime 1a.mp4

2025-07-02T04:40:26Z

Melissa.Moghanloo:

TUFLOW Viewer - Plotting 1D Flow Regime

2025-07-02T04:39:33Z

Melissa.Moghanloo:

===Tool Description===
Flow regime can be a very useful output to understand and debug 1D results, in particular, culverts. 

Flow regime results are output from ESTRY by default (i.e. there is no special output type or command required in the ECF). Since the 2020-01-AA TUFLOW release, flow regime results will be imported into TUFLOW Viewer when time series results are loaded. There are several methods to view the flow regime results:
<ol>
<li>Select 'Flow Regime' in the '''Result Type''' widget (underneath 'Time Series'). 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_1a.png]] 
This will display the flow regime as points and lock the y-axis to the available flow regime types as per the [https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]. The plot will group the types by outlet and inlet control regimes - 'G' is no flow, everything below 'G' on the plot will be inlet control and everything above 'G' is outlet control. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_2a_03.png]] 

<li>Right clicking certain time series results [[File:results_2.png | 15px]] (e.g. 'Flow', 'Level', or 'Velocity') will give the user the option of checking on '''Flow Regime'''. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_3a.png]] 

This will plot the flow regime as letters and map it to the chosen result type, making visualising the result a lot easier. For example, in the image below the small jump in velocity at approximately 0.4 hrs is shown to be a change in flow regime (it goes from 'C' to 'E' then to 'B'. 
[[File: TUFLOW Viewer_Plotting 1D Flow Regime_4a.png]]
</ol>

'''Flow Regimes (Source: TUFLOW Manual)''' 
[[File:Plotting_TimeSeries_FlowRegime_Legend.PNG]] 

===Example===
[[File: Plotting_TimeSeries_FlowRegime_Example.gif]]
 

{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Time_Series_Output| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Plotting 1D Flow Regime 4a.png

2025-07-02T04:36:07Z

Melissa.Moghanloo:

File:TUFLOW Viewer Plotting 1D Flow Regime 3a.png

2025-07-02T04:35:54Z

Melissa.Moghanloo:

File:TUFLOW Viewer Plotting 1D Flow Regime 2a 03.png

2025-07-02T04:35:37Z

Melissa.Moghanloo:

File:TUFLOW Viewer Plotting 1D Flow Regime 1a.png

2025-07-02T04:11:47Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Plots

2025-07-01T05:08:12Z

Melissa.Moghanloo:

===Tool Description===
TUFLOW Viewer offers a tool to batch export plots using a vector layer as the plot location selection object. the tool includes the ability to plot from results that have not been loaded into QGIS yet. 

The tool will use the current plot settings at the time of the export request for all outputs. This includes line styles, axis settings, and legend settings. As an alternative to exporting images, the tool can also export csv files, in which case the plot settings won't have any effect on the export. The tool currently only supports the standard time series (from a point layer) or standard cross-sections (from a line layer). It does not support Isodate (date-time) formats. 

The Batch Export Tool is initiated using the TUFLOW Viewer drop menu: '''Export >> Batch Plot and Export Features''' 
The following image highlights the tool input and output options:
<ol>
<li> '''GIS Layer''': Vector layer containing objects defining the location where results are to be extracted from.
<li> '''Name Attribute''': Name attribute field used as file name for export and chart title. If '''-None-''' is selected, the tool uses the feature FID.
<li> '''Result Mesh''': Mesh layers to extract data from. You can choose to add from a file that is not yet loaded into QGIS. Only results that are selected in the list will be processed.
<li> '''Add from a file''': Button to browse to results that are not already present in QGIS. If no result layer is currently present in QGIS, '''Result Types''' and '''Timestep''' options below are not populated. As such, it is recommended that at least one result layer is loaded so that these are populated, making selection of appropriate options in the following fields easier.
<li> '''Result Types''': Result types for plotting (e.g. bed elevation, water level). Can select from the dropdown if results are loaded in QGIS or user can type them (for more than one, separate result types with ';;' (e.g. Water Level;;Velocity).
<li> '''Time Step''': Output time step for cross section plotting (not used for time series). Required for cross-sections. If no results are present in QGIS the user will need to input a timestep manually.
<li> '''Export''': Choose either all features or only currently selected features (in the QGIS map window) to iterate through.
<li> '''Format''': Choose either CSV or Image.
<li> '''Output Folder''': Folder location for outputs.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Plots_1a.png]] 
 
''Note:'' Exporting static data as a time series (e.g. Bed Elevation) is possible and will be exported as a single value over the time period. 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Plots 1a.png

2025-07-01T05:07:48Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T04:43:55Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: TUFLOW Viewer_Batch Exporting Maps_9a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: TUFLOW Viewer_Batch Exporting Maps_11a.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: TUFLOW Viewer_Batch Exporting Maps_12a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: TUFLOW Viewer_Batch Exporting Maps_13a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 13a.png

2025-07-01T04:43:04Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T04:41:59Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: TUFLOW Viewer_Batch Exporting Maps_9a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: TUFLOW Viewer_Batch Exporting Maps_11a.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: TUFLOW Viewer_Batch Exporting Maps_12a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 12a.png

2025-07-01T04:38:24Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T04:16:43Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: TUFLOW Viewer_Batch Exporting Maps_9a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: TUFLOW Viewer_Batch Exporting Maps_11a.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 11a.png

2025-07-01T04:15:50Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T04:14:25Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: TUFLOW Viewer_Batch Exporting Maps_9a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 10a.png

2025-07-01T04:12:56Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T04:10:22Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: TUFLOW Viewer_Batch Exporting Maps_9a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 9a.png

2025-07-01T04:08:20Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:53:10Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: TUFLOW Viewer_Batch Exporting Maps_8a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 8a.png

2025-07-01T03:52:21Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:50:04Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: TUFLOW Viewer_Batch Exporting Maps_7a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 7a.png

2025-07-01T03:49:08Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:32:14Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File:TUFLOW Viewer_Batch Exporting Maps_6a.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: Batch_exporting_maps_07a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 6a.png

2025-07-01T03:31:29Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:17:27Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: TUFLOW Viewer_Batch Exporting Maps_5a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File: Batch_exporting_maps_06b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: Batch_exporting_maps_07a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 5a.png

2025-07-01T03:16:36Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:15:25Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: TUFLOW Viewer_Batch Exporting Maps_3a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:TUFLOW Viewer_Batch Exporting Maps_4a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: Batch_exporting_maps_05a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File: Batch_exporting_maps_06b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: Batch_exporting_maps_07a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 4a.png

2025-07-01T03:14:38Z

Melissa.Moghanloo:

File:TUFLOW Viewer Batch Exporting Maps 3a.png

2025-07-01T03:13:40Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:13:19Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: TUFLOW Viewer_Batch Exporting Maps_2a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: Batch_exporting_maps_03a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:Batch_exporting_maps_04a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: Batch_exporting_maps_05a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File: Batch_exporting_maps_06b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: Batch_exporting_maps_07a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 2a.png

2025-07-01T03:12:26Z

Melissa.Moghanloo:

TUFLOW Viewer - Batch Exporting Maps

2025-07-01T03:09:14Z

Melissa.Moghanloo:

TUFLOW Viewer offers the ability to batch export maps using mesh layers. This tool does not seek to replace other similar tools that may be inherently built in to QGIS, however does offer the ability to:
* Automatically add plots from the mesh layer to the maps.
* Automatically load mesh results, plot, and export maps.
It also offers convenience functionality for adding items (such as a legend, images and scales), however these can also be added manually in the print layout. 

The following steps through the process of batch exporting maps:
<ol>
<li> Open the batch export map tool via '''Export >> Export Maps''' 
[[File: TUFLOW Viewer_Batch Exporting Maps_1a.png]]
<li> In the layout tab, the user has the option to use a '''Default Layout''' or a '''Custom Layout'''. A custom layout uses a '''Print Layout Template (.qpt)''' as an input. The recommended workflow is to:
<ol>
<li> Use the '''Default Layout''' initially.
<li> Customise the layout using the print layout in QGIS.
<li> Export the print layout as a template (.qpt).
<li> Use '''Custom Layout''' using the created template file.
</ol>
[[File: Batch_exporting_maps_02a.png]]

<li> During Step 1 above, the '''Default Layout''' lets the user specify some items to add to the layout.
<li> '''Page Properties''' - defines the page size and the orientation of the exported maps. A page border is added by default, however can be turned off or edited in this section. 
[[File: Batch_exporting_maps_03a.png]]
<li> '''Legend, Scale Bar, North Arrow''' - the next three items will add common map items. Users can edit the properties of the item and add things like a background and border. 
[[File:Batch_exporting_maps_04a.png]]
<li> '''Label''' - Users can also add a custom label with dynamic text. This is useful if the user would like to add information to the map such as the result name, result type, or date the map was produced. This can be done by using the buttons on the right-hand side of the label properties. User's can also add their own text to the label, however this will be static.
* '''Dynamic Map Number''' - will add a map number to the label based on the order that the maps are exported.
* '''Dynamic Result Name''' - will add the result name to the label (e.g. M03_5m_001).
* '''Dynamic Result Type''' - will add the result type to the label (e.g. Depth - Max).
* '''Dynamic Date''' - will add the date the map was exported.
* '''Dynamic Workspace Location''' - will add the workspace path to the label.
[[File: Batch_exporting_maps_05a.png]]
<li> '''Plots''' - These are dynamic plot objects that will be added to the maps. To add a plot, the plot must already be available in one of the TUFLOW Viewer plotting windows. 
[[File: Batch_exporting_maps_06b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add a plot.
<li> Select the source of the plot lines that will be added (i.e. time series, cross section etc.).
<li> Select the plotting lines to add to the plot. Users can add more than one line or split the lines onto multiple plots. If the line is on secondary axis, this will be retained unless the need for the secondary axis becomes redundant (e.g. it's the only line on the plot).
:* In addition to the plotted result types, users have the option of specifying '''Active Dataset''' and '''Active Dataset [Water Level For Depth]'''. This will use the plot location, but plot the active scalar result of the map. The latter option will use water level if the active scalar is depth. This option will not work for plotting from a vector layer if the user is using one of the fields for the plot legend entry (this will need to be turned off in the '''Settings >> Options >> Plotting'''.
<li> Set the position. This is only the starting position and can be moved later in the print layout.
<li> Set the plot properties. When the user clicks this button, TUFLOW Viewer will calculate the min/max for the plot axes. For lines on the cross-section and vertical profile plots, this can take some time as TUFLOW Viewer will need to step through every timestep to find the min/max values. 
[[File: Batch_exporting_maps_07a.png]]
<ol>
<li> '''Plot Title''' - can be useful to indicate where the plot was extracted from by aligning the title with labels in the print layout.
<li> '''Axis labels''' - will be populated with default values.
<li> '''Axis Limits''' - will be populated with calculated extents and the extents can be recalculated using '''Auto Calc'''.
<li> '''Legend''' - legend can be added or removed. Legend location options are not as extensive as the TUFLOW Viewer itself, most notably 'Auto' is not available.
<li> '''Grid lines''' - can be toggled on/off.
<li> '''Figure Size''' - will default to 100 x 100. This can be changed in the print layout and the plot will be re-rendered prior to the animation to fit the desired size.
</ol>
<li> If the plot point/line was drawn by the user (not a vector layer), a graphic object will be added to the appropriate location to indicate the extraction location. This can be toggled off by unchecking this box.
<li> Label for the graphic object - this can be changed later in the print layout
<li> Label position relative to the graphic object
<li> Label properties: 
[[File: Batch_exporting_maps_08a.png]]
<ol>
<li> Label font settings
<li> Background and box settings
</ol>
</ol>
<li> '''Images''' - Adds static images (e.g. company logo) to the maps. Adding images can also be added / edited later in the print layout. 
[[File: Batch_exporting_maps_09b.png]]
<ol>
<li> Use the add button [[File: plus_icon_01a.png]] to add an image.
<li> Browse or copy the file path location of the image to be added.
<li> Position - this is the starting position and can be changed later in the print layout.
<li> Image properties: 
[[File: Batch_exporting_maps_10a.png]]
<ol>
<li> Image size options - this can be changed later in the print layout.
</ol>
</ol>
<li> Add maps in the '''Export Maps''' tab.
* '''Result''' - result file (e.g. the .xmdf file). Results can be chosen from mesh layers that are already loaded into QGIS, or a file path can be specified and the tool will automatically load the mesh when required.
* '''Scalar Type''' - scalar result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Vector Type''' - vector result type to be mapped. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Time''' - timestep used for the map. If the result isn't loaded yet, the user will need to type this result type in manually.
* '''Output''' - output location of map. 
[[File: batch_exporting_maps_18b.png]]
<li> Users can import a list of maps from a csv file using the '''Import''' button. This allows users to use a program such as MS Excel to populate the map list. 
[[File: Batch_exporting_maps_11a.png]]
<ol>
<li> '''Delimited File''' - csv (or other text file) containing the map list.
<li> '''Delimited Format''' - delimited format of the input file.
<li> '''Header Rows''' - number of header rows to discard.
<li> '''Columns''' - the columns that correspond to the appropriate columns in the tool. If the column names match the names in the tool, the import tool will automatically populate these values.
</ol>
<li> Once all layout items have been chosen and added, clicking '''Preview''' will allow the user to view how it's going to look. 
[[File: Batch_exporting_maps_12a.png]]
<li> Clicking the preview button will open up the layout in the QGIS print layout. In this layout, the user can modify, move, resize, add, and remove items in the layout. The following items must retain their IDs:
* The dynamic label must have the ID 'title'.
* Dynamic plots will have an ID 'plot_<n>' where <n> is the plot index (starting at index 0) based on the order they were added in the '''Default Layout'''.
* The graphic objects have an ID corresponding to their ID in the '''Default Layout'''.
Some of the useful information and tools in the print layout are:
* All plot items are listed in the 'Items' box and their corresponding ID. Items can be selected in this box to show their properties and allow users to edit them (they can also be selected in the print layout). 
: [[File: Batch_exporting_maps_13a.png]]
* Item properties can be edited using the '''Item Properties''' tab below the 'Items' box. 
: [[File: Batch_exporting_maps_14a.png]]
* Use the tool '''Interactively Edit Map Extent''' [[File: Interactively_edit_map_extent_icon_01a.png]] to edit the zoom and position of the map in the print layout.
* When the map zoom and extents are adjusted the graphic objects will no longer be in the correct position, however that's ok because the next time either the preview is clicked or if the export maps tool is run, they will be placed in their correct position.
* Use the tool '''Select / Move Item''' [[File: select_move_item_icon_01a.png]] to move and resize items in the print layout.
* Use '''Add Item''' menu to add other custom items such as a north arrow or scale bar. 
: [[File: Batch_exporting_maps_15a.png]]
<li> Save the print layout as a template (.qpt) via the menu '''Layout >> Save as Template'''. 
[[File: Batch_exporting_maps_16a.png]]
<li> Close the print layout.
<li> Select the '''Custom Layout''' radio button in the layout tab in the export animation dialog and browse the saved template file (.qpt). 
[[File: Batch_exporting_maps_17a.png]] 
Note that all the default layout items will be overridden with the '''Custom Layout''' except for the plots and dynamic text. The plot position and size from the custom layout template will be used, however the plot content will still be taken from the '''Default Layout'''. Likewise for the dynamic text, the text will be taken from the '''Default Layout'''.
<li> The '''Preview''' button can be used multiple times to check that the layout is correctly being imported from the template.
<li> Click '''Ok''' to run the tool and export the maps.
</ol>
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Batch Exporting Maps 1a.png

2025-07-01T03:08:33Z

Melissa.Moghanloo:

TUFLOW Viewer - Exporting The Drawn GIS Plot Features

2025-07-01T00:22:14Z

Melissa.Moghanloo:

===Tool Description===
It is possible to export the graphic layers that are drawn when plotting '''From Map''' or '''From Map Multi'''. This can be useful if the user would like to retain the chosen plot locations for reproducibility in a future workspace. The tool supports exporting both line and point layers, and the tool will export all available plot graphics irrespective of which plot they were drawn for (for a given geometry). For example, exporting lines to a '''*.shp''' file will export all cross-section, flow, and curtain plot lines. 

At the time of this wiki page creation (plugin version 3.1.5), the exported format is currently locked to '''*.shp'''. The exported '''*.shp''' file will be in a 2d_PO format for convenience in case the user wishes to retrieve the output directly from TUFLOW (which would be a more accurate output and always recommended over post extracting plots from TUFLOW Viewer for map outputs). 

The features can be exported to '''*.shp''' file by:
<ol>
<li> Selecting via the menu '''Export >> Export Temporary Line(s) to SHP''' for drawn lines and '''Export >> Export Temporary Point(s) to SHP''' for drawn point objects. 
[[File: TUFLOW Viewer_Exporting The Drawn GIS Plot Features_1a.png|350px]] 
<li> Browse to save location and specify the shp file name.
<li> The user will be given the option of adding the exported shp file to the current workspace.
</ol>

===Examples===
{{Video|name=TUFLOW Viewer_Exporting The Drawn GIS Plot Features_1a.mp4|width=1350}}
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

TUFLOW Viewer - Exporting The Drawn GIS Plot Features

2025-07-01T00:19:51Z

Melissa.Moghanloo: /* Tool Description */

===Tool Description===
It is possible to export the graphic layers that are drawn when plotting '''From Map''' or '''From Map Multi'''. This can be useful if the user would like to retain the chosen plot locations for reproducibility in a future workspace. The tool supports exporting both line and point layers, and the tool will export all available plot graphics irrespective of which plot they were drawn for (for a given geometry). For example, exporting lines to a '''*.shp''' file will export all cross-section, flow, and curtain plot lines. 

At the time of this wiki page creation (plugin version 3.1.5), the exported format is currently locked to '''*.shp'''. The exported '''*.shp''' file will be in a 2d_PO format for convenience in case the user wishes to retrieve the output directly from TUFLOW (which would be a more accurate output and always recommended over post extracting plots from TUFLOW Viewer for map outputs). 

The features can be exported to '''*.shp''' file by:
<ol>
<li> Selecting via the menu '''Export >> Export Temporary Line(s) to SHP''' for drawn lines and '''Export >> Export Temporary Point(s) to SHP''' for drawn point objects. 
[[File: TUFLOW Viewer_Exporting The Drawn GIS Plot Features_1a.png]] 
<li> Browse to save location and specify the shp file name.
<li> The user will be given the option of adding the exported shp file to the current workspace.
</ol>

===Examples===
{{Video|name=TUFLOW Viewer_Exporting The Drawn GIS Plot Features_1a.mp4|width=1350}}
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Exporting The Drawn GIS Plot Features 1a.png

2025-07-01T00:19:13Z

Melissa.Moghanloo:

Installing Wibu CodeMeter Windows

2025-06-30T23:33:25Z

Melissa.Moghanloo:

* Download the latest CodeMeter Runtime Kit for Windows installer from: [https://www.wibu.com/support/user/downloads-user-software.html https://www.wibu.com/support/user/downloads-user-software.html]
[[File:Installing Wibu CodMeter_001.png]]
* Install the software
:* If you are using a local licence or have a network licence and are installing CodeMeter on a network client computer (i.e. a modelling computer, not the network host/server) please use the default install settings.
:* If a computer is used as a network licence server, please select the "Network Server" option during the installation. Selecting this option will configure the appropriate TCP and UDP protocols in the Windows Firewall. 
[[File:Installing WibuCodMeter_002.png]]

* Silent Install: It is possible to do a silent install of the CodeMeter Runtime kit. CodeMeter support staff have advised that this can be done with the following parameters: 
<tt>CodeMeterRuntime.exe /ComponentArgs "*":"/qn"</tt>

File:Installing WibuCodMeter 002.png

2025-06-30T23:32:02Z

Melissa.Moghanloo:

File:Installing Wibu CodMeter 001.png

2025-06-30T23:31:48Z

Melissa.Moghanloo:

Run TUFLOW From PowerShell

2025-06-29T23:33:26Z

Melissa.Moghanloo: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_Edited.mp4|width=850}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]):
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -x -s1 5m -s2 D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b -s1 $scenario -e1 $event model_~s1~_~e1~.tcf
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

File:TUFLOW Run Edited.mp4

2025-06-29T23:31:58Z

Melissa.Moghanloo:

Run TUFLOW From PowerShell

2025-06-26T06:24:48Z

Melissa.Moghanloo: /* Using PowerShell */

PowerShell is a modern scripting language and command interpreter for Windows that can be used as an alternative to more traditional batch files.
When creating a PowerShell script to run TUFLOW, much of the functionality will be similar to batch files, but PowerShell offers some additional benefits such as a more modern syntax and the ability to better interact with other features of the Windows operating system. Perhaps one of the most useful features would be the ability to send an email once a TUFLOW simulation has finished. This would allow, for example, a script running a TUFLOW simulation on a server to inform a user on their own computer that a simulation has finished, and details of that simulation to be sent within the email too.

Unlike batch files, a PowerShell script will not run by default when double clicking it in File Explorer. Instead, a user can run the PowerShell script via the command line, for example by searching and opening “PowerShell” from the Windows start menu.

A PowerShell script can be created in a similar way to a batch file. For example, right click in File Explorer, then click New > Text Document, and then provide a file name and extension (.ps1 for PowerShell). Alternatively, when using the [[Create_TUFLOW_Project|Create TUFLOW Project Tool in QGIS]], a PowerShell script is automatically generated in addition to a batch file.

=Using PowerShell=
Open Windows PowerShell from the Windows start menu. When running a script via the PowerShell command line, the current working directory should typically be set to the same directory as the location of the script and TCF file. To change the current working directory, use the “cd” command. If there are spaces in your folder path use single quotations around entry (' '):
<pre>
cd '<Path-to-Tuflow-Runs-Folder>'
</pre>

Assuming the PowerShell script filename is run.ps1, this can be run from the PowerShell command line with this command:
<pre>
.\run_TUFLOW_simulations.ps1
</pre>

{{Video|name=TUFLOW Run_002.mp4|width=1350}} 
 

=Simple Example=

A simple PowerShell script to run a single simulation is as follows:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe model_001.tcf
</pre>

If there are spaces in your executable path, use single quotations around the executable entry (' ') and prefix the reference with &. For example:
<pre>
& 'C:\bin\TUFLOW Example\2025.0.3\TUFLOW_iSP_w64.exe' model_001.tcf
</pre>

=Multiple Simulations=
Running multiple simulations in series can be handled by adding new lines to run.ps1. Use a –b (batch) switch to suppresses the need to press the return key at the end of each simulation:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_001.tcf
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe -b model_002.tcf
</pre>

=Adding Switches=
To alter the behaviour of TUFLOW, switches can be used in the same way as a batch file (see [[Run_TUFLOW_From_a_Batch-file#TUFLOW_switches_in_a_batch_file | Batch File Switches]]). It is recommended that switches be contained with single quotations (' '). For example, running with the test switch -t:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe '-b' '-t' model_001.tcf
</pre>

When specifying a tcf file that includes scenarios and/or events within the filename use single quotations around the tcf file reference (' '). The specific scenarios and event references do not require quotations.
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe '-b' '-x' '-s1' 5m '-s2' D01 'model_~s1~_~s2~_001.tcf'
</pre>

This example demonstrates how to package a copy of a project milestone model (including all possible scenario and event inputs) for archiving:
<pre>
C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe '-b' '-pmAll' '-xf0' '-s1' 5m '-s2' D01 '-e1' Q100 '-e2' 2hr 'model_~s1~_~s2~_~e1~_~e2~_001.tcf'
</pre>

=Defining Variables=
In PowerShell, variables are used to store values and are identified by a dollar sign ($) followed by a name. For example:
<pre>
$EXE = 'C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe'
$EXE '-b' '-x' '-s1' 5m '-s2' D01 model_~s1~_~s2~_001.tcf
</pre>

=Looping=
Looping is undertaken in a similar way to batch files. The following PowerShell script contains a nested loop, so that TUFLOW runs a simulation for all combinations of scenario and event.
Comments can be added using #.

<pre>
#TUFLOW RUN VARIABLES
$EXE = C:\bin\TUFLOW\2025.0.3\TUFLOW_iSP_w64.exe
$scenarios = @("1m", "2m", "5m")
$events = @("1hr", "2hr", "5hr")

#SIMULATION EXECUTION LOOP
foreach ($scenario in $scenarios){
foreach ($event in $events){
$EXE '-b' '-s1' $scenario '-e1' $event 'model_~s1~_~e1~.tcf'
}
}
</pre>

=Email Notifications=
An email can be sent using PowerShell to inform the user that a TUFLOW run has completed (successfully or otherwise). The following approach requires that Outlook is already set up on the computer running TUFLOW:
<pre>
$Outlook = New-Object -ComObject Outlook.Application
$Mail = $Outlook.CreateItem(0)
$Mail.Subject = "TUFLOW Simulation Finished"
$Mail.To = "first_recipient_email_address_here"
$Mail.To = "second_recipient_email_address_here"
$Mail.Send()
</pre>
It is also possible to send the contents of a log file (for example, the TLF) as the body of the email. To do this, you must pre-empt the name and path of the TLF file that will be produced:
<pre>
$Mail.Body = Get-Content -Raw .\log\model_001.tlf
$Mail.Send()
</pre>

File:TUFLOW Run 002.mp4

2025-06-26T06:21:01Z

Melissa.Moghanloo:

TUFLOW Viewer - Exporting The Drawn GIS Plot Features

2025-06-25T03:51:40Z

Melissa.Moghanloo: /* Examples */

===Tool Description===
It is possible to export the graphic layers that are drawn when plotting '''From Map''' or '''From Map Multi'''. This can be useful if the user would like to retain the chosen plot locations for reproducibility in a future workspace. The tool supports exporting both line and point layers, and the tool will export all available plot graphics irrespective of which plot they were drawn for (for a given geometry). For example, exporting lines to a '''*.shp''' file will export all cross-section, flow, and curtain plot lines. 

At the time of this wiki page creation (plugin version 3.1.5), the exported format is currently locked to '''*.shp'''. The exported '''*.shp''' file will be in a 2d_PO format for convenience in case the user wishes to retrieve the output directly from TUFLOW (which would be a more accurate output and always recommended over post extracting plots from TUFLOW Viewer for map outputs). 

The features can be exported to '''*.shp''' file by:
<ol>
<li> Selecting via the menu '''Export >> Export Temporary Line(s) to SHP''' for drawn lines and '''Export >> Export Temporary Point(s) to SHP''' for drawn point objects. 
[[File: TUFLOW_Viewer_Export_Dropdown_Menu_01a.png]] 
<li> Browse to save location and specify the shp file name.
<li> The user will be given the option of adding the exported shp file to the current workspace.
</ol>

===Examples===
{{Video|name=TUFLOW Viewer_Exporting The Drawn GIS Plot Features_1a.mp4|width=1350}}
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Exporting The Drawn GIS Plot Features 1a.mp4

2025-06-25T03:51:07Z

Melissa.Moghanloo:

TUFLOW Viewer - Exporting And Copying A Plot

2025-06-25T03:27:52Z

Melissa.Moghanloo: /* Tool Description */

===Tool Description===
It is possible to export / copy the current plot window as either raw data or an image. Exporting the plot will save the data or image as a file, while copying the plot will copy the data or image to the clipboard. 

* '''Export as image'''
<ol>
<li> Via the menu '''Export >> Save''' or right-click the plot window and select '''Export >> Save'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_1b.png]]
<li> Browse to a save location, specify export image name, and choose image format.
</ol>
* '''Export as csv'''
<ol>
<li> Via the menu '''Export >> Export Plot as CSV''' or right-click the plot window and select '''Export >> Export Plot as CSV'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_4a.png]]
<li> Browse to a save location and specify export csv file name.
</ol>
* '''Copy image to clipboard'''
<ol>
<li> Via the menu '''Export >> Copy Image to Clipboard''' or right-click the plot window and select '''Copy >> Copy Image to Clipboard'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_2a.png]]
<li> This will copy the image to the clipboard which can be pasted into the desired program (e.g. email, report document, powerpoint etc.).
</ol>
* '''Copy data to clipboard'''
<ol>
<li> Via the menu '''Export >> Copy Data to Clipboard''' or right-click the plot window and select '''Copy >> Copy Data to Clipboard'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_3a.png]]
<li> This will copy the data to the clipboard (in a tab delimited format) which can be pasted into the desired program (e.g. excel - the tab delimited format will automatically paste the data into separate columns in excel).
</ol>

===Examples===
====Exporting an Image====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_1a.mp4|width=1350}} 

====Exporting a CSV====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_2a.mp4|width=1350}} 

====Copying an Image====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_3a.mp4|width=1350}} 

====Copying data====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_4a.mp4|width=1350}} 

 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Exporting and Copying a Plot 1b.png

2025-06-25T03:27:30Z

Melissa.Moghanloo:

TUFLOW Viewer - Exporting And Copying A Plot

2025-06-25T03:23:31Z

Melissa.Moghanloo: /* Tool Description */

===Tool Description===
It is possible to export / copy the current plot window as either raw data or an image. Exporting the plot will save the data or image as a file, while copying the plot will copy the data or image to the clipboard. 

* '''Export as image'''
<ol>
<li> Via the menu '''Export >> Save''' or right-click the plot window and select '''Export >> Save'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_1a.png]]
<li> Browse to a save location, specify export image name, and choose image format.
</ol>
* '''Export as csv'''
<ol>
<li> Via the menu '''Export >> Export Plot as CSV''' or right-click the plot window and select '''Export >> Export Plot as CSV'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_4a.png]]
<li> Browse to a save location and specify export csv file name.
</ol>
* '''Copy image to clipboard'''
<ol>
<li> Via the menu '''Export >> Copy Image to Clipboard''' or right-click the plot window and select '''Copy >> Copy Image to Clipboard'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_2a.png]]
<li> This will copy the image to the clipboard which can be pasted into the desired program (e.g. email, report document, powerpoint etc.).
</ol>
* '''Copy data to clipboard'''
<ol>
<li> Via the menu '''Export >> Copy Data to Clipboard''' or right-click the plot window and select '''Copy >> Copy Data to Clipboard'''. 
[[File: TUFLOW Viewer_Exporting and Copying a Plot_3a.png]]
<li> This will copy the data to the clipboard (in a tab delimited format) which can be pasted into the desired program (e.g. excel - the tab delimited format will automatically paste the data into separate columns in excel).
</ol>

===Examples===
====Exporting an Image====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_1a.mp4|width=1350}} 

====Exporting a CSV====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_2a.mp4|width=1350}} 

====Copying an Image====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_3a.mp4|width=1350}} 

====Copying data====
{{Video|name=TUFLOW Viewer_Exporting And Copying A Plot_4a.mp4|width=1350}} 

 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
}}

File:TUFLOW Viewer Exporting and Copying a Plot 3a.png

2025-06-25T03:23:06Z

Melissa.Moghanloo: