Difference between revisions of "Kart Git And TUFLOW"

From Tuflow
Jump to navigation Jump to search
Line 50: Line 50:
 
<pre>
 
<pre>
 
git clone git@gitlab.com:ellis_symons/tutorial-model.git
 
git clone git@gitlab.com:ellis_symons/tutorial-model.git
 +
</pre>
 +
Once created, you should change directory into the newly cloned project directory:
 +
<pre>
 +
cd tutorial-model
 +
</pre>
 +
====3. Adding Files====
 +
Once the repository is cloned, you can then add files. These can be existing files or files you start creating as part of a new model build. As an example, one of the first files that can be added is a <tt>.gitignore</tt> file. The example below is a template that can be copied when needed. To create this file, simply create a new text document and rename it to ".gitignore" and save it inside the cloned project folder (next to the ".git" folder).
 +
<pre>
 +
check*
 +
results*
 +
model/gis*
 +
model/grid*
 +
model/tin*
 +
model/xf*
 +
runs/log*
 +
runs/_ TUFLOW Simulations.log
 +
bc_dbase/xf*
 +
*.qgz
 +
</pre>
 +
Once created, the .gitignore file can be added via git bash, Git GUI, or any other software that has version control integration (e.g. Visual Studio Code).
 +
<pre>
 +
git add .gitignore
 
</pre>
 
</pre>
  
 
==Setting up Kart Repository==
 
==Setting up Kart Repository==
 
==Cloning an Existing Repository==
 
==Cloning an Existing Repository==

Revision as of 22:08, 25 April 2023

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.
  • The examples on the 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 below have used SSH authentication with either Gitlab or Github. SSH authentication appears to be work better with Kart.

Software and Installation

The following software is required:

  • Git git-scm.com/downloads - There is a portable version Git for Windows, therefore it doesn't necessarily require admin privileges to install. There are a lot of user installation options, you should be able to simply use the default options throughout.
  • Kart kartproject.org/ - 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:

  • QGIS with the Kart plugin (and the TUFLOW plugin for importing empty files)

Setting Up Git Bash

Git Bash is installed with Git and is similar to Windows command prompt but uses bash (linux version of command prompt). When using Git bash and Kart together you will need to use kart.exe instead of simply kart e.g.

kart.exe commit -m "commit message"

Using kart with Windows command prompt will accept simply kart and all the Kart documenation suggests just using kart, but just be aware that ".exe" will be required if using Git Bash.

Git Bash can be opened up from the start menu. The examples on this page all use the SSH authentication method as this approach appears to currently work better with Kart. You will need to set this up on the remote repository you are using (e.g. Github or Gitlab). The steps on how to set up an SSH key is linked below, the instructions are for Github, however the process is very similar for Gitlab.


Each time you open a new instance of Git Bash, you will need to add the ssh key again if you do not want to repeatedly have to enter your password. The steps to add the ssh key are described below (taken from the above link) for ease of access.

eval "$(ssh-agent -s)"

and then

ssh-add ~/.ssh/id_ed25519

replacing id_ed25519 with the name of your key. To add have it so it will save it even after a restart, you can add the key to the keychain by adding -k

ssh-add -k ~/.ssh/id_ed25519

Setting up Control File Repository

Since most of the TUFLOW input files (exclduing GIS/GRID inputs and some boundary formats) are plain text files, it is possible to simply use Git to version these files. There are a number of ways to initialise this, the approach shown below is done by intialising the remote repository on Github or Gitlab first and then cloning the repository, then adding files.

1. Create Remote Repository

Create your remote repository (usually using a Blank template), setting the name and whether the repository should be public or private.

2. Clone Repository

In Git Bash, use cd to change directory to where your model is going to sit. Note: Git Bash requires forward slashes /

cd c:/projects

Use git clone to clone your newly create repository. Note: make sure to use the SSH clone link if required (will start with "git@" rather than "https"). Tip: pasting is done by Ctrl+Shift+Insert (not Ctrl+V).

git clone git@gitlab.com:ellis_symons/tutorial-model.git

Once created, you should change directory into the newly cloned project directory:

cd tutorial-model

3. Adding Files

Once the repository is cloned, you can then add files. These can be existing files or files you start creating as part of a new model build. As an example, one of the first files that can be added is a .gitignore file. The example below is a template that can be copied when needed. To create this file, simply create a new text document and rename it to ".gitignore" and save it inside the cloned project folder (next to the ".git" folder).

check*
results*
model/gis*
model/grid*
model/tin*
model/xf*
runs/log*
runs/_ TUFLOW Simulations.log
bc_dbase/xf*
*.qgz

Once created, the .gitignore file can be added via git bash, Git GUI, or any other software that has version control integration (e.g. Visual Studio Code).

git add .gitignore

Setting up Kart Repository

Cloning an Existing Repository