GeoPackage Tips: Difference between revisions

This page includes tips and tricks for working with the GeoPackageGPKG Vectorvector format (supported since the TUFLOW 2023-03-AA Release). GeoPackageGPKG is a widely supported, open GIS database format, built upon an SQLite database (data is stored as a single file with the extension .gpkg). <br><br>

*Multiple GIS layers can be stored in the single file database. For example, all GIS input layers can be stored in a single GeoPackageGPKG file.

For more information, seerefer to Section 4.4.3 of the <u>[https://wwwdocs.tuflow.com/downloads/tuflow-classichpcclassic-archivehpc/manual/latest/#2023 2023 ReleaseTUFLOW NotesManual]</u>.

There are many ways to organise model inputs when using GeoPackagesGPKG. This allows modellers to decide how they structure their inputs files, for example some options include:

*a singleSingle database for an entire project,

*separateSeparate database for aneach existingcontrol orfile developed(e.g. casegeometry, orboundary control file)

*separateSeparate databases for each type of input (e.g. elevation, materials, culverts).

To reference a GeoPackageGPKG Database:

<li>To specifySpecify a GeoPackageGPKG Database for the entire model, addby adding the following command to the beginning of the .tcf. This database will then be the default for all inputs in all control files. There is no need to reference the database again in the other control files. <br>

<li>To specifySpecify a different GeoPackageGPKG Database for subsequent inputs, useusing the following command. A new database can be specified multiple times throughout control files, TUFLOW will change which database it looks to based oninto the last timedatabase thereferenced above commandthe has been referencedfeature. ThisThe command can be used in the .tcf, .ecf, .tbc, .tgc, .qcf, .tef. For example:<br>

<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_zsh.gpkg </tt> <font color="green"><tt> ! Sets GeoPackageGPKG Database</tt></font> <br>

<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_mat.gpkg </tt></font> <font color="green"><tt> ! Sets GeoPackageGPKG Database</tt></font> <br>

There are many ways to reference a GeoPackageGPKG Layer. The following commands can be used in the .tcf, .ecf, .tbc, .tgc, .qcf and .tef. <br>

<li>To specify a table in a .gpkgGPKG, use ">>":<br>

<li>To specify more than one table in a .gpkgGPKG in the same command line, use "&&|". ThisThe isdatabase similarhas to "|",be howeverreferenced therefor is no need to referenceall the database againtables. <br>

<li>To specify a .gpkgGPKG file path only. It will assume the table name is the same as the .gpkgGPKG database name. The following are equivalent:<br>

<li>To specify all the tables in a .gpkgGPKG, use the command "USE ALL" with ">>":<br>

If the GeoPackageGPKG Database is specified to use for subsequent inputs, the commands will become:<br>

<font color="blue"><tt>Spatial Database </tt></font> <font color="red"><tt>== </tt></font> <font color="black"><tt>gis\2d_zsh.gpkg </tt> <font color="green"><tt> ! Sets GeoPackageGPKG Database</tt></font> <br>

Note: If the .gpkgGPKG for the model is referenced in the .tcf (using the 'Spatial Database' command), it does not need to be referenced again in the other control files. However, if the model inputs are not contained in a single .gpkgGPKG, the separate databases must be referenced accordingly.

Result and check file vector outputs can be written into separate databases or grouped, with 'grouped' being the default. Grouped databases will group by output folder location, for example, the check file folder will contain one GeoPackageGPKG Database that contains all check file layers within it. Separate databases will group geometries together, for example, PLOT_P, PLOT_L, PLOT_R will be written to one database. The following command can be used to set the output to either separate or grouped: <br>

This is a huge benefit in terms of file organisation. The below shows athe TUFLOW 'Check' folder from a model using the GeoPackageGPKG (grouped) and a model using the GPKG separate. The same 'Check' folder for a model using Shapefile would have 44(!) items in it. <br><br>

{{Video|name=GPKG Tips CheckFilesAnimation_Outputs_grouped.mp4|width=1000}}<br>

The <u>[[Convert_TUFLOW_Model_GIS_Format| Convert TUFLOW Model GIS Format]]</u> tool has been developed to convert fromconverts one GIS format to another for an entire model (input files and control files). For example, if you have a model currently using the SHP vector format and FLT raster format, you can automatically convertbe itconverted to GPKG and TIF. This tool works both ways (to or from GeoPackageGPKG) for any TUFLOW supported formatformats and will automatically beis available in the 'Processing Toolbox' if you haveonce the <u>[[TUFLOW_QGIS_Plugin | TUFLOW Plugin]]</u> is installed. <br><br>

QGIS is used to configure TUFLOW projects with the TUFLOW plugin. To configure a new TUFLOW project with GeoPackageGPKG as the GIS format, use the TUFLOW plugin:

<li>Click 'Select CRS' to select the required CRS for the project.

<li>Select the required TUFLOW Engine and box options.

<li>Click 'OK'. This will configure the TUFLOW project using GeoPackageGPKG.<br>

== Setting a BrowerBrowser Panel Favourite ==

{{Video|name=browser_panel_move_layerbrowser_panel_move_layer_b.mp4|width=1000}}

<li>Move a shapefile into a GPKG. QGIS will automatically convertconverts it to a GPKG layer.<br>

{{Video|name=browser_panel_move_shpbrowser_panel_move_shp_a.mp4|width=1000}}

{{Video|name=Animation_rename_layerAnimation_rename_layer_a.mp4|width=1000}}

This TUFLOW Plugin tool saves a copy of the active layer with a new filename. To use the tool:

<li>Select the layer to increment in the Layers Panelpanel.

<li>Increment layer only (default): This option will incrementincrements the filename and the .gpkgGPKG database by 1. It will then closecloses the old layer and openopens the new one. For example, the tool increments '''M01_00''1''M01_001.gpkg''' to '''M01_00''2''M01_002.gpkg''' and '''2d_code_M01_00''1''_R2d_code_M01_001_R''' to '''2d_code_M01_00''2''_R2d_code_M01_002_R'''.

:*Note: In the video below, the output database is manually changed back to '''M01_00''1''M01_001.gpkg''',. howeverIf the ifdefault leftsettings aswere thenot default,changed the new layer would behave been added to a new gpkgGPKG, '''M01_00''2''M01_002.gpkg'''. <br>

<li>Increment layer and preserve database: This option will incrementincrements the filename of the selected layer and the .gpkgGPKG database by 1. It will also copycopies all other layers from the .gpkgoriginal GPKG database into the newincremented .gpkgGPKG database. For example, the tool makes a copy of '''M01_00''1''M01_001.gpkg''' and increments it to '''M01_00''2''M01_002.gpkg'''. All layers are copied across with their original filename, except the selected layer, which is incremented to '''2d_code_M01_002_R'''.<br>

<li>Save layer out into superseded folder: This option will incrementincrements the the filename of the selected layer by 1. It will then closecloses the old layer and openopens the new one. The old layer will begets moved into a new folder called 'ss'. For example, the tool increments '''2d_code_M01_00''1''_R2d_code_M01_001_R''' to '''2d_code_M01_00''2''_R2d_code_M01_002_R''' and moves '''2d_code_M01_00''1''_R2d_code_M01_001_R''' to the 'ss' folder. <br>

For more information, see the <u>[[QGIS_TUFLOW_Increment_Layer| Increment Layer Tool]].</u><br>

This tool will change the layer name (within the Layers Panelpanel) to be the same as the layer name within the GeoPackageGPKG database. To use the tool:

<li>Drag and Drop the GeoPackageGPKG Database from Windows File Explorer to QGIS.

{{Video|name=Animation_apply_GPKG_layer_namesAnimation_apply_GPKG_layer_names_a.mp4|width=1000}}<br>

Note: If the layers are opened from within the QGIS Browser Panel, they will automatically be named the same as within the GeoPackageGPKG database.<br>