ExecutionApi

All URIs are relative to https://model-service.worldmodelers.com

available_results_get

list[RunResults] available_results_get(model_name=model_name, size=size)

Obtain a list of run results

Return a list of all available run results.

Example

import requests

params = (
    ('ModelName', 'DSSAT'),
    ('size', '5'),
)

response = requests.get('https://model-service.worldmodelers.com/available_results', params=params)

Parameters

Return type

list[RunResults]

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_runs_model_name_get

list[RunID] list_runs_model_name_get(model_name)

Obtain a list of runs for a given model

Submit a ModelName and receive an array of RunIDs associated with the given model.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/list_runs/DSSAT')

Parameters

Return type

list[RunID]

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

result_file_result_file_name_get

result_file_result_file_name_get(result_file_name)

Obtain the result file for a given model run.

Submit a ResultFileName and receive model run result file.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/result_file/95895fd4baa0a586e48d919e68dfbce0486ba9f3f7b137be4c39d14b42233.geojson')

Parameters

Return type

void (empty response body)

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

run_model_post

RunID run_model_post(body)

Run a model for a given a configuration

Submit a configuration to run a specific model. Model is run asynchronously. Results are available through /run_results endpoint. Note that the requestBody must include a config object which should have as its keys the appropriate model parameter labels. Each key should have a corresponding parameter value. If a parameter is missing it will be defaulted.

Example

import requests

data = {
       "config":{
          "country":"Ethiopia",
          "month":11,
          "rainfall_scenario":"high",
          "year":2017
       
    },
       "name":"malnutrition_model"
    }

response = requests.post('https://model-service.worldmodelers.com/run_model', json=data)

Parameters

Return type

RunID

Authorization

Basic auth required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

run_results_run_id_get

RunResults run_results_run_id_get(run_id)

Obtain metadata about the results of a given model run

Submit a RunID and receive model run results metadata, including whether it succeeded or failed and where to access the result data.

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/run_results/a05fca513dacf89c84616c503fb39ead119d0202a4e7461bde8b189c680f900f')

Parameters

Return type

RunResults

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

run_status_run_id_get

RunStatus run_status_run_id_get(run_id)

Obtain status for a given model run

Submit a RunID and receive the model run status

Example

import requests

response = requests.get('https://model-service.worldmodelers.com/run_status/a05fca513dacf89c84616c503fb39ead119d0202a4e7461bde8b189c680f900f')

Parameters

Return type

RunStatus

Authorization

Basic auth required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]