Tuflow

Naming Convention: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
No edit summary
 
(One intermediate revision by one other user not shown)
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>
<br>
There is some simple advice on naming conventions in the <u>[https://downloadsdocs.tuflow.com/_archiveclassic-hpc/TUFLOWmanual/Releaseslatest/2018-03/TUFLOW%20Manual.2018-03.pdf 2018 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>
<br>
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>
<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://downloadsdocs.tuflow.com/_archiveclassic-hpc/TUFLOWmanual/Releaseslatest/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>
It is strongly recommended that the prefixes described in the <u>[https://downloadsdocs.tuflow.com/_archiveclassic-hpc/TUFLOWmanual/Releaseslatest/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>
 
{| class="wikitable" width="75%"
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
| style="text-align: center;" | '''MODEL_004.tbc'''
|| gis\2d_bc_EG00_001_L.shp<br> '''gis\2f_rf_004_R2d_rf_004_R.shp'''
| style="text-align: center;" | MODEL_003.ecf
|| 1d_nwk_003.shp
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'''
| style="text-align: center;" | MODEL_004.tbc
|| gis\2d_bc_EG00_001_L.shp<br> gis\2f_rf_004_R2d_rf_004_R.shp
| style="text-align: center;" | '''MODEL_005.ecf'''
|| '''1d_nwk_Pipes_005.shp'''
Retrieved from "https://wiki.tuflow.com/Naming_Convention"