Geophysics tasks

This is a collection of geophysics functions you can run on the cloud. They read geoscience objects. They write geoscience objects and files.

How do you run a geophysics compute task?

It takes three steps to run a task.

1. Start the task.
2. Wait for it to finish.
3. Get the result.

You can use the Task API for each step.

How do you start a task?

You can start a task by sending a POST request to the Task API.

POST https://{hub}.api.seequent.com/compute/orgs/{org_id}/geophysics/{task}

That URL has three placeholders you need to fill in.

• Replace {hub} with the hub code for the hub you are using.
• Replace {org_id} with the UUID for your organization.
• Replace {task} with the name of the task you want to use.

Send a request body that has a parameter field with your task parameters. The parameters are different for each task.

{
    "parameters": {
        ...
    }
}

How do you know when the task is done?

When you start the task, the Task API will respond with HTTP code 303 and a header called Location. The value inside the Location header is a status endpoint you can use to check the status of your job. You can send GET requests to that endpoint over and over until it says your job is done.

How do you get the results?

When your task is done, the status endpoint response has a result link in the links section. Make a GET request to the result link, and it tells you what geoscience objects and files were created or modified by the task.

{
    "message": "Your task is done!",
    "target": {
        ...
    }
}

Geoscience objects

Geophysics compute tasks read data from one or more geoscience objects and write results to geoscience objects. Since they work with geoscience objects so much, there are special parameter formats that you can use to tell the task what objects you want to use.

Geoscience object references

A geoscience object reference is a URL for a geoscience object. You can either use URLs with the object's path or its ID.

// A path-based URL
"https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/path/{path}"

// An ID-based URL
"https://{hub}.api.seequent.com/geoscience-object/orgs/{org_id}/workspaces/{workspace_id}/objects/{object_id}"

Geoscience object attribute references

A geoscience object attribute reference lets you point to a specific attribute inside a geoscience object. It uses a language called JMESPath to tell the task where to look for the attribute inside the object.

// This points to an attribute called "elevation" inside a regular-2d-grid object.
"cell_attributes[?name=='elevation']"

Geoscience object attribute targets

A geoscience object attribute target lets you tell the task how to create or update an attribute inside a geoscience object. For geophysics tasks, results are typically written as new attributes on existing objects.

Available tasks

Gravity terrain correction

The gravity terrain correction task computes terrain corrections for gravity measurements at observation points. This accounts for the gravitational effect of topography and optionally water layers on gravity measurements.