Onboarding

This short guide will show you how to get started from scratch. To follow along, we require that you have a ship with data (sensors and/or noon reports) and an API key available.

The process consists of:

  1. Authorizing
  2. Adding a ship
  3. Uploading the data
  4. Using the model

In case you only have access to our Demo environment, step 2 and 3 can be skipped and you can get started with our pre-trained model immediately.

1. Authorize

Firstly, make sure you have an API key.

All requests require an API key to be present in the X-API-Key header. For example if your API key is tqk_jiS5d4JrW8Rfw5CfxrbJJnzOM9hI12md3v then the following header must be passed along with every request.

headers = {
  "X-API-Key": "tqk_jiS5d4JrW8Rfw5CfxrbJJnzOM9hI12md3v"
}

2. Add a ship

Add the ship you want to model to the system through the Add Ship endpoint.

Only name and IMO number are strictly required. MCR and Max RPM are required in order to limit the model to the operational range of the vessel.

3. Upload the data

Once the ship is added, you're all set to upload data for that ship.

We support four types of datasets, each with their own endpoint: Sensor data, Noon reports, Event data, Weather data. Try to include as many columns as you have available, as that will speed up the modelling process and increase the quality of the models.

For detailed information on the minimal requirements, see Data Requirements.

4. Use the model

After we've received the data, we will start the modelling process on our end. Depending on the ship type and quality of the data this may take between 6 hours and a few days. We will notify through e-mail when the model is online.

To use the model, have a look at our Use Cases in which we provide a step-by-step code guides that demonstrate some practical uses of the model.