Basics tutorial
Redirect page
Redirect to:
Prerequisites
The following prerequisites should be met before starting this tutorial:
- Ensure your organisation's domain administrator has created an account for you.
- This tutorial will involve the creation of a new Project.
Introduction to the Tygron Platform
The Tygron Platform is a server-client application specializing in rapid, parallel calculations and processing of data. Organizations have license which allows access to the software, and a Domain which holds all the organization's User accounts and Projects. Each user within an organization that wishes to make use of the software must have an individual User account.
Projects are complete sets of data representing a use-case in a real geographical location. Projects can be started as a Session, which is an interactive representation of Project data. Generally, only one Session can exist per Project.
When a Session is active, it is generally not possible to start a second Session while the first Session is still running. However, it is possible for multiple Users to interact with the same Session at the same time.
This tutorial assumes a user account has been created with at least EDITOR rights.
Getting started as a new user
Download the Tygron Platform client application. It can be found here:
After the download completes, install it the application, and finally start the application.
If the Tygron Platform has not been run recently on this computer, a prompt may appear for the end-user license agreement. If you agree with the terms, accept it. Note that accepting the EULA is required to continue this tutorial and to use the Tygron Platform in general.
At the login screen, click on "forgot password". Enter the email associated with your account, and click on "Reset".
This will prompt an email to be sent to your email account with a new password, which will allow you to log in.
After resetting, the login screen will have reappeared. As username, enter your email. As password, enter the password sent to you in the mail. Then click on "sign in".
If the Tygron Platform has been freshly (re)installed, the application may take a moment to optimize its internal settings, so that it can maximize performance as necessary. This will force the application to close. When this happens, restart the application, and log in again.
In the main menu, click on "options", and then "my account". This screen will allow you to manage your own account and your own Projects.
Click on "Change my password". A prompt will appear with which you can change your password to one you can remember.
Creating a new Project
In the main menu, click on "Create new Project". This will start the New Project Wizard.
Enter a name for the new Project. A Project name should usually indicate the geographical setting where the Project is located. When creating a new Project for the purpose of experimentation, such as a tutorial, it is generally convention to have the project name indicate the person the Project belongs to, e.g. test-yourname.
The name must be between 3 and 20 characters, and may consist of alphanumeric characters, spaces, and dashes.
When creating a new Project, it is possible to either create a new Project from scratch, or to base the new Project on a pre-existing Project. Ensure the option for creating a new project is selected.
Set the Projects language to the desired language, the currency to the desired currency, and the measurement system to "international".
Proceed to the next screen of the wizard.
This screen allows the selection of the geographical location and size of the new Project.
Use the search bar to locate the general area where the Project is to be located.
Move the map using the right-mouse button.
Use the left mouse button to place the blue selection zone in the appropriate location. Everything within the blue extent will be part of the Project and the 3D visualization. Anything outside the blue extent will not be part of the Project and the 3D visualization.
Click on "Advanced Options". This opens an additional panel in which some specific datasources can be toggled or configured. Some datasources can be explicitly includes or excluded from the process of generating the Project.
Disable the "Ownership" options. This will disable the Tygron Platform from generating a complex ownership situation, which might inhibit the free application of tools for sketching a future situation using Actions. Disabling the import of ownership data is a best-practise.
Click on "Generate". This will start the data import process on the Tygron Platform server.
After the generation process completes, the editor environment and 3D visualization will load.
Saving, closing, starting, and permissions
When then editor and the 3D visualization have loaded, it is possible to explore the data present in the project, to effect changes in the data, to add calculation models, and perform all other operations desired.
Before exploring the editor, click on "File" in the top-left corner of the screen. This will open the File menu for the Project.
Click on "Save" to save the Project. The current state of the Project will now be saved.
After the Project has saved, click on versions.
Each Project can have a maximum of 10 versions within it. Versions are used to create known states of a Project, to which it is possible to revert if so desired.
Click on "Add new version". This will save the current state of the Session in a second version. The second version will now be listed, and this new version will also be marked as active. If changes are now made to the Project and the Project is saved, those changed will be stored in the new version. At any point in the future, it will be possible to revert the Project back to the initial "Base Version", which will not include those changes made in the second version.
Click on "details". Thuis will open the overview of general meta-data of the Project, including an overview of the permission which dictate who can access this Project and Session.
Permissions can be set for:
- Owner, which is generally the User whom created the Project
- Other users in Domain, which are all the Users in the same Domain
- Tygron Support, which is any Tygron employees
The rights for any of these can be set to any of the following levels:
- NONE, which means the Project cannot be accessed.
- READ, which means the Project can be opened as a Session. Data can be inspected and modified, but not saved. Saving a copy to create a new Project is allowed.
- WRITE, which means the Project can be saved as well, allowed its data to be permanently changed.
Note that any newly created Project (including one resulting from copying an existing Project), will have all rights except of that of the owner set to NONE. This is in line with Tygron's privacy-by-default policy, requiring explicit granting of access to others.
Also note that because the permissions for Tygron Support are set to NONE by default, Tygron employees cannot access a Project's data without explicit approval.
Close Session closes
Because the Project has been saved before closing it, the Project data will continue to exist on the Tygron Platform server even after the Session has closed.