Convert TUFLOW Model GIS Format - Revision history

Tuflowduncan: /* Python and the Soure Code */

2023-12-22T10:41:12Z

Python and the Soure Code

← Older revision		Revision as of 20:41, 22 December 2023
Line 76:		Line 76:
	A known conversion issue could occur if the tool is converting both MIF and SHP files into a single format (e.g. GPKG) as the projection of these files may be interpreted slightly differently by GDAL (even though they are the same). Users may therefore be required to manually update the projection of the affected files, or add the TUFLOW command "<tt>GIS Projeciton Check == WARNING</tt>" to the TCF. '''Be careful''' to ensure they are in fact the same projection before using this command.<Br>		A known conversion issue could occur if the tool is converting both MIF and SHP files into a single format (e.g. GPKG) as the projection of these files may be interpreted slightly differently by GDAL (even though they are the same). Users may therefore be required to manually update the projection of the affected files, or add the TUFLOW command "<tt>GIS Projeciton Check == WARNING</tt>" to the TCF. '''Be careful''' to ensure they are in fact the same projection before using this command.<Br>

	===Python and the ~~Soure~~ Code===		===Python and the Source Code===
	It's possible to run the tool outside of QGIS in Python. The tool uses GDAL to read and write the GIS files and does not rely on any QGIS libraries. The source code and instructions on how to run the tool in Python can be found at the following location on the '''<u>[https://gitlab.com/tuflow-user-group/tuflow/model-conversions/convert_tuflow_model_gis_format TUFLOW Community GitLab page]</u>'''.		It's possible to run the tool outside of QGIS in Python. The tool uses GDAL to read and write the GIS files and does not rely on any QGIS libraries. The source code and instructions on how to run the tool in Python can be found at the following location on the '''<u>[https://gitlab.com/tuflow-user-group/tuflow/model-conversions/convert_tuflow_model_gis_format TUFLOW Community GitLab page]</u>'''.
	<Br>		<Br>

Ellis Symons: /* Output CRS */

2023-11-14T16:23:45Z

Output CRS

← Older revision		Revision as of 02:23, 15 November 2023
Line 62:		Line 62:
	Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. Set blank to turn off.		Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. Set blank to turn off.

	=====~~Output~~ ~~CRS~~=====		=====Force TUFLOW Directory Structure=====
	''Available since v3.10''<br>		''Available since v3.10''<br>
	Forces the output files to be placed in a default TUFLOW folder structure, ignoring the input folder structure. If this setting is on, the "Log Folder", "Output Folder", and "Write Check Files" commands will be updated to also reference standard TUFLOW locations.		Forces the output files to be placed in a default TUFLOW folder structure, ignoring the input folder structure. If this setting is on, the "Log Folder", "Output Folder", and "Write Check Files" commands will be updated to also reference standard TUFLOW locations.

Ellis Symons: /* Parameters */

2023-11-14T16:23:21Z

Parameters

← Older revision		Revision as of 02:23, 15 November 2023
Line 61:		Line 61:
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. Set blank to turn off.		Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. Set blank to turn off.

			=====Output CRS=====
			''Available since v3.10''<br>
			Forces the output files to be placed in a default TUFLOW folder structure, ignoring the input folder structure. If this setting is on, the "Log Folder", "Output Folder", and "Write Check Files" commands will be updated to also reference standard TUFLOW locations.

	===Checking the Output===		===Checking the Output===

Ellis Symons: /* Output CRS */

2022-11-15T06:04:51Z

Output CRS

← Older revision		Revision as of 16:04, 15 November 2022
Line 60:		Line 60:
	=====Output CRS=====		=====Output CRS=====
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.		Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. Set blank to turn off.

	===Checking the Output===		===Checking the Output===

Ellis Symons at 05:57, 15 November 2022

2022-11-15T05:57:48Z

← Older revision		Revision as of 15:57, 15 November 2022
Line 12:		Line 12:
	Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>		Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>

	~~''<b>~~Output Vector Format~~</b>''<br>~~		=====Output Vector Format=====
	Output vector format of the converted model. Supported formats are ''GPKG, SHP, MIF''.<br>		Output vector format of the converted model. Supported formats are ''GPKG, SHP, MIF''.<br>

	~~''<b>~~Output Raster Format~~</b>''<Br>~~		=====Output Raster Format=====
	Output raster format of the converted model. Supported formats are ''GTIFF, GPKG, ASC, FLT''.<Br>		Output raster format of the converted model. Supported formats are ''GTIFF, GPKG, ASC, FLT''.<Br>

	~~''<b>~~Output Profile~~</b>''<Br>~~		=====Output Profile=====
	This parameter is only used for GPKG format outputs. GPKG is a database and can store multiple layers inside one file. This option determines how the output GPKG layers will be grouped into databases.<br>		This parameter is only used for GPKG format outputs. GPKG is a database and can store multiple layers inside one file. This option determines how the output GPKG layers will be grouped into databases.<br>

Line 37:		Line 37:
	Optional parameter specifying the output location of the converted model. By default the output location will a new folder with the same name as the input TCF located in the same folder as the input TCF.<Br>		Optional parameter specifying the output location of the converted model. By default the output location will a new folder with the same name as the input TCF located in the same folder as the input TCF.<Br>

	~~''<b>~~Root Folder~~</b>''<br>~~		=====Root Folder=====
	By default the tool will try and find the 'root' folder containing the model files (commonly this folder is named 'TUFLOW'). The tool will try and guess the root folder based on the location of the TCF and the directory structure. If it can't find the root folder, or it picks the wrong folder then this parameter can be used to override this location within the tool.<Br>		By default the tool will try and find the 'root' folder containing the model files (commonly this folder is named 'TUFLOW'). The tool will try and guess the root folder based on the location of the TCF and the directory structure. If it can't find the root folder, or it picks the wrong folder then this parameter can be used to override this location within the tool.<Br>

	~~''<b>~~Scenarios~~</b>''<br>~~		=====Scenarios=====
	''Available since v3.6''<Br>		''Available since v3.6''<Br>
	The conversion can be restricted by specifying scenario and event names. Using this option will stop the conversion of layers that are within an 'IF Scenario/IF Event' logic blocks if the scenario name is not provided by the user. This option will also clean the control files and remove unused scenario names. Event names can also be used, however they are only applied to logic blocks in the control files and are not used to filter event sources provided in the TUFLOW Event File (.tef).		The conversion can be restricted by specifying scenario and event names. Using this option will stop the conversion of layers that are within an 'IF Scenario/IF Event' logic blocks if the scenario name is not provided by the user. This option will also clean the control files and remove unused scenario names. Event names can also be used, however they are only applied to logic blocks in the control files and are not used to filter event sources provided in the TUFLOW Event File (.tef).
Line 50:		Line 50:
	</ol>		</ol>

	~~''<b>~~GPKG Name~~</b>''<br>~~		=====GPKG Name=====
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Sets the output GPKG database name. Will only be used when outputing to GPKG and using a grouped output profile. If using a 'grouped by control file' profile, then the control file extension will still be added to the name e.g. <output-name>_TCF.gpkg.<Br>		Sets the output GPKG database name. Will only be used when outputing to GPKG and using a grouped output profile. If using a 'grouped by control file' profile, then the control file extension will still be added to the name e.g. <output-name>_TCF.gpkg.<Br>

	~~''<b>~~Write Empty Files~~</b>''<br>~~		=====Write Empty Files=====
	''Available since v3.7''<br>		''Available since v3.7''<br>
	If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>		If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>

	~~''<b>~~Output CRS~~</b>''<br>~~		=====Output CRS=====
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.		Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.

Ellis Symons at 05:56, 15 November 2022

2022-11-15T05:56:48Z

← Older revision		Revision as of 15:56, 15 November 2022
Line 9:		Line 9:

	====Parameters====		====Parameters====
			=====TCF=====
	''<B>TCF</b>''<Br>
	Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>		Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>

Ellis Symons at 05:56, 15 November 2022

2022-11-15T05:56:26Z

← Older revision		Revision as of 15:56, 15 November 2022
Line 8:		Line 8:
	[[File: convert_gis_format_in_panel.PNG]]<Br>		[[File: convert_gis_format_in_panel.PNG]]<Br>

	~~'''~~Parameters~~'''<Br>~~		====Parameters====
	''<B>TCF</b>''<Br>		''<B>TCF</b>''<Br>
	Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>		Location of an existing TUFLOW model TCF file. This is the TCF of the model that will be converted.<br>

Ellis Symons at 05:55, 15 November 2022

2022-11-15T05:55:29Z

← Older revision		Revision as of 15:55, 15 November 2022
Line 60:		Line 60:
	''<b>Output CRS</b>''<br>		''<b>Output CRS</b>''<br>
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection, or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.		Forces output files to be in given projection (no reprojection or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.

	===Checking the Output===		===Checking the Output===

Ellis Symons at 05:54, 15 November 2022

2022-11-15T05:54:56Z

← Older revision		Revision as of 15:54, 15 November 2022
Line 58:		Line 58:
	If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>		If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>

	''<b>CRS</b>''<br>		''<b>Output CRS</b>''<br>
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection, or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions~~. srs_def be in the style of "EPSG:XXXX" or can pass in PRJ or MIF projection string~~.		Forces output files to be in given projection (no reprojection, or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions.

	===Checking the Output===		===Checking the Output===

Ellis Symons at 05:53, 15 November 2022

2022-11-15T05:53:54Z

← Older revision		Revision as of 15:53, 15 November 2022
Line 58:		Line 58:
	If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>		If this option is checked on, the tool will create TUFLOW empty files as part of the conversion. The location of the empty directory will be guessed by the tool unless the user provides a relative path in the <b><tt>Write Empty Files Relative Directory</tt></b> input parameter. The path provided should be a relative path from the model root directory (e.g. commonly this is a folder called "TUFLOW", so a relative path might be <tt>model\gis\empty</tt>). The projection of the empty files will be based on the first <tt>"Projection == "</tt> command found in the TCF. If no <tt>"Projection == "</tt> is found, then empty files will not be created.<Br>

	''<br>CRS</b>''<br>		''<b>CRS</b>''<br>
	''Available since v3.7''<br>		''Available since v3.7''<br>
	Forces output files to be in given projection (no reprojection, or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. srs_def be in the style of "EPSG:XXXX" or can pass in PRJ or MIF projection string.		Forces output files to be in given projection (no reprojection, or warping is performed). Useful when converting a model with a combination of SHP and MIF files as these can generate slightly different projection definitions. srs_def be in the style of "EPSG:XXXX" or can pass in PRJ or MIF projection string.