Revision as of 16:56, 18 November 2018 by Mitch3007 (Talk | contribs) (Set GIS Projection and Create Empty (Template) GIS Files)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search



    This page provides instruction on how to setup TUFLOW FV GIS integration. Using GIS files with TUFLOW FV allows you to independently assign nodestrings, cell materials and cell elevations updates to the mesh. It also provides you with access to a range of GIS check files that make it easy to review your model.

    Project Initialisation

    Setup Model Folders

    TUFLOW models are separated into a series of folders which contain the input and output files.

    1. Set up the model directory and sub-directories as recommended in the list below (for a more detailed description please see the Folders and Filepath Section of the FV User Manual). Alternatively, you can copy the TUFLOWFV folder and all sub-folders from the TUFLOWFV Folders Template folder in the supplied files to a local drive on your computer.

      Sub-Folder Input / Output Description
      bc_dbase Input Boundary input time-series data
      bc_dbase\tide Input Boundary input tide time-series data
      bc_dbase\met Input Boundary input meteorological time-series data
      check Output GIS and other check files to carry out quality control checks (use Write Check Files).
      model Input Geometry, Boundary, or Material include files (i.e. no GIS files and not .fvc files).
      model\geo Input Mesh file (.2dm) and cell centred (.csv) files (i.e. no GIS files).
      model\gis Input GIS layers that are inputs to the 2D and 1D model domains are contained within this folder: model\gis\ is typically used for all ArcGIS and QGIS files
      model\mi Input GIS layers that are inputs to the 2D and 1D model domains are contained within this folder: model\mi\ is typically used for MapInfo formatted GIS files
      results Output TUFLOW FV will output the results to this folder in a variety of formats as specified by the user.
      runs Input TUFLOW FV Control Files (.fvc)
      runs\log Output TUFLOW FV log files (.log) and messages layers.

      The following points on TUFLOW FV folders and filenames are worth noting:

      * TUFLOW FV accepts any folder structure, though the above listed format is most commonly used and is recommended.
      * Whilst TUFLOW FV readily accepts spaces and special characters (such as ! or #) in filenames and paths, other software may have issues with these. It is therefore recommended that spaces and other special characters (such as dashes) are not used in the simulation path and filenames (without prior testing).
      * Folder paths, filenames, file extensions and TUFLOW FV commands are not case sensitive in any TUFLOW FV control files.
      * The model\mi\ is used for MapInfo inputs, model\gis\ for ArcGIS and QGIS inputs. Any directories that don't apply can be omitted, for example if you are working in MapInfo the model\gis directory may not be be required.

    Set GIS Projection and Create Empty (Template) GIS Files

    The first step when creating a TUFLOW FV model always requires the user to define the GIS projection (ie. the geographic coordinate system to be used for the TUFLOW model) and also write template GIS files for future model inputs.
    Note: All model inputs will need to use a common projection.

    1. Create a projection file and write the template GIS files (to be used to build the model) for the project. For a description on how to do this please select your GIS package below.
      ArcMap users can automate this step using the ArcTUFLOw Toolbox. Similarly, QGIS users can also automate the process using the QGIS TUFLOW Plugin.
    2. The next step is to create a TUFLOW Control File (TCF files are used to control the input and output from TUFLOW) and create the 'template' or 'empty' GIS files. TUFLOW will assign the same projection as the GIS layer created above to the template files and also set the file fields or attributes so they are compatible with the desired purpose of the file. See Empty Template GIS Files for more information about each of the TUFLOW template GIS files. In a text editor, create a new file and save to the TUFLOW\runs folder. Since this is Module 1 and the model we’ll produce has a 5m grid, name the file M01_5m_001.tcf.
    3. Enter the text as shown below into the newly created text file M01_5m_001.tcf:
      Tutorial Model == ON

      MapInfo Users:
      GIS Format == MIF
      MI Projection == ..\model\mi\Projection.mif
      Write Empty MI Files == ..\model\mi\empty

      ArcGIS and QGIS Users:
      GIS Format == SHP
      SHP Projection == ..\model\gis\Projection.prj
      Write Empty GIS Files == ..\model\gis\empty | SHP
    4. Save the TCF file.

      * You can insert comments into this file if you find it helpful. This is highly recommended. Comments are preceded by an exclamation mark or a hash symbol (i.e. ! or #). Comments can be written after the command or have their own line. Any command following the comment symbol is ignored by TUFLOW.
      * Notice the syntax highlighting in the commands listed above. If you have not already enabled syntax highlighting in your preferred text editing software, we recommend you do. Instructions are provided in the Tips and Tricks section for each software Notepad++, UltraEdit, TextPad.

    Run TUFLOW to Create Empty (Template) GIS Files

    We now need to run TUFLOW using the TUFLOW Control File (TCF). There are a number of ways TUFLOW can be setup to run. In each case the TUFLOW executable is started with the TCF as the input. For more information on running TUFLOW please refer to the Managing and Starting Simulations section of the User Manual. The most common ways are outlined below. We will be using a batch file for this tutorial, however any of the methods below will work.

      Alternative Methods for Running TUFLOW
    1. Start TUFLOW from a batch file using the TCF file we have created (M01_5m_001.tcf). Follow the steps outlined in, Running TUFLOW from a Batch-file to create the batch file.
    2. Double click the created batch file (.bat) from Windows Explorer to execute the simulation. A console (DOS) window should appear as shown below:

    3. After a few seconds the information dialog box shown below should appear. Click OK to close the windows.
      File:Tute M01 TUFLOW Empties Created.png

    4. Check the folder specified to view the ‘Empty’ template files have been written.
      • For MapInfo Users these should be in TUFLOW\model\mi\empty\
      • For ArcGIS and QGIS Users this should be TUFLOW\model\gis\empty\