Naming Convention - Revision history

Chris Huxley: /* Control and Input Files – Version Numbering Convention */

2025-08-05T23:40:44Z

Control and Input Files – Version Numbering Convention

← Older revision		Revision as of 09:40, 6 August 2025
Line 123:		Line 123:
	\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br> gis\2d_zsh_Development_002_R.shp		\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br> gis\2d_zsh_Development_002_R.shp
	\| style="text-align: center;" \| '''MODEL_004.tbc'''		\| style="text-align: center;" \| '''MODEL_004.tbc'''
	\|\| gis\2d_bc_EG00_001_L.shp<br> '''gis\~~2f_rf_004_R~~.shp'''		\|\| gis\2d_bc_EG00_001_L.shp<br> '''gis\2d_rf_004_R.shp'''
	\| style="text-align: center;" \| MODEL_003.ecf		\| style="text-align: center;" \| MODEL_003.ecf
	\|\| 1d_nwk_003.shp		\|\| 1d_nwk_003.shp
Line 132:		Line 132:
	\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br>'''gis\2d_zsh_Development_005_R.shp'''		\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br>'''gis\2d_zsh_Development_005_R.shp'''
	\| style="text-align: center;" \| MODEL_004.tbc		\| style="text-align: center;" \| MODEL_004.tbc
	\|\| gis\2d_bc_EG00_001_L.shp<br> gis\~~2f_rf_004_R~~.shp		\|\| gis\2d_bc_EG00_001_L.shp<br> gis\2d_rf_004_R.shp
	\| style="text-align: center;" \| '''MODEL_005.ecf'''		\| style="text-align: center;" \| '''MODEL_005.ecf'''
	\|\| '''1d_nwk_Pipes_005.shp'''		\|\| '''1d_nwk_Pipes_005.shp'''

Emilie Nielsen at 00:09, 23 September 2024

2024-09-23T00:09:16Z

← Older revision		Revision as of 10:09, 23 September 2024
Line 9:		Line 9:
	Additionally, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present, which may be the case for large modelling projects. Once a naming and numbering convention is adopted, then a <u>[[TUFLOW_Modelling_Log\|modelling log]]</u> can more easily be kept.<br>		Additionally, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present, which may be the case for large modelling projects. Once a naming and numbering convention is adopted, then a <u>[[TUFLOW_Modelling_Log\|modelling log]]</u> can more easily be kept.<br>
	<br>		<br>
	There is some simple advice on naming conventions in the <u>[https://~~downloads~~.tuflow.com/~~_archive~~/~~TUFLOW~~/~~Releases~~/~~2018-03/TUFLOW%20Manual.2018-03.pdf 2018~~ TUFLOW Manual]</u>.<br>		There is some simple advice on naming conventions in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>.<br>
	Currently, most modelling incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name. <u>[[TUFLOW Example Models\|Example models]]</u> are available which demonstrate Scenario/Event management. A <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> can then be set up to run various scenario combinations from the one TUFLOW Control File (TCF).<br>		Currently, most modelling incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name. <u>[[TUFLOW Example Models\|Example models]]</u> are available which demonstrate Scenario/Event management. A <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> can then be set up to run various scenario combinations from the one TUFLOW Control File (TCF).<br>
	<br>		<br>
Line 18:		Line 18:
	As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>		As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>
	<br>		<br>
	TUFLOW input files are given different recommended prefixes depending on their purpose. An example of this is demonstrated in the table below. The complete list of recommended prefixes can be found in the <u>[https://~~downloads~~.tuflow.com/~~_archive~~/~~TUFLOW~~/~~Releases~~/~~2018-03/TUFLOW%20Manual.2018-03.pdf~~ TUFLOW Manual]</u>. The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[TUFLOW Empty Files]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>		TUFLOW input files are given different recommended prefixes depending on their purpose. An example of this is demonstrated in the table below. The complete list of recommended prefixes can be found in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[TUFLOW Empty Files]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>
	<br>		<br>
	It is strongly recommended that the prefixes described in the <u>[https://~~downloads~~.tuflow.com/~~_archive~~/~~TUFLOW~~/~~Releases~~/~~2018-03/TUFLOW%20Manual.2018-03.pdf~~ TUFLOW Manual]</u> be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files, making it easier for another modeller or reviewer to quickly interpret the model.<br>		It is strongly recommended that the prefixes described in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u> be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files, making it easier for another modeller or reviewer to quickly interpret the model.<br>

	{\| class="wikitable" width="75%"		{\| class="wikitable" width="75%"

Emilie Nielsen at 03:29, 23 October 2023

2023-10-23T03:29:00Z

Show changes

Emilie Nielsen: /* Input File Type – Prefix Naming Conventions */

2023-10-02T04:57:02Z

Input File Type – Prefix Naming Conventions

← Older revision		Revision as of 14:57, 2 October 2023
Line 17:		Line 17:
	As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>		As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>
	<br>		<br>
	TUFLOW input files are given different recommended prefixes depending on their purpose. This is demonstrated in the table below (~~Table~~ ~~2.4~~ of the [~~http~~://~~www~~.tuflow.com/~~Tuflow~~%~~20Documentation~~.~~aspx 2016~~-03~~-AE~~ TUFLOW Manual]). The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[TUFLOW Empty Files]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>		TUFLOW input files are given different recommended prefixes depending on their purpose. This is demonstrated in the table below (can be found in the <u>[https://downloads.tuflow.com/_archive/TUFLOW/Releases/2018-03/TUFLOW%20Manual.2018-03.pdf TUFLOW Manual]</u>). The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[TUFLOW Empty Files]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>
	<br>		<br>
	It is strongly recommended that the prefixes described in the table below be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files , making it easier for another modeller or reviewer to quickly interpret the model.<br>		It is strongly recommended that the prefixes described in the table below be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files, making it easier for another modeller or reviewer to quickly interpret the model.<br>
	<br>		<br>

Emilie Nielsen at 04:54, 2 October 2023

2023-10-02T04:54:05Z

← Older revision		Revision as of 14:54, 2 October 2023
Line 9:		Line 9:
	Additionally, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present, which may be the case for large modelling projects. Once a naming and numbering convention is adopted, then a <u>[[TUFLOW_Modelling_Log\|modelling log]]</u> can more easily be kept.<br>		Additionally, a sound naming convention can significantly reduce the time taken to locate files, especially in folders where hundreds of files are present, which may be the case for large modelling projects. Once a naming and numbering convention is adopted, then a <u>[[TUFLOW_Modelling_Log\|modelling log]]</u> can more easily be kept.<br>
	<br>		<br>
	There is some simple advice on naming conventions in ~~Section 11.2 of~~ the [~~http~~://tuflow.com/~~Tuflow~~%~~20Documentation~~.~~aspx 2016~~-03 TUFLOW Manual].<br>		There is some simple advice on naming conventions in the <u>[https://downloads.tuflow.com/_archive/TUFLOW/Releases/2018-03/TUFLOW%20Manual.2018-03.pdf 2018 TUFLOW Manual]</u>.<br>
	Most modelling these days incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name ~~as shown in Section 11.3 of the Manual~~. <u>[[TUFLOW Example Models\|Example models]]</u> are available which demonstrate Scenario/Event management. You can then set up <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> to run various scenario combinations from the one TUFLOW Control File (TCF).<br>		Most modelling these days incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name. <u>[[TUFLOW Example Models\|Example models]]</u> are available which demonstrate Scenario/Event management. You can then set up <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> to run various scenario combinations from the one TUFLOW Control File (TCF).<br>
	<br>		<br>
	The below sections provide information on the recommended naming convention for clearly identifying different types of TUFLOW input files. Guidance is also provided on a version numbering convention for control and input files during model development.<br>		The below sections provide information on the recommended naming convention for clearly identifying different types of TUFLOW input files. Guidance is also provided on a version numbering convention for control and input files during model development.<br>

Emilie Nielsen: /* Input File Type – Prefix Naming Conventions */

2023-10-02T00:49:18Z

Input File Type – Prefix Naming Conventions

← Older revision		Revision as of 10:49, 2 October 2023
Line 17:		Line 17:
	As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>		As the bulk of the data input to TUFLOW is via GIS layers, efficient management of these datasets is essential. Different TUFLOW input files require different GIS attributes. For example, an initial water level input file only requires a single attribute on the GIS file (which is the initial water level), whereas, a 1D channel has a number of attributes (channel type, inverts etc.). Differentiating between these TUFLOW file types is therefore essential.<br>
	<br>		<br>
	TUFLOW input files are given different recommended prefixes depending on their purpose. This is demonstrated in the table below (Table 2.4 of the [http://www.tuflow.com/Tuflow%20Documentation.aspx 2016-03-AE TUFLOW Manual]). The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[~~TUFLOW_Empty_Files~~]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>		TUFLOW input files are given different recommended prefixes depending on their purpose. This is demonstrated in the table below (Table 2.4 of the [http://www.tuflow.com/Tuflow%20Documentation.aspx 2016-03-AE TUFLOW Manual]). The TCF command <font color="blue"><tt>Write Empty GIS Files</tt></font> can be used to automate the creation of the template (empty) files, which use these recommended prefixes. These empty files are created with the precise GIS file formats required for each input TUFLOW file. The <u>[[TUFLOW Empty Files]]</u> page provides a reference list of the template (empty) GIS files, the associated TUFLOW command and a basic description of their function.<br>
	<br>		<br>
	It is strongly recommended that the prefixes described in the table below be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files , making it easier for another modeller or reviewer to quickly interpret the model.<br>		It is strongly recommended that the prefixes described in the table below be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files , making it easier for another modeller or reviewer to quickly interpret the model.<br>

Emilie Nielsen at 00:46, 2 October 2023

2023-10-02T00:46:35Z

← Older revision		Revision as of 10:46, 2 October 2023
Line 10:		Line 10:
	<br>		<br>
	There is some simple advice on naming conventions in Section 11.2 of the [http://tuflow.com/Tuflow%20Documentation.aspx 2016-03 TUFLOW Manual].<br>		There is some simple advice on naming conventions in Section 11.2 of the [http://tuflow.com/Tuflow%20Documentation.aspx 2016-03 TUFLOW Manual].<br>
	Most modelling these days incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name as shown in Section 11.3 of the Manual. <u>[[ ~~Example_Models_Home_page~~\|Example models]]</u> are available which demonstrate Scenario/Event management. You can then set up <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> to run various scenario combinations from the one TUFLOW Control File (TCF).<br>		Most modelling these days incorporates use of the TUFLOW scenario and event management feature. This allows for wildcards to be incorporated in the file name as shown in Section 11.3 of the Manual. <u>[[TUFLOW Example Models\|Example models]]</u> are available which demonstrate Scenario/Event management. You can then set up <u>[[ Run_TUFLOW_From_a_Batch-file#Looping_in_a_batch_file\|batch file]]</u> to run various scenario combinations from the one TUFLOW Control File (TCF).<br>
	<br>		<br>
	The below sections provide information on the recommended naming convention for clearly identifying different types of TUFLOW input files. Guidance is also provided on a version numbering convention for control and input files during model development.<br>		The below sections provide information on the recommended naming convention for clearly identifying different types of TUFLOW input files. Guidance is also provided on a version numbering convention for control and input files during model development.<br>

Chris Huxley at 03:14, 6 June 2022

2022-06-06T03:14:44Z

← Older revision		Revision as of 13:14, 6 June 2022
Line 113:		Line 113:
	\|-		\|-
	\|}		\|}
			<br>
			{{Tips Navigation
			\|uplink=[[TUFLOW_Modelling_Guidance \| Back to TUFLOW Modelling Guidance]]
			}}

Stephen.kime: /* Input File Type – Prefix Naming Conventions */

2018-02-22T01:48:43Z

Input File Type – Prefix Naming Conventions

@@ Line 21: / Line 21: @@
 It is strongly recommended that the prefixes described in the table below be adhered to for all 1D and 2D GIS layers. This greatly enhances the data management efficiency and, importantly, allows for the differentiation of input files , making it easier for another modeller or reviewer to quickly interpret the model.<br>
 <br>
 '''Note''' that the TUFLOW control files are structured to allow the majority of commands to be repeated and layered. Input file types of the same prefix may need to be used more than once.  Hence, additional information such as a descriptor and a file version number is conventionally included in the input file name. An example of a typical file name for an input file is shown below:

Teegan.Burke at 22:55, 17 May 2017

2017-05-17T22:55:41Z

Show changes

← Older revision		Revision as of 09:40, 6 August 2025
Line 123:		Line 123:
	\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br> gis\2d_zsh_Development_002_R.shp		\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br> gis\2d_zsh_Development_002_R.shp
	\| style="text-align: center;" \| '''MODEL_004.tbc'''		\| style="text-align: center;" \| '''MODEL_004.tbc'''
	\|\| gis\2d_bc_EG00_001_L.shp<br> '''gis\~~2f_rf_004_R~~.shp'''		\|\| gis\2d_bc_EG00_001_L.shp<br> '''gis\2d_rf_004_R.shp'''
	\| style="text-align: center;" \| MODEL_003.ecf		\| style="text-align: center;" \| MODEL_003.ecf
	\|\| 1d_nwk_003.shp		\|\| 1d_nwk_003.shp
Line 132:		Line 132:
	\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br>'''gis\2d_zsh_Development_005_R.shp'''		\|\| gis\2d_loc_EG00_001_L.shp<br> gis\2d_code_001_R.shp<br> grid\DEM_2mLidar_001.tif<br>'''gis\2d_zsh_Development_005_R.shp'''
	\| style="text-align: center;" \| MODEL_004.tbc		\| style="text-align: center;" \| MODEL_004.tbc
	\|\| gis\2d_bc_EG00_001_L.shp<br> gis\~~2f_rf_004_R~~.shp		\|\| gis\2d_bc_EG00_001_L.shp<br> gis\2d_rf_004_R.shp
	\| style="text-align: center;" \| '''MODEL_005.ecf'''		\| style="text-align: center;" \| '''MODEL_005.ecf'''
	\|\| '''1d_nwk_Pipes_005.shp'''		\|\| '''1d_nwk_Pipes_005.shp'''