Quickstart¶
Models¶
List all models¶
# create an instance of the API class
username="mint@isi.edu"
api_instance = modelcatalog.ModelApi()
try:
# List all Model entities
models = api_instance.models_get(username=username)
except ApiException as e:
print("Exception when calling ModelApi->models_get: %s\n" % e)
Response¶
A Model contains information such as description, documentation, authors and license. For more information, go to: Model
Search a model¶
You can search a model by a free text. Let's search all the models by the text: agriculture
# create an instance of the API class
username="mint@isi.edu"
label="agriculture"
api_instance = modelcatalog.ModelApi()
try:
# List all Model entities
models = api_instance.models_get(username=username, label=label)
except ApiException as e:
print("Exception when calling ModelApi->models_get: %s\n" % e)
Response¶
We found 2 models.
Warning
We are displaying only the id and description in a table for visualization purposes. The real output is a JSON.
Property | Value |
---|---|
description | ['Cycles simulates the productivity and the water,carbon and nitrogen balance of soil-crop systems subject to climate conditions and a large array of management constraints. Overall the model is set up to be daily. Some processes such as water balance are temporally nested (subdaily)\n.'] |
id | https://w3id.org/okn/i/mint/CYCLES |
Property | Value |
---|---|
description | ['Decision Support System for Agrotechnology Transfer (DSSAT) is software application program that comprises dynamic crop growth simulation models for over 40 crops. DSSAT is supported by a range of utilities and applications for weather, soil, genetic, crop management and observational experimental data. Includes example data sets for all crop models. The crop simulation models simulate growth, development and yield as a function of the soil-plant-atmosphere dynamics (https://dssat.net/. 2019)'] |
id | https://w3id.org/okn/i/mint/DSSAT |
Get information of a model¶
You can obtain information of a model. For example, the description, author and versions of the model CYCLES
.
model_id = "CYCLES"
try:
# Get a Model
model = api_instance.models_id_get(model_id, username=username)
pprint(model)
except ApiException as e:
print("Exception when calling ModelApi->models_id_get: %s\n" % e)
Response¶
Warning
We are displaying only the id, description, authors and versions
Property | Value |
---|---|
has_version | https://w3id.org/okn/i/mint/cycles_v0.9.3_alpha, https://w3id.org/okn/i/mint/cycles_v0.10.2_alpha, 'https://w3id.org/okn/i/mint/cycles_v0.9.4_alpha |
description | Cycles simulates the productivity and the water,carbon and nitrogen balance of soil-crop systems subject to climate conditions and a large array of management constraints. Overall the model is set up to be daily. Some processes such as water balance are temporally nested (subdaily) |
has_contact_person | https://w3id.org/okn/i/mint/kemanian_armen |
id | https://w3id.org/okn/i/mint/CYCLES |