Overview¶

This example demonstrates how to create and submit a job via Job endpoints.

Complete Authorization Form and Initialize Settings¶

This will also determine environment and set all environment variables. We determine if we are using Jupyter Notebooks or Google Colab to run this tutorial.

If you are running this notebook from Google Colab, Colab takes ~1 min to execute the following cell.

ACCOUNT_ID and AUTH_TOKEN - Authentication parameters needed for when making requests to Mat3ra.com's API Endpoints.

MATERIALS_PROJECT_API_KEY - Authentication parameter needed for when making requests to Material Project's API

ORGANIZATION_ID - Authentication parameter needed for when working with collaborative accounts https://docs.mat3ra.com/collaboration/organizations/overview/

NOTE: If you are running this notebook from Jupyter, the variables ACCOUNT_ID, AUTH_TOKEN, MATERIALS_PROJECT_API_KEY, and ORGANIZATION_ID should be set in the file settings.json if you need to use these variables. To obtain API token parameters, please see the following link to the documentation explaining how to get them: https://docs.mat3ra.com/accounts/ui/preferences/api/

In [1]:

# @title Authorization Form
ACCOUNT_ID = "ACCOUNT_ID"  # @param {type:"string"}
AUTH_TOKEN = "AUTH_TOKEN"  # @param {type:"string"}
MATERIALS_PROJECT_API_KEY = "MATERIALS_PROJECT_API_KEY"  # @param {type:"string"}
ORGANIZATION_ID = "ORGANIZATION_ID"  # @param {type:"string"}

import os

if "COLAB_JUPYTER_IP" in os.environ:
    os.environ.update(
        dict(
            ACCOUNT_ID=ACCOUNT_ID,
            AUTH_TOKEN=AUTH_TOKEN,
            MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY,
            ORGANIZATION_ID=ORGANIZATION_ID,
        )
    )

    !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

# @title Authorization Form ACCOUNT_ID = "ACCOUNT_ID" # @param {type:"string"} AUTH_TOKEN = "AUTH_TOKEN" # @param {type:"string"} MATERIALS_PROJECT_API_KEY = "MATERIALS_PROJECT_API_KEY" # @param {type:"string"} ORGANIZATION_ID = "ORGANIZATION_ID" # @param {type:"string"} import os if "COLAB_JUPYTER_IP" in os.environ: os.environ.update( dict( ACCOUNT_ID=ACCOUNT_ID, AUTH_TOKEN=AUTH_TOKEN, MATERIALS_PROJECT_API_KEY=MATERIALS_PROJECT_API_KEY, ORGANIZATION_ID=ORGANIZATION_ID, ) ) !GIT_BRANCH="dev"; export GIT_BRANCH; curl -s "https://raw.githubusercontent.com/Exabyte-io/api-examples/${GIT_BRANCH}/scripts/env.sh" | bash

In [2]:

from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID
from utils.generic import display_JSON

from exabyte_api_client.endpoints.jobs import JobEndpoints
from exabyte_api_client.endpoints.materials import MaterialEndpoints
from exabyte_api_client.endpoints.workflows import WorkflowEndpoints

from utils.settings import ENDPOINT_ARGS, ACCOUNT_ID from utils.generic import display_JSON from exabyte_api_client.endpoints.jobs import JobEndpoints from exabyte_api_client.endpoints.materials import MaterialEndpoints from exabyte_api_client.endpoints.workflows import WorkflowEndpoints

Initialize the endpoints¶

In [3]:

job_endpoints = JobEndpoints(*ENDPOINT_ARGS)
material_endpoints = MaterialEndpoints(*ENDPOINT_ARGS)
workflow_endpoints = WorkflowEndpoints(*ENDPOINT_ARGS)

job_endpoints = JobEndpoints(*ENDPOINT_ARGS) material_endpoints = MaterialEndpoints(*ENDPOINT_ARGS) workflow_endpoints = WorkflowEndpoints(*ENDPOINT_ARGS)

Set job name.

In [4]:

JOB_NAME = "TEST JOB"

JOB_NAME = "TEST JOB"

Retrieve IDs¶

Default account's materail and workflow are used in this example to create the job. Adjust the queries to use different material and workflow.

In [5]:

default_material = material_endpoints.list({"isDefault": True, "owner._id": ACCOUNT_ID})[0]
default_workflow = workflow_endpoints.list({"isDefault": True, "owner._id": ACCOUNT_ID})[0]

material_id = default_material["_id"]
workflow_id = default_workflow["_id"]
owner_id = default_material["owner"]["_id"]

default_material = material_endpoints.list({"isDefault": True, "owner._id": ACCOUNT_ID})[0] default_workflow = workflow_endpoints.list({"isDefault": True, "owner._id": ACCOUNT_ID})[0] material_id = default_material["_id"] workflow_id = default_workflow["_id"] owner_id = default_material["owner"]["_id"]

Create job config¶

The job belongs to user's default account and it is created inside the defauult account's project.

In [6]:

config = {
    "owner": {"_id": owner_id},
    "_material": {"_id": material_id},
    "workflow": {"_id": workflow_id},
    "name": JOB_NAME,
}

config = { "owner": {"_id": owner_id}, "_material": {"_id": material_id}, "workflow": {"_id": workflow_id}, "name": JOB_NAME, }

Create and submit job¶

In [7]:

job = job_endpoints.create(config)
job_endpoints.submit(job["_id"])

job = job_endpoints.create(config) job_endpoints.submit(job["_id"])

Print the job¶

Print the job in pretty JSON below. Check status field to make sure job is submiited.

In [8]:

job = job_endpoints.get(job["_id"])
display_JSON(job)

job = job_endpoints.get(job["_id"]) display_JSON(job)