QGIS TUFLOW Create Project - Revision history

Ellis Symons at 11:30, 5 April 2022

2022-04-05T11:30:38Z

← Older revision		Revision as of 21:30, 5 April 2022
Line 24:		Line 24:
	===GIS Format===		===GIS Format===
	''Available in v3.3''<br>		''Available in v3.3''<br>
	Select the default GIS format used in the TUFLOW model. If creating empty files, the empty files will be output in this format along with the projection file. Using GPKG format is only compatible with ~~v2022 of~~ TUFLOW Classic/HPC or later.		Select the default GIS format used in the TUFLOW model. If creating empty files, the empty files will be output in this format along with the projection file. Using GPKG format is only compatible with TUFLOW Classic/HPC v2022 or later.
	===Creating TUFLOW Folder Structure===		===Creating TUFLOW Folder Structure===
	If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.		If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created (the structure also depends on the TUFLOW Engine selection). A shapefile is also saved inside the TUFLOW folder. As an example, for TUFLOW Classic/HPC this is saved within the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.
	===Run TUFLOW to create template files===		===Run TUFLOW to create template files===
	If the '''Run TUFLOW to create template files''' check-box is enabled a TUFLOW simulation is started with the '''Create_Empties.tcf''' as in the input file. This simulation only has three commands:		If the '''Run TUFLOW to create template files''' check-box is enabled a TUFLOW simulation is started with the '''Create_Empties.tcf''' (or equivalent FVC) as in the input file. This simulation only has three commands:
	<pre>		<pre>
	GIS FORMAT == SHP		GIS FORMAT == SHP
Line 34:		Line 34:
	Write Empty GIS Files == ..\model\gis\empty		Write Empty GIS Files == ..\model\gis\empty
	</pre>		</pre>
	When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.<Br>		When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder (or TUFLOW FV equivalent). All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.<Br>
	===Tutorial Model===		===Tutorial Model===
	Automatically sets the tutorial command inside the output TCF or FVC file when creating empty files. For TUFLOW Classic/HPC a license is not required to generate empty files therefore this option is only recommended if working through the free tutorial models. Some ~~build~~ of TUFLOW FV ~~does~~ not support empty file creation without a license, however TUFLOW FV ~~also~~ ~~supports~~ a free tutorial mode and so this option will allow users who are not currently connected to a license to create empty files.		Automatically sets the tutorial command inside the output TCF or FVC file when creating empty files. For TUFLOW Classic/HPC a license is not required to generate empty files therefore this option is only recommended if you are working through the free tutorial models. Some builds of TUFLOW FV do not support empty file creation without a license, however TUFLOW FV does support a free tutorial mode and so this option will allow users who are not currently connected to a license to create empty files.
	<Br>		<Br>

Ellis Symons at 11:26, 5 April 2022

2022-04-05T11:26:38Z

← Older revision		Revision as of 21:26, 5 April 2022
Line 1:		Line 1:
		⚫	The tool serves two main purposes, it saves the location of your TUFLOW preferences, it can also be used to create the TUFLOW folder structure and run a model to create the template (empty) GIS files.<br><br>
⚫	~~This~~ tool can be found in the TUFLOW >> Editing >> Configure / Create TUFLOW Project.<br>

⚫	The tool serves two main purposes, it saves the location of your TUFLOW preferences, it can also be used to create the TUFLOW folder structure and run a model to create the template (empty) GIS files. ~~The dialogue for the utility looks like the below:~~<br>
			===Running the Tool===
		⚫	The tool can be found under the QGIS menu '''Plugins >> TUFLOW >> Editing >> Configure / Create TUFLOW Project'''.<br>
	[[File:QgisTuflow Configure Project.jpg]]		[[File:QgisTuflow Configure Project.jpg]]

	=Saving Settings=		===Saving Settings===
	This utility can be used to save the location of the following for a TUFLOW project:		This utility can be used to save the location of the following for a TUFLOW project:
	* TUFLOW Model Projection		* TUFLOW Model Projection
Line 9:		Line 11:
	* The location of the TUFLOW executable		* The location of the TUFLOW executable
	This information can be saved in two locations to the '''current project''' and '''global settings'''. Each time the utility is run the project settings will be updated. If the '''Save Default Settings Globally (for all projects)''' is checked, the default settings will be saved globally. When subsequent tools are run, the settings are checked and if project specific settings are set these will be used, if no project specific data is set then the utilities will default to the global defaults.<br>		This information can be saved in two locations to the '''current project''' and '''global settings'''. Each time the utility is run the project settings will be updated. If the '''Save Default Settings Globally (for all projects)''' is checked, the default settings will be saved globally. When subsequent tools are run, the settings are checked and if project specific settings are set these will be used, if no project specific data is set then the utilities will default to the global defaults.<br>
	==Setting CRS==		===Setting CRS===
	When setting the CRS ('''C'''oordinate '''R'''eference '''S'''ystem) there are two options:		When setting the CRS ('''C'''oordinate '''R'''eference '''S'''ystem) there are two options:
	* Load these from an existing vector dataset in the layer control. To do this, in the '''Source Projection Layer''' select the desired source layer. When selected the CRS description and ID will update in the dialogue fields.		* Load these from an existing vector dataset in the layer control. To do this, in the '''Source Projection Layer''' select the desired source layer. When selected the CRS description and ID will update in the dialogue fields.
	* By using the Coordinate Reference System Selector. To open this hit the '''Select CRS''', the CRS selector will open as per the image below (click to enlarge):<br>		* By using the Coordinate Reference System Selector. To open this hit the '''Select CRS''', the CRS selector will open as per the image below (click to enlarge):<br>
	[[File:QgisTUFLOW CRS Selector.JPG\|400px]]		[[File:QgisTUFLOW CRS Selector.JPG\|400px]]
	==Setting TUFLOW folder==		===Setting TUFLOW folder===
	Select a TUFLOW folder for your model. This should be the folder that contains the entire TUFLOW model folder structure. For example, if your TUFLOW folder is "D:\projects\Example\TUFLOW", the folder set here should be “D:\projects\Example\”. All of the following tools will use this location.		Select a TUFLOW folder for your model. This should be the folder that contains the entire TUFLOW model folder structure. For example, if your TUFLOW folder is "D:\projects\Example\TUFLOW", the folder set here should be “D:\projects\Example\”. All of the following tools will use this location.
	==Set the TUFLOW executable==		===Set the TUFLOW executable===
	Select the '''Browse...''' option next to the TUFLOW executable display to bring up a dialogue and select the desired TUFLOW executable. This needs to be downloaded from the TUFLOW website.		Select the '''Browse...''' option next to the TUFLOW executable display to bring up a dialogue and select the desired TUFLOW executable. This needs to be downloaded from the TUFLOW website. The executable must match the TUFLOW Engine choice, for example if "TUFLOW Classic/HPC" is selected, then the executable must point to the appropriate executable (TUFLOW_iSP_w64.exe).
			===TUFLOW Engine===
	=Save Global Settings=
			Select the desired TUFLOW engine. This must match the executable selected in the above step.
	When saving the configured settings, these can be saved in two locations:
			===GIS Format===
	* Current project
			''Available in v3.3''<br>
	* Global settings
			Select the default GIS format used in the TUFLOW model. If creating empty files, the empty files will be output in this format along with the projection file. Using GPKG format is only compatible with v2022 of TUFLOW Classic/HPC or later.
	If the '''Save Settings Globally (for all projects)''' check box is selected as well as saving the settings to the current QGIS project file, this is also save as a global setting. When a tool is used, if no project based setting has been saved the global settings will be used. To change the global settings, this tool can be run again with the '''Save Settings Globally (for all projects)''' check box selected, this will overwrite the global settings.
	=Creating TUFLOW Folder Structure=		===Creating TUFLOW Folder Structure===
	If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.		If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.
	=Run TUFLOW to create template files=		===Run TUFLOW to create template files===
	If the '''Run TUFLOW to create template files''' check-box is enabled a TUFLOW simulation is started with the '''Create_Empties.tcf''' as in the input file. This simulation only has three commands:		If the '''Run TUFLOW to create template files''' check-box is enabled a TUFLOW simulation is started with the '''Create_Empties.tcf''' as in the input file. This simulation only has three commands:
	<pre>		<pre>
Line 32:		Line 34:
	Write Empty GIS Files == ..\model\gis\empty		Write Empty GIS Files == ..\model\gis\empty
	</pre>		</pre>
	When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.		When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.<Br>
			===Tutorial Model===
			Automatically sets the tutorial command inside the output TCF or FVC file when creating empty files. For TUFLOW Classic/HPC a license is not required to generate empty files therefore this option is only recommended if working through the free tutorial models. Some build of TUFLOW FV does not support empty file creation without a license, however TUFLOW FV also supports a free tutorial mode and so this option will allow users who are not currently connected to a license to create empty files.
			<Br>

	<br>		<br>

Chris Huxley at 22:49, 2 June 2021

2021-06-02T22:49:26Z

← Older revision		Revision as of 08:49, 3 June 2021
Line 36:		Line 36:
	<br>		<br>
	{{Tips Navigation		{{Tips Navigation
	\|uplink=[[TUFLOW_QGIS_Plugin\| Back to TUFLOW QGIS Plugin Main Page]]		\|uplink=[[TUFLOW_QGIS_Plugin#Usage\| Back to TUFLOW QGIS Plugin Main Page]]
	}}		}}

Chris Huxley at 22:45, 2 June 2021

2021-06-02T22:45:31Z

← Older revision		Revision as of 08:45, 3 June 2021
Line 33:		Line 33:
	</pre>		</pre>
	When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.		When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty \| QGIS TUFLOW import empty]] plugin.

			<br>
			{{Tips Navigation
			\|uplink=[[TUFLOW_QGIS_Plugin\| Back to TUFLOW QGIS Plugin Main Page]]
			}}

Par at 05:32, 29 March 2016

2016-03-29T05:32:40Z

← Older revision		Revision as of 15:32, 29 March 2016
Line 18:		Line 18:
	==Set the TUFLOW executable==		==Set the TUFLOW executable==
	Select the '''Browse...''' option next to the TUFLOW executable display to bring up a dialogue and select the desired TUFLOW executable. This needs to be downloaded from the TUFLOW website.		Select the '''Browse...''' option next to the TUFLOW executable display to bring up a dialogue and select the desired TUFLOW executable. This needs to be downloaded from the TUFLOW website.
			=Save Global Settings=
⚫	=Creating TUFLOW ~~model~~=
			When saving the configured settings, these can be saved in two locations:
			* Current project
			* Global settings
			If the '''Save Settings Globally (for all projects)''' check box is selected as well as saving the settings to the current QGIS project file, this is also save as a global setting. When a tool is used, if no project based setting has been saved the global settings will be used. To change the global settings, this tool can be run again with the '''Save Settings Globally (for all projects)''' check box selected, this will overwrite the global settings.
		⚫	=Creating TUFLOW Folder Structure=
	If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.		If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.
	=Run TUFLOW to create template files=		=Run TUFLOW to create template files=

Par: Created page with "This tool can be found in the TUFLOW >> Editing >> Configure / Create TUFLOW Project.
The tool serves two main purposes, it saves the location of your TUFLOW preferences, ..."

2015-05-08T05:06:55Z

Created page with "This tool can be found in the TUFLOW >> Editing >> Configure / Create TUFLOW Project. The tool serves two main purposes, it saves the location of your TUFLOW preferences, ..."

New page

This tool can be found in the TUFLOW >> Editing >> Configure / Create TUFLOW Project. 
The tool serves two main purposes, it saves the location of your TUFLOW preferences, it can also be used to create the TUFLOW folder structure and run a model to create the template (empty) GIS files. The dialogue for the utility looks like the below: 
[[File:QgisTuflow Configure Project.jpg]]

=Saving Settings=
This utility can be used to save the location of the following for a TUFLOW project:
* TUFLOW Model Projection
* The parent folder that contains the TUFLOW model
* The location of the TUFLOW executable
This information can be saved in two locations to the '''current project''' and '''global settings'''. Each time the utility is run the project settings will be updated. If the '''Save Default Settings Globally (for all projects)''' is checked, the default settings will be saved globally. When subsequent tools are run, the settings are checked and if project specific settings are set these will be used, if no project specific data is set then the utilities will default to the global defaults. 
==Setting CRS==
When setting the CRS ('''C'''oordinate '''R'''eference '''S'''ystem) there are two options:
* Load these from an existing vector dataset in the layer control. To do this, in the '''Source Projection Layer''' select the desired source layer. When selected the CRS description and ID will update in the dialogue fields.
* By using the Coordinate Reference System Selector. To open this hit the '''Select CRS''', the CRS selector will open as per the image below (click to enlarge): 
[[File:QgisTUFLOW CRS Selector.JPG|400px]]
==Setting TUFLOW folder==
Select a TUFLOW folder for your model. This should be the folder that contains the entire TUFLOW model folder structure. For example, if your TUFLOW folder is "D:\projects\Example\TUFLOW", the folder set here should be “D:\projects\Example\”. All of the following tools will use this location.
==Set the TUFLOW executable==
Select the '''Browse...''' option next to the TUFLOW executable display to bring up a dialogue and select the desired TUFLOW executable. This needs to be downloaded from the TUFLOW website.
=Creating TUFLOW model=
If the '''Create TUFLOW Folder Structure''' check-box is enabled when the utility is run, a standard TUFLOW folder structure is created. A shapefile is also saved to the TUFLOW\model\gis\ folder and a simple TUFLOW control file (.tcf) is created. This .tcf file is in the TUFLOW\runs\ folder and is named '''Create_Empties.tcf'''.
=Run TUFLOW to create template files=
If the '''Run TUFLOW to create template files''' check-box is enabled a TUFLOW simulation is started with the '''Create_Empties.tcf''' as in the input file. This simulation only has three commands:
<pre>
GIS FORMAT == SHP
SHP Projection == ..\model\gis\projection.prj
Write Empty GIS Files == ..\model\gis\empty
</pre>
When started this simulation will create a series of template files in the TUFLOW\model\gis\empty folder. All of these template files have projection (CRS) as defined and have the correct GIS attributes for use in TUFLOW modelling. This can be brought into QGIS using the [[QGIS_TUFLOW_Import_Empty | QGIS TUFLOW import empty]] plugin.