Quick start

To get started we are going to load and run a simple model. This example is deliberately much simpler than the models TRAC is designed for but it will help to understand the basics of using the platform.

Load a model

Either on the home page or in the main drop-down menu find ‘Loading tools’ and click ‘Upload a model’.

load model

We will be importing models from GitHub.

Click ‘Authenticate with GitHub’ and you will be prompted to authorise TRAC via the GitHub application.

github auth

Now we need to find a model to upload. You automatically have access to a fintrac-hub/examples repo, so select that then pick ‘main branch’ and ‘latest commit’ from the next two drop-downs.

select repo

Click ‘Select file’ and expand the folder structure.

For this example, select the ‘quick_start’ model and hit ‘Save’.

select model

On the next screen just click ‘Upload model’ at the bottom. You should see a green pop-up telling you that the model upload has started.

import started

Note

You would typically define some attribute tags before completing the upload (Key, Name, Description etc…) but these are being read in from the repository in this example.

Load input data

The model needs an input data set which you can get from the examples repository.

We want the ‘quick_start_input’ file. Click ‘Download raw file’ to get a local copy.

download example data

Now to import it.

Either on the homepage or the main menu, click ‘Upload a data set’ under ‘Loading tools’.

load example data

Locate and select the file you just downloaded, click ‘Get schema’ and then ‘Upload’.

load example data

To complete the upload you need to assign a Key, Name and Description.

The Key must match what the model is expecting, which is ‘quick_start_input’. Name and Description are also required, but for this example it’s less important what you put.

To complete the process click ‘Upload dataset’.

Run the model

Either on the home page or in the main drop-down menu, click ‘Run a model’.

On the next page select the quick start model from the second drop-down, it should be the only option.

select model

For this model you need to provide one numerical parameter (EUR/USD rate) and one data set.

TRAC has automatically selected the data set you just loaded because it’s the only one where Key = quick_start_input.

One you’ve put a value in for the exchange rate, click ‘Review’.

The next page summarises the Job that is about to be run. For more complex models you would want to check this thoroughly but for now just click ‘Run’.

See the result

You’ve executed your first model on TRAC!

From the homepage or main menu click ‘Search’, set the first drop-down to ‘Job’ and refresh the results.

You will see two completed jobs. One with type = ‘Import model’ and one with type = ‘Run model’.

select model

Select the ‘Run model’ job an hit ‘View Job’.

The job summary page contains a full audit record for the job. It details the input data sets, parameter values, model version and outputs.