TUFLOW Setup with Kart QGIS Plugin - Revision history

Tuflowduncan: /* Using Remote Repositories */

2025-07-24T13:55:42Z

Using Remote Repositories

← Older revision		Revision as of 23:55, 24 July 2025
Line 96:		Line 96:


	If using SSH keys the URL for the repository would be: git@gitlab.com: tuflow-user-group/third-party-tools/other/tuflow_tutorial_model_kart.git . Choose a suitable location to save the repository locally.		If using SSH keys the URL for the repository would be: git@gitlab.com: tuflow-user-group/third-party-tools/other/tuflow_tutorial_model_kart.git. Choose a suitable location to save the repository locally.
	[[File:Kart CLone 2.png\|none\|thumb\|400x400px]]		[[File:Kart CLone 2.png\|none\|thumb\|400x400px]]
	The repository will then appear within Kart in the list of repositories and can be interrogated with the above tools. A remote repository can also allow multi-user editing, providing the opportunity for conflicts which can be dealt with. See the [https://docs.kartproject.org/en/latest/ Kart documentation] for more details.		The repository will then appear within Kart in the list of repositories and can be interrogated with the above tools. A remote repository can also allow multi-user editing, providing the opportunity for conflicts which can be dealt with. See the [https://docs.kartproject.org/en/latest/ Kart documentation] for more details.

Tuflowduncan: /* Using Remote Repositories */

2025-07-24T13:55:09Z

Using Remote Repositories

← Older revision		Revision as of 23:55, 24 July 2025
Line 96:		Line 96:


	If using SSH keys the URL for the repository would be: ~~[[Mailto:~~git@gitlab.com~~\|git@gitlab.com]]~~: tuflow-user-group/third-party-tools/other/tuflow_tutorial_model_kart.git . Choose a suitable location to save the repository locally.		If using SSH keys the URL for the repository would be: git@gitlab.com: tuflow-user-group/third-party-tools/other/tuflow_tutorial_model_kart.git . Choose a suitable location to save the repository locally.
	[[File:Kart CLone 2.png\|none\|thumb\|400x400px]]		[[File:Kart CLone 2.png\|none\|thumb\|400x400px]]
	The repository will then appear within Kart in the list of repositories and can be interrogated with the above tools. A remote repository can also allow multi-user editing, providing the opportunity for conflicts which can be dealt with. See the [https://docs.kartproject.org/en/latest/ Kart documentation] for more details.		The repository will then appear within Kart in the list of repositories and can be interrogated with the above tools. A remote repository can also allow multi-user editing, providing the opportunity for conflicts which can be dealt with. See the [https://docs.kartproject.org/en/latest/ Kart documentation] for more details.

Tuflowduncan: /* Using Remote Repositories */

2025-07-24T09:43:27Z

Using Remote Repositories

@@ Line 78: / Line 78: @@
 == Using Remote Repositories ==
-The above steps are for a local Kart repository.  However, it is possible to use Kart with remote repositories.  This is done by cloning a remote repository on Gitlab/Github or similar.  Once a repository is cloned, changes can be push/pulled to and from the remote repository.
+The above steps are for a local Kart repository.  However, it is possible to use Kart with remote repositories.  This allows access from multiple machines as well as multiple users.
 {{Tips Navigation

Tuflowduncan at 07:15, 27 June 2025

2025-06-27T07:15:20Z

← Older revision		Revision as of 17:15, 27 June 2025
Line 10:		Line 10:
	All of these are useful from a quality assurance perspective, allowing a history of the development of a TUFLOW model geometry files to be understood and analysed. Kart is very easy to use once it is set up. The set up of Kart to be used with TUFLOW is a little cumbersome but the steps below provide information of how to set up the Kart QGIS Plugin, set up the TUFLOW folders and initialise the Kart repository.		All of these are useful from a quality assurance perspective, allowing a history of the development of a TUFLOW model geometry files to be understood and analysed. Kart is very easy to use once it is set up. The set up of Kart to be used with TUFLOW is a little cumbersome but the steps below provide information of how to set up the Kart QGIS Plugin, set up the TUFLOW folders and initialise the Kart repository.

	== ~~Install~~ the Kart Plugin ==		== Installing the Kart Plugin ==
	The first step is to install the Kart QGIS plugin. This is done using the '''Manage and Install Plugins''' tool within QGIS. Search for Kart and install the plugin.		The first step is to install the Kart QGIS plugin. This is done using the '''Manage and Install Plugins''' tool within QGIS. Search for Kart and install the plugin.

Line 19:		Line 19:
	[[File:Kart Repository.png\|thumb\|Initial Kart Repository\|alt=\|none\|465x465px]]		[[File:Kart Repository.png\|thumb\|Initial Kart Repository\|alt=\|none\|465x465px]]

	== ~~Set~~ up the TUFLOW Model and Initialise Kart Repository ==		== Setting up the TUFLOW Model and Initialise Kart Repository ==
	With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. We will start at the beginning of a TUFLOW model build but it would be possible to set up kart with an existing model with a similar workflow. However, in this instance, commits and changes would only be tracked for edits to the geometry data after the TUFLOW model is initialised within a Kart folder.		With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. We will start at the beginning of a TUFLOW model build but it would be possible to set up kart with an existing model with a similar workflow. However, in this instance, commits and changes would only be tracked for edits to the geometry data after the TUFLOW model is initialised within a Kart folder.

Tuflowduncan: /* Set up the TUFLOW Model and Initialise Kart Repository */

2025-06-26T14:53:49Z

Set up the TUFLOW Model and Initialise Kart Repository

← Older revision		Revision as of 00:53, 27 June 2025
Line 25:		Line 25:

	With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. This is because a Kart repository can only be set up for an empty folder but our GIS folder has an empty folder and a geopackage in it already. We also want to initialise Kart using the TUFLOW model name rather than have a geopackage called gis, which is based on the GIS folder. The below steps are one way to get address these and provide a neat GIS folder, with a geopackage name that matches the model, which is initialised as a Kart repository.		With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. This is because a Kart repository can only be set up for an empty folder but our GIS folder has an empty folder and a geopackage in it already. We also want to initialise Kart using the TUFLOW model name rather than have a geopackage called gis, which is based on the GIS folder. The below steps are one way to get address these and provide a neat GIS folder, with a geopackage name that matches the model, which is initialised as a Kart repository.
	[[File:GIS Folder.png\|none\|thumb\|~~300x300px~~\|The Desired TUFLOW GIS Folder Initialised as a Kart Repository]]		[[File:GIS Folder.png\|none\|thumb\|390x390px\|The Desired TUFLOW GIS Folder Initialised as a Kart Repository\|alt=]]


Line 31:		Line 31:

	* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.		* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.
	* Rename the '~~<nowiki/>~~'''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.		* Rename the ''''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.

	* Use the Kart Create new repository tool to create a new Kart repository.		* Use the Kart Create new repository tool to create a new Kart repository.

Tuflowduncan: /* Set up the TUFLOW Model and Initialise Kart Repository */

2025-06-26T14:49:32Z

Set up the TUFLOW Model and Initialise Kart Repository

← Older revision		Revision as of 00:49, 27 June 2025
Line 24:		Line 24:
	Firstly, we'll set up our TUFLOW folder structure and template files. To set up your TUFLOW folders, you can use your chosen method of either the [[QGIS TUFLOW Create Project\|TUFLOW Create Project]] tool or the [[Create TUFLOW Project]] tool.		Firstly, we'll set up our TUFLOW folder structure and template files. To set up your TUFLOW folders, you can use your chosen method of either the [[QGIS TUFLOW Create Project\|TUFLOW Create Project]] tool or the [[Create TUFLOW Project]] tool.

	With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. Kart ~~probably~~ ~~works~~ ~~best~~ ~~with~~ a ~~single~~ ~~Geopackage~~ ~~for~~ ~~the~~ ~~whole~~ TUFLOW model, ~~although~~ it ~~would~~ be ~~possible~~ to ~~use~~ ~~with~~ ~~seperate~~ ~~Geopackages~~. The ~~steps~~ below are ~~for~~ a ~~single~~ ~~Geopackage~~.		With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. This is because a Kart repository can only be set up for an empty folder but our GIS folder has an empty folder and a geopackage in it already. We also want to initialise Kart using the TUFLOW model name rather than have a geopackage called gis, which is based on the GIS folder. The below steps are one way to get address these and provide a neat GIS folder, with a geopackage name that matches the model, which is initialised as a Kart repository.
			[[File:GIS Folder.png\|none\|thumb\|300x300px\|The Desired TUFLOW GIS Folder Initialised as a Kart Repository]]


			Kart probably works best with a single Geopackage for the whole TUFLOW model, although it would be possible to use with seperate Geopackages. The steps below are for a single Geopackage.

	* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.		* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.
	* Rename the ''''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.		* Rename the '<nowiki/>'''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.

	* Use the Kart Create new repository tool to create a new Kart repository.		* Use the Kart Create new repository tool to create a new Kart repository.

Tuflowduncan: /* Benefits of using Kart */

2025-06-26T14:43:38Z

Benefits of using Kart

Tuflowduncan: /* Using Remote Repositories */

2025-06-26T14:34:16Z

Using Remote Repositories

Ellis Symons: /* Set up the TUFLOW Model and Initialise Kart Repository */

2025-06-26T14:25:50Z

Set up the TUFLOW Model and Initialise Kart Repository

← Older revision		Revision as of 00:25, 27 June 2025
Line 20:		Line 20:

	== Set up the TUFLOW Model and Initialise Kart Repository ==		== Set up the TUFLOW Model and Initialise Kart Repository ==
	With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. We will start at the beginning of a TUFLOW model build but it would be possible to set up kart with an existing model with a similar workflow. ~~Howver~~, in this instance, commits and changes would only be tracked for edits to the geometry data after the TUFLOW model is initialised within a Kart folder.		With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. We will start at the beginning of a TUFLOW model build but it would be possible to set up kart with an existing model with a similar workflow. However, in this instance, commits and changes would only be tracked for edits to the geometry data after the TUFLOW model is initialised within a Kart folder.

	Firstly, we'll set up our TUFLOW folder structure and template files. To set up your TUFLOW folders, you can use your chosen method of either the [[QGIS TUFLOW Create Project\|TUFLOW Create Project]] tool or the [[Create TUFLOW Project]] tool.		Firstly, we'll set up our TUFLOW folder structure and template files. To set up your TUFLOW folders, you can use your chosen method of either the [[QGIS TUFLOW Create Project\|TUFLOW Create Project]] tool or the [[Create TUFLOW Project]] tool.

Tuflowduncan at 14:19, 26 June 2025

2025-06-26T14:19:57Z

← Older revision		Revision as of 00:43, 27 June 2025
Line 14:		Line 14:

	[[File:Kart QGIS Plugin.png\|thumb\|600x600px\|Kart QGIS Plugin\|alt=\|none]]The plugin requires that you install Kart from https://kartproject.org/		[[File:Kart QGIS Plugin.png\|thumb\|600x600px\|Kart QGIS Plugin\|alt=\|none]]The plugin requires that you install Kart from https://kartproject.org/
	Once the plugin and Kart is installed, there is a Kart menu within QGIS with some settings. Specify the path to the installed Kart executable. There's an option to Auto Commit which will commit your changes to the repository when you 'Toggle editing' off within QGIS. This can be a useful option, although the drawback is that you are not prompted to add a commit message.[[File:Kart Settings.png\|thumb\|Kart Settings\|alt=\|none]]		Once the plugin and Kart is installed, there is a Kart menu within QGIS with some settings. Specify the path to the installed Kart executable. There's an option to Auto Commit which will commit your changes to the repository when you 'Toggle editing' off within QGIS. This can be a useful option, although the drawback is that you are not prompted to add a commit message.[[File:Kart Settings.png\|thumb\|Kart Settings\|alt=\|none\|465x465px]]

	The Kart Repositories panel should show something similar to the following, with no repositories showing.		The Kart Repositories panel should show something similar to the following, with no repositories showing.
	[[File:Kart Repository.png\|thumb\|Initial Kart Repository\|alt=\|none]]		[[File:Kart Repository.png\|thumb\|Initial Kart Repository\|alt=\|none\|465x465px]]

	== Set up the TUFLOW Model and Initialise Kart Repository ==		== Set up the TUFLOW Model and Initialise Kart Repository ==
Line 31:		Line 31:
	* Use the Kart Create new repository tool to create a new Kart repository.		* Use the Kart Create new repository tool to create a new Kart repository.

	[[File:Create Kart Repository.png\|thumb\|Create Kart Repository\|alt=\|none]]		[[File:Create Kart Repository.png\|thumb\|Create Kart Repository\|alt=\|none\|400x400px]]

	* Select the '''TUFLOW\Model\Model_Name''' folder and ensure 'Geopackage in repository folder' is selected in the Storage type option. Click OK.		* Select the '''TUFLOW\Model\Model_Name''' folder and ensure 'Geopackage in repository folder' is selected in the Storage type option. Click OK.

	[[File:Kart Repository Setup.png\|alt=Kart Repository Setup\|thumb\|none]]		[[File:Kart Repository Setup.png\|alt=Kart Repository Setup\|thumb\|none\|400x400px]]
	* Cut and paste the ''''empty'''<nowiki/>' folder from '''TUFLOW\Model''' to the '''TUFLOW\Model\Model_Name''' folder.		* Cut and paste the ''''empty'''<nowiki/>' folder from '''TUFLOW\Model''' to the '''TUFLOW\Model\Model_Name''' folder.
	* Rename the ''''Model_Name'''<nowiki/>' folder to ''''GIS'''<nowiki/>'		* Rename the ''''Model_Name'''<nowiki/>' folder to ''''GIS'''<nowiki/>'
Line 41:		Line 41:
	* We will now remap the <nowiki/>repository to th<nowiki/>e '''GIS''' folder. In the Kart repositories panel, highlight the current repositiry and choose to 'remove this repository'. Click Yes when the prompt dialogue comes up.		* We will now remap the <nowiki/>repository to th<nowiki/>e '''GIS''' folder. In the Kart repositories panel, highlight the current repositiry and choose to 'remove this repository'. Click Yes when the prompt dialogue comes up.

	[[File:Remove Repository.png\|thumb\|Remove Repository\|alt=\|none]]		[[File:Remove Repository.png\|thumb\|Remove Repository\|alt=\|none\|400x400px]]

	* We now need to add the renamed folder as an existing repository. Right click on the repositories option and select 'Add existing repository'. Navigate to the '''TUFLOW\Model\GIS''' folder and choose select folder.		* We now need to add the renamed folder as an existing repository. Right click on the repositories option and select 'Add existing repository'. Navigate to the '''TUFLOW\Model\GIS''' folder and choose select folder.

	[[File:Add Existing Respository.png\|thumb\|Add Existing Repository\|alt=\|none]]		[[File:Add Existing Respository.png\|thumb\|Add Existing Repository\|alt=\|none\|400x400px]]

	* We can now import the '''Model_Name.gpkg''' into the repository. This is done by right clicking on the repository and selecting 'Import dataset from file'. Navigate to the '''TUFLOW\Model\Model_Name.gpkg''' and select open.		* We can now import the '''Model_Name.gpkg''' into the repository. This is done by right clicking on the repository and selecting 'Import dataset from file'. Navigate to the '''TUFLOW\Model\Model_Name.gpkg''' and select open.

	[[File:Import dataset from File.png\|thumb\|Import Dataset from File\|alt=\|none]]		[[File:Import dataset from File.png\|thumb\|Import Dataset from File\|alt=\|none\|400x400px]]
	* The repository will now show the Geopackage layers, which at present is only the projection layer generate during the create TUFLOW project step.		* The repository will now show the Geopackage layers, which at present is only the projection layer generate during the create TUFLOW project step.

	[[File:Repository.png\|thumb\|Repository after Importing the Geopackage Dataset\|alt=\|none]]		[[File:Repository.png\|thumb\|Repository after Importing the Geopackage Dataset\|alt=\|none\|400x400px]]

	* Finally, the Model_Name.gpkg can be deleted from the '''TUFLOW\Model''' folder.		* Finally, the Model_Name.gpkg can be deleted from the '''TUFLOW\Model''' folder.
Line 60:		Line 60:
	== TUFLOW Model Build ==		== TUFLOW Model Build ==
	We can now start to build our TUFLOW model using the traditional steps of the [[QGIS TUFLOW Import Empty\|Import Empty File]] tool within the QGIS TUFLOW Plugin. When importing the empty files, we can import to the gpkg in Kart repository using the options in the following image, ensuring to select the 'All to one' option and choosing to 'Import into Kart repo folder'.		We can now start to build our TUFLOW model using the traditional steps of the [[QGIS TUFLOW Import Empty\|Import Empty File]] tool within the QGIS TUFLOW Plugin. When importing the empty files, we can import to the gpkg in Kart repository using the options in the following image, ensuring to select the 'All to one' option and choosing to 'Import into Kart repo folder'.
	[[File:Import Empty File.png\|thumb\|Import Empty File\|alt=\|none]]		[[File:Import Empty File.png\|thumb\|Import Empty File\|alt=\|none\|452x452px]]

	Once the empty file is imported, you can refresh the Kart Repository, and see the additional layers with there.		Once the empty file is imported, you can refresh the Kart Repository, and see the additional layers with there.
	[[File:Kart Repository 2.png\|thumb\|Kart Respository Showing the Imported Empty File\|alt=\|none]]		[[File:Kart Repository 2.png\|thumb\|Kart Respository Showing the Imported Empty File\|alt=\|none\|400x400px]]

	We can now build the TUFLOW model geometry as we would do usually. As we add additional layers to the geodatabase, they will start to appear in the Kart repositories panel.		We can now build the TUFLOW model geometry as we would do usually. As we add additional layers to the geodatabase, they will start to appear in the Kart repositories panel.
Line 75:		Line 75:
	== Using Remote Repositories ==		== Using Remote Repositories ==
	The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.		The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.
	[[File:Remote repository.png\|none\|Kart Push/Pull Functions to Remote Repository\|alt=\|thumb\|~~300x300px~~]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository so cannot suggest that it is a recommended approach.		[[File:Remote repository.png\|none\|Kart Push/Pull Functions to Remote Repository\|alt=\|thumb\|400x400px]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository so cannot suggest that it is a recommended approach.

	{{Tips Navigation		{{Tips Navigation

← Older revision		Revision as of 00:34, 27 June 2025
Line 27:		Line 27:

	* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.		* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.
	* Rename the '~~<nowiki/>~~'''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.		* Rename the ''''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.

	* Use the Kart Create new repository tool to create a new Kart repository.		* Use the Kart Create new repository tool to create a new Kart repository.
Line 68:		Line 68:

	If the option to 'Commit automatically after closing editing' then the changes will be automatically committed. This is useful to avoid forgetting to commit, similar to how an autosave can be beneficial. Alternatively, it is possible to commit manually, either by clicking the repository or the individual layers and using the 'Commit working copy changes' or 'Commit working copy changes for this dataset' option respectively. The benefit of the latter approach is that there are less frequent commits and the user is prompted for a commit message prior to committing the working changes.		If the option to 'Commit automatically after closing editing' then the changes will be automatically committed. This is useful to avoid forgetting to commit, similar to how an autosave can be beneficial. Alternatively, it is possible to commit manually, either by clicking the repository or the individual layers and using the 'Commit working copy changes' or 'Commit working copy changes for this dataset' option respectively. The benefit of the latter approach is that there are less frequent commits and the user is prompted for a commit message prior to committing the working changes.
	[[File:Commit message.png\|none~~\|frame~~\|Manual commit with prompt for commit message]]		[[File:Commit message.png\|none\|Manual commit with prompt for commit message\|alt=\|thumb\|292x292px]]
	If you select the Kart repository or an individual layer dataset then you can choose to 'Show log' which provides a table of the commit history.		If you select the Kart repository or an individual layer dataset then you can choose to 'Show log' which provides a table of the commit history.
	[[File:Commit History.png\|none\|frame\|Kart Layer Dataset Commit History]]		[[File:Commit History.png\|none\|frame\|Kart Layer Dataset Commit History]]
Line 75:		Line 75:
	== Using Remote Repositories ==		== Using Remote Repositories ==
	The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.		The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.
	[[File:Remote repository.png\|none~~\|frame~~\|Kart Push/Pull Functions to Remote Repository]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository so cannot suggest that it is a recommended approach.		[[File:Remote repository.png\|none\|Kart Push/Pull Functions to Remote Repository\|alt=\|thumb\|300x300px]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository so cannot suggest that it is a recommended approach.

	{{Tips Navigation		{{Tips Navigation

← Older revision		Revision as of 00:19, 27 June 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	Kart is a version control tool which stores geospatial data (and tabular data) in Git, providing a neat version control system whilst building TUFLOW models. Despite using Git, there is no requirement for the user to have a thorough understanding of Git, it's processes and commands. The Kart QGIS plugin provides user interface for Kart which provides ~~some~~ tools for reviewing changes to ~~the~~ geospatial data. This page describes a workflow for setting up a TUFLOW project, utilising Kart, and provides some of the benefits of using the Kart tools for version control. Kart can be used with remote repositories to allow multiple users to access the data and work simultaneously with merge control, however, the example below is a local repository for the purposes of version control and ease of quality assurance checking.		Kart is a version control tool which stores geospatial data (and tabular data) in Git, providing a neat version control system whilst building TUFLOW models. Despite using Git, there is no requirement for the user to have a thorough understanding of Git, it's processes and commands. The Kart QGIS plugin provides a user interface for Kart which provides tools for reviewing changes to geospatial data as it is iteratively edited. This page describes a workflow for setting up a TUFLOW project, utilising Kart, and provides some of the benefits of using the Kart tools for version control. Kart can be used with remote repositories to allow multiple users to access the data and work simultaneously with merge control, however, the example below is a local repository for the purposes of version control and ease of quality assurance checking.

	== Benefits of using Kart ==		== Benefits of using Kart ==
	The video below shows an initial model build with some a number of TUFLOW model layers and where the layer geometry has undergone a number of iterative changes. The video shows:		The video below shows an initial model build with some a number of TUFLOW model layers and where the layer geometry has undergone a number of iterative changes. The video shows:
	* The commit history table.		* The Kart commit history table.
	* Tags for specific commits. For instance for models that have undergone QA, been sent to a client or sent to [mailto:support@tuflow.com support@tuflow.com].		* Tags for specific commits. For instance for models that have undergone QA, been sent to a client or sent to [mailto:support@tuflow.com support@tuflow.com].
	* The evaluation in differences between commit versions both in text form and in geometry form.		* The evaluation in differences between commit versions both in text form and in geometry form.
	{{Video\|name=Kart Tools History.mp4\|width=1123}}		{{Video\|name=Kart Tools History.mp4\|width=1123}}
			All of these are useful from a quality assurance perspective, allowing a history of the development of a TUFLOW model geometry files to be understood and analysed. Kart is very easy to use once it is set up. The set up of Kart to be used with TUFLOW is a little cumbersome but the steps below provide information of how to set up the Kart QGIS Plugin, set up the TUFLOW folders and initialise the Kart repository.

	== Install the Kart Plugin ==		== Install the Kart Plugin ==
	The first step is to install the Kart QGIS plugin. This is done using the '''Manage and Install Plugins''' tool within QGIS. Search for Kart and install the plugin.		The first step is to install the Kart QGIS plugin. This is done using the '''Manage and Install Plugins''' tool within QGIS. Search for Kart and install the plugin.
Line 18:		Line 20:

	== Set up the TUFLOW Model and Initialise Kart Repository ==		== Set up the TUFLOW Model and Initialise Kart Repository ==
	With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. To set up ~~your~~ ~~TUFLOW~~ ~~folders,~~ ~~you~~ ~~can~~ ~~use~~ ~~your~~ ~~chosen~~ ~~method~~ of ~~either~~ ~~the~~ ~~[[QGIS~~ ~~TUFLOW~~ ~~Create~~ ~~Project\|TUFLOW~~ ~~Create~~ ~~Project]]~~ ~~tool~~ or the ~~[[Create~~ TUFLOW ~~Project]]~~ ~~tool~~.		With Kart set up, we can now move towards setting up your TUFLOW model. To use Kart, you would need to be using a Geopackage GIS Format. We will start at the beginning of a TUFLOW model build but it would be possible to set up kart with an existing model with a similar workflow. Howver, in this instance, commits and changes would only be tracked for edits to the geometry data after the TUFLOW model is initialised within a Kart folder.

			Firstly, we'll set up our TUFLOW folder structure and template files. To set up your TUFLOW folders, you can use your chosen method of either the [[QGIS TUFLOW Create Project\|TUFLOW Create Project]] tool or the [[Create TUFLOW Project]] tool.

	With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. Kart probably works best with a single Geopackage for the whole TUFLOW model, although it would be possible to use with seperate Geopackages. The steps below are for a single Geopackage.		With the TUFLOW folders set up, there is now some fiddly steps to go through so that we can set up a Kart repository. Kart probably works best with a single Geopackage for the whole TUFLOW model, although it would be possible to use with seperate Geopackages. The steps below are for a single Geopackage.

	* Cut and paste the ~~Empties~~ folder and the Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.		* Cut and paste the '''empty''' folder and the model Geopackage file from the '''TUFLOW\Model\GIS''' folder to TUFLOW\Model. This is because Kart can not initialise a repository if the folder is not empty.
	* Rename the ''''GIS'''<nowiki/>' folder to 'Model_Name' where 'Model_Name' is the same as your Geopackage name.		* Rename the '<nowiki/>'''GIS'''<nowiki/>' folder to ''''Model_Name'''<nowiki/>' where 'Model_Name' is the same as your Geopackage name.

	* Use the Kart Create new repository tool to create a new Kart repository.		* Use the Kart Create new repository tool to create a new Kart repository.
Line 35:		Line 39:
	* Rename the ''''Model_Name'''<nowiki/>' folder to ''''GIS'''<nowiki/>'		* Rename the ''''Model_Name'''<nowiki/>' folder to ''''GIS'''<nowiki/>'

	* In ~~the~~ ~~Kart~~ ~~repositori~~<nowiki/>es ~~panel,~~ ~~highli~~<nowiki/>~~ght~~ the current repositiry and choose to 'remove this repository'. Click Yes when the prompt dialogue comes up.		* We will now remap the <nowiki/>repository to th<nowiki/>e '''GIS''' folder. In the Kart repositories panel, highlight the current repositiry and choose to 'remove this repository'. Click Yes when the prompt dialogue comes up.

	[[File:Remove Repository.png\|thumb\|Remove Repository\|alt=\|none]]		[[File:Remove Repository.png\|thumb\|Remove Repository\|alt=\|none]]

	* We now need to add the renamed folder as an existing repository. Right click on the repositories ~~optoin~~ and select 'Add existing repository'. Navigate to the '''TUFLOW\Model\GIS''' folder and choose select folder.		* We now need to add the renamed folder as an existing repository. Right click on the repositories option and select 'Add existing repository'. Navigate to the '''TUFLOW\Model\GIS''' folder and choose select folder.

	[[File:Add Existing Respository.png\|thumb\|Add Existing Repository\|alt=\|none]]		[[File:Add Existing Respository.png\|thumb\|Add Existing Repository\|alt=\|none]]

	* We ~~need to~~ now import the '''Model_Name.gpkg''' into the repository. This is done by right clicking on the repository and selecting 'Import dataset from file'. Navigate to the '''TUFLOW\Model\Model_Name.gpkg'''.		* We can now import the '''Model_Name.gpkg''' into the repository. This is done by right clicking on the repository and selecting 'Import dataset from file'. Navigate to the '''TUFLOW\Model\Model_Name.gpkg''' and select open.

	[[File:Import dataset from File.png\|thumb\|Import Dataset from File\|alt=\|none]]		[[File:Import dataset from File.png\|thumb\|Import Dataset from File\|alt=\|none]]
	* The repository will now show the Geopackage layers, which at present is the projection layer.		* The repository will now show the Geopackage layers, which at present is only the projection layer generate during the create TUFLOW project step.

	[[File:Repository.png\|thumb\|Repository after Importing the Geopackage Dataset\|alt=\|none]]		[[File:Repository.png\|thumb\|Repository after Importing the Geopackage Dataset\|alt=\|none]]
Line 52:		Line 56:
	* Finally, the Model_Name.gpkg can be deleted from the '''TUFLOW\Model''' folder.		* Finally, the Model_Name.gpkg can be deleted from the '''TUFLOW\Model''' folder.

	The above steps are by far and away the fiddliest steps with the TUFLOW model Kart set up. Now we can start building the TUFLOW model.		The above steps are by far and away the fiddliest steps with the TUFLOW model Kart set up. Now we can start building the TUFLOW model and utilising Kart.

	== TUFLOW Model Build ==		== TUFLOW Model Build ==
Line 61:		Line 65:
	[[File:Kart Repository 2.png\|thumb\|Kart Respository Showing the Imported Empty File\|alt=\|none]]		[[File:Kart Repository 2.png\|thumb\|Kart Respository Showing the Imported Empty File\|alt=\|none]]

	We can now build the TUFLOW model geometry as we would do usually.		We can now build the TUFLOW model geometry as we would do usually. As we add additional layers to the geodatabase, they will start to appear in the Kart repositories panel.

	If the option to 'Commit automatically after closing editing' then the changes will be automatically committed. This is useful to avoid forgetting to commit, similar to how an ~~autosava~~ can be beneficial. Alternatively, it is possible to commit manually, either by clicking the repository or the individual layers and using the 'Commit working copy changes' or 'Commit working copy changes for this dataset'. The benefit of the latter approach is that there are less frequent commits and the user is prompted for a commit message.		If the option to 'Commit automatically after closing editing' then the changes will be automatically committed. This is useful to avoid forgetting to commit, similar to how an autosave can be beneficial. Alternatively, it is possible to commit manually, either by clicking the repository or the individual layers and using the 'Commit working copy changes' or 'Commit working copy changes for this dataset' option respectively. The benefit of the latter approach is that there are less frequent commits and the user is prompted for a commit message prior to committing the working changes.
	[[File:Commit message.png\|none\|frame\|Manual commit with prompt for commit message]]		[[File:Commit message.png\|none\|frame\|Manual commit with prompt for commit message]]
	If you select the Kart repository or an individual layer dataset then you can choose to 'Show log' which provides a table of the commit history.		If you select the Kart repository or an individual layer dataset then you can choose to 'Show log' which provides a table of the commit history.
	[[File:Commit History.png\|none\|frame\|Kart Layer Dataset Commit History]]		[[File:Commit History.png\|none\|frame\|Kart Layer Dataset Commit History]]
	The commit history can then be interrogated to show the details of the commits, the differences between versions, adding tags and other git like tools such as branching, merging, reverting back to older versions as well as replacing working copy changes.It is also possible to apply ~~spatial and~~ temporal filters for changes. For a full list of Kart tools, the user is recommended to consult the Kart documentation [https://docs.kartproject.org/en/latest/ here].		The commit history can then be interrogated to show the details of the commits, the differences between versions, adding tags and other git like tools such as branching, merging, reverting back to older versions as well as replacing working copy changes.It is also possible to apply temporal filters for changes. For a full list of Kart tools, the user is recommended to consult the Kart documentation [https://docs.kartproject.org/en/latest/ here].

	== Using Remote Repositories ==		== Using Remote Repositories ==
	The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.		The above steps are for a local Kart repository. However, it is possible to use Kart with remote repositories. This is done by cloning a remote repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and from the remote repository.
	[[File:Remote repository.png\|none\|frame\|Kart Push/Pull Functions to Remote Repository]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository to ~~recommend~~ it's ~~use~~.		[[File:Remote repository.png\|none\|frame\|Kart Push/Pull Functions to Remote Repository]]It should be noted that the TUFLOW team have not made sufficient use of Kart with remote repository so cannot suggest that it is a recommended approach.

	{{Tips Navigation		{{Tips Navigation