Kart Git And TUFLOW - Revision history

Tuflowduncan: /* Software and Installation */

2025-06-26T09:12:17Z

Software and Installation

← Older revision		Revision as of 19:12, 26 June 2025
Line 12:		Line 12:
	* Kart <b><u>[https://kartproject.org/ kartproject.org/]</u></b> - Kart will require admin privileges to install. Kart is packaged with it's own Git version, however this will not contain git bash so the above installation will be required.		* Kart <b><u>[https://kartproject.org/ kartproject.org/]</u></b> - Kart will require admin privileges to install. Kart is packaged with it's own Git version, however this will not contain git bash so the above installation will be required.
	Recommended software:		Recommended software:
	* QGIS with the Kart plugin (and the TUFLOW plugin for importing empty files)		* QGIS with the Kart plugin (and the TUFLOW plugin for importing empty files). The page [[TUFLOW Setup with Kart QGIS Plugin\|here]] describes how to set up a TUFLOW project with Kart and some of the benefits.

	==Setting Up Git Bash==		==Setting Up Git Bash==
Line 130:		Line 130:
	====2. Clone GIS File Repository====		====2. Clone GIS File Repository====
	Once the main project has been cloned, change directory into the model folder (where the "gis" folder will sit)		Once the main project has been cloned, change directory into the model folder (where the "gis" folder will sit)

	</pre>
	cd tutorial-model/model		cd tutorial-model/model

	</pre>
	Clone the kart repository assigning it the desired GPKG name (in this case the gpkg will be called "gis_database.gpkg"):		Clone the kart repository assigning it the desired GPKG name (in this case the gpkg will be called "gis_database.gpkg"):
	<pre>		<pre>

ElizaCollison: /* Notes */

2024-10-04T08:54:46Z

Notes

← Older revision		Revision as of 18:54, 4 October 2024
Line 3:		Line 3:
	==Notes==		==Notes==
	* This wiki page was written with Kart v0.12.2 which is still considered a pre-release version. Kart is in rapid development and some of the constraints and/or methods may no longer be valid or have changed in subsequent versions.		* This wiki page was written with Kart v0.12.2 which is still considered a pre-release version. Kart is in rapid development and some of the constraints and/or methods may no longer be valid or have changed in subsequent versions.
	* The examples on this page use git bash (on Windows) which is installed with Git. A lot of the methodology can also be done ~~throught~~ Windows command prompt with the same syntax however on this version of Kart, for private remote repositories, Kart will not prompt for any authentication while using command prompt and will simply fail to push/pull. Git bash will prompt for authentication and is also easier to add and save ssh keys so is a lot better to use in these contexts. For consistency, it will be adopted for all examples over command prompt.		* The examples on this page use git bash (on Windows) which is installed with Git. A lot of the methodology can also be done through Windows command prompt with the same syntax however on this version of Kart, for private remote repositories, Kart will not prompt for any authentication while using command prompt and will simply fail to push/pull. Git bash will prompt for authentication and is also easier to add and save ssh keys so is a lot better to use in these contexts. For consistency, it will be adopted for all examples over command prompt.
	* The examples below have used SSH authentication with either Gitlab or Github. SSH authentication appears to be work better with Kart.		* The examples below have used SSH authentication with either Gitlab or Github. SSH authentication appears to be work better with Kart.
	* It's a good idea to ensure you have hidden folders visible. Both Git and Kart use hidden folders to store information and it's nice being able to see them and access them if needed.		* It's a good idea to ensure you have hidden folders visible. Both Git and Kart use hidden folders to store information and it's nice being able to see them and access them if needed.

Ellis Symons: /* Workflow */

2023-04-25T15:02:08Z

Workflow

← Older revision		Revision as of 01:02, 26 April 2023
Line 145:		Line 145:
	Once setup, the specific workflow will be dependent on how many many modellers will be working on the project concurrently and the specific goals of the project (e.g. are there going to be a lot of mitigation scenarios etc). The use of branches may be a robust approach in complex situations with a lot of mitigation options, or even a separate repository and GPKG for mitigation options.<Br>		Once setup, the specific workflow will be dependent on how many many modellers will be working on the project concurrently and the specific goals of the project (e.g. are there going to be a lot of mitigation scenarios etc). The use of branches may be a robust approach in complex situations with a lot of mitigation options, or even a separate repository and GPKG for mitigation options.<Br>
	<Br>		<Br>
	For the workflow, the easiest approach is to use something like Visual Studio Code for TUFLOW control file editing as this has a version control manager which will make the stage/commit/push/pull a lot easier and skips the need to be using the CLI. For kart, using the kart plugin in QGIS is the easiest method for skipping the need to use the CLI, however for ~~push~~/~~pull~~ it may be necessary to use Git Bash to setup the SSH authentication. The TUFLOW plugin 'import empty' tool has an option to import directly into a kart repository, skipping the need to double handle the creation of TUFLOW GIS input files.		For the workflow, the easiest approach is to use something like Visual Studio Code for TUFLOW control file editing as this has a version control manager which will make the stage/commit/push/pull a lot easier and skips the need to be using the CLI. For kart, using the kart plugin in QGIS is the easiest method for skipping the need to use the CLI, however for pushing/pulling it may be necessary to use Git Bash to setup the SSH authentication. The TUFLOW plugin 'import empty' tool has an option to import directly into a kart repository, skipping the need to double handle the creation of TUFLOW GIS input files.

Ellis Symons at 15:01, 25 April 2023

2023-04-25T15:01:07Z

← Older revision		Revision as of 01:01, 26 April 2023
Line 141:		Line 141:
	====Summary====		====Summary====
	The steps above will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change meaning they don't typically have to be versioned. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.		The steps above will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change meaning they don't typically have to be versioned. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.

			==Workflow==
			Once setup, the specific workflow will be dependent on how many many modellers will be working on the project concurrently and the specific goals of the project (e.g. are there going to be a lot of mitigation scenarios etc). The use of branches may be a robust approach in complex situations with a lot of mitigation options, or even a separate repository and GPKG for mitigation options.<Br>
			<Br>
			For the workflow, the easiest approach is to use something like Visual Studio Code for TUFLOW control file editing as this has a version control manager which will make the stage/commit/push/pull a lot easier and skips the need to be using the CLI. For kart, using the kart plugin in QGIS is the easiest method for skipping the need to use the CLI, however for push/pull it may be necessary to use Git Bash to setup the SSH authentication. The TUFLOW plugin 'import empty' tool has an option to import directly into a kart repository, skipping the need to double handle the creation of TUFLOW GIS input files.

Ellis Symons: /* Summary */

2023-04-25T14:52:11Z

Summary

← Older revision		Revision as of 00:52, 26 April 2023
Line 140:		Line 140:

	====Summary====		====Summary====
	The steps above will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change ~~means~~ they don't have to be versioned ~~typically~~. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.		The steps above will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change meaning they don't typically have to be versioned. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.

Ellis Symons: /* Cloning an Existing Repository */

2023-04-25T14:51:41Z

Cloning an Existing Repository

← Older revision		Revision as of 00:51, 26 April 2023
Line 139:		Line 139:
	Rename the "gis_database" folder to "gis" to match TUFLOW folder naming convention.		Rename the "gis_database" folder to "gis" to match TUFLOW folder naming convention.

			====Summary====
	~~This~~ will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change means they don't have to be versioned typically. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.		The steps above will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change means they don't have to be versioned typically. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.

Ellis Symons: /* Cloning an Existing Repository */

2023-04-25T14:50:06Z

Cloning an Existing Repository

← Older revision		Revision as of 00:50, 26 April 2023
Line 119:		Line 119:
	==Cloning an Existing Repository==		==Cloning an Existing Repository==
	Once your model repository is setup it is desirable to be able to clone the repository so that others can work on it. The steps below outline how this can be done, it is assumed that Git Bash has been setup and configured with an SSH key and that the user has been given access to push/pull to the remote:		Once your model repository is setup it is desirable to be able to clone the repository so that others can work on it. The steps below outline how this can be done, it is assumed that Git Bash has been setup and configured with an SSH key and that the user has been given access to push/pull to the remote:
			====1. Clone Control File Repository====
			In Git Bash, change directory to where the TUFLOW model will sit (Note: bash will require forward slashes in file paths <tt>/</tt>):
			<pre>
			cd c:/projects
			</pre>
			Use <tt>git clone</tt> to clone the repo (Note: make sure to use the SSH repository address):
			<pre>
			git clone git@gitlab.com:ellis_symons/tutorial-model.git
			</pre>
			====2. Clone GIS File Repository====
			Once the main project has been cloned, change directory into the model folder (where the "gis" folder will sit)
			</pre>
			cd tutorial-model/model
			</pre>
			Clone the kart repository assigning it the desired GPKG name (in this case the gpkg will be called "gis_database.gpkg"):
			<pre>
			kart.exe clone git@gitlab.com:ellis_symons/tutorial-model-gis.git gis_database
			</pre>
			Rename the "gis_database" folder to "gis" to match TUFLOW folder naming convention.

			This will copy all the input text control files (and boundary files) as well as the gis layers. The grid inputs have been excluded thus far from being versioned, this is due to their size (usually very big) and the fact that they don't often change means they don't have to be versioned typically. So at this point in the process any grid files will have to be copied from where they are being stored into the correct directory location.

Ellis Symons: /* Setting Up Git Bash */

2023-04-25T14:16:02Z

Setting Up Git Bash

← Older revision		Revision as of 00:16, 26 April 2023
Line 32:		Line 32:
	<pre>		<pre>
	ssh-add ~/.ssh/id_ed25519		ssh-add ~/.ssh/id_ed25519
			</pre>

	==Setting up Control File Repository==		==Setting up Control File Repository==

Ellis Symons: /* Setting Up Git Bash */

2023-04-25T14:15:49Z

Setting Up Git Bash

← Older revision		Revision as of 00:15, 26 April 2023
Line 32:		Line 32:
	<pre>		<pre>
	ssh-add ~/.ssh/id_ed25519		ssh-add ~/.ssh/id_ed25519
	</pre>
	To add have it so it will save it even after a restart, you can add the key to the keychain by adding -k
	<pre>
	ssh-add -k ~/.ssh/id_ed25519
	</pre>

	==Setting up Control File Repository==		==Setting up Control File Repository==

Ellis Symons: /* Cloning an Existing Repository */

2023-04-25T14:15:28Z

Cloning an Existing Repository

← Older revision		Revision as of 00:15, 26 April 2023
Line 122:		Line 122:

	==Cloning an Existing Repository==		==Cloning an Existing Repository==
	Once your model repository is setup it is ~~probably~~ desirable to be able to clone the repository. The steps below outline how this can be done, it is assumed that Git Bash has been setup and configured with an SSH key and that the user has access to the :		Once your model repository is setup it is desirable to be able to clone the repository so that others can work on it. The steps below outline how this can be done, it is assumed that Git Bash has been setup and configured with an SSH key and that the user has been given access to push/pull to the remote: