TUFLOW Setup with Kart QGIS Plugin: Difference between revisions

Content deleted Content added
No edit summary
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 isallows doneaccess byfrom cloningmultiple amachines remoteas repository on Gitlab/Github or similar. Once a repository is cloned, changes can be push/pulled to and fromwell theas remotemultiple repositoryusers.
 
[[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.
This can be done by cloning a remote respository on Gitlab/Github or similar or pushing the local repository to Gitlab/Github or similar.
 
To do push a local repository to Gitlab or Github, firstly create the remote repository in Gitlab/Github.  Don’t initialise the project with a readme file as this can cause issues.  Once set up, got to the Kart plugin within QGIS, navigate to the local repository you would like to upload and right click on the repository and choose to ‘push’ changes. 
[[File:Kart Push.png|none|thumb|400x400px]]
Choose to ‘Manage remotes’. Within the resulting dialogue, add the remote name and URL.  It is recommended to use SSH Keys for authentication. When using SSH keys the form of the url would be git@gitlab.com: 'username' 'git repository.git' where username would be your own Gitlab user name and the git repository would be the remote repository ID.
[[File:Kart Manage Remotes.png|none|thumb|400x400px]]
 
 
Choose Add New/Save to save the options.  In the next dialogue, select OK.  If the permissions are set up correctly, the repository should be pushed to the remote repository and a message will pop up within QGIS indicating success.
 
An example of the TUFLOW Tutorial Geopackage dataset from modules 1 and 2, is available from the [https://gitlab.com/tuflow-user-group TUFLOW Gitlab User Group] at following location: https://gitlab.com/tuflow-user-group/third-party-tools/other/tuflow_tutorial_model_kart.
 
This can be cloned using Kart by selecting Clone Repository.
[[File:Kart CLone.png|none|thumb|400x400px]]
 
 
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.
[[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.
 
{{Tips Navigation