Model-Service-Example.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Model Service Example Notebook\n",
    "\n",
    "This notebook walks through how to interact with the Model Service API using the Python `requests` library (`requests==2.21.0`).\n",
    "\n",
    "## Contents\n",
    "**Model Exploration**\n",
    "- [List Models](#List-Models)\n",
    "- [Get Model Info](#Get-Model-Info)\n",
    "- [Get Model Configurations](#Get-Model-Configurations)\n",
    "- [List Model Inputs or Outputs](#List-Model-Inputs-or-Outputs)\n",
    "- [Obtain Model Parameters](#Obtain-Model-Parameters)\n",
    "- [Search for models and datasets](#Search-for-models-and-datasets)\n",
    "    - [Geo Search](#Geo-Search)\n",
    "    - [Text Search](#Text-Search)\n",
    "    - [Time Search](#Time-Search)\n",
    "\n",
    "**Model Execution**\n",
    "- [Run Model](#Run-Model)\n",
    "- [List Model Runs](#List-Model-Runs)\n",
    "- [Check Run Status](#Check-Run-Status)\n",
    "- [Get Run Results](#Get-Run-Results)\n",
    "\n",
    "First, we should perform some imports and configuration."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "import requests\n",
    "import json"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {},
   "outputs": [],
   "source": [
    "username = \"USERNAME\" # replace with correct username\n",
    "password = \"PASSWORD\" # replace with correct password\n",
    "url = f\"https://{username}:{password}@model-service.worldmodelers.com\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## List Models"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/list_models\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'category': ['Economic'],\n",
       "  'description': 'The Food Shocks Cascade Model (FSC) is a simple agent-based network model that computes chain-reactions due to negative production anomalies based on dynamic food balance sheets at the country level.',\n",
       "  'maintainer': '',\n",
       "  'name': 'FSC',\n",
       "  'versions': ['FSC_0.1']}]"
      ]
     },
     "execution_count": 4,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Get Model Info"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {},
   "outputs": [],
   "source": [
    "model = \"FSC\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.get(f\"{url}/model_info/{model}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'category': ['Economic'],\n",
       " 'description': 'The Food Shocks Cascade Model (FSC) is a simple agent-based network model that computes chain-reactions due to negative production anomalies based on dynamic food balance sheets at the country level.',\n",
       " 'maintainer': '',\n",
       " 'name': 'FSC',\n",
       " 'versions': ['FSC_0.1']}"
      ]
     },
     "execution_count": 7,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Get Model Configurations"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [],
   "source": [
    "model = \"FSC\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.get(f\"{url}/model_config/{model}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'config': {'description': 'FSC single country shock configuration',\n",
       "   'has_component_location': \"['https://github.com/mjpuma/FSC-WorldModelers']\",\n",
       "   'has_input': [{'id': '48e9c63d-2e40-4186-a65d-a5dc5d6818bf',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'ciso3.txt',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'Production_Crops_E_All_Data_(Normalized).csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'b18a459a-6c8a-48ed-b294-10e9a99e992a',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'ecd711d4-d3f9-4807-9040-cefde9a6c576',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'a8bd169a-97d0-4251-bdad-c062cfa3c179',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'c7a24193-84a5-460f-b8e7-16b3a31a2cc4',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'psd_grains_pulses.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': '14f14ea6-fe90-4c73-9460-5bfaf94149c6',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'wheat_production_change.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'productiondataFAOSTAT.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']}],\n",
       "   'has_output': [{'id': '0c08c80f-f9f4-466f-bd24-1dea0dc07de8',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': '11a3e749-212b-40c1-b923-8886ef829449',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'dE.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'e5209cb4-1f0b-4b97-9716-b24fe73041f1',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'single_shock_results.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']},\n",
       "    {'id': 'E0.csv',\n",
       "     'type': ['https://w3id.org/mint/modelCatalog#DatasetSpecification']}],\n",
       "   'has_parameter': [{'id': 'FSC-fractional-reserves-access',\n",
       "     'type': ['http://www.geoscienceontology.org/svo/svl/operator#reduction',\n",
       "      'https://w3id.org/mint/modelCatalog#Parameter']},\n",
       "    {'id': 'FSC-production-decrease',\n",
       "     'type': ['http://www.geoscienceontology.org/svo/svl/operator#reduction',\n",
       "      'https://w3id.org/mint/modelCatalog#Parameter']},\n",
       "    {'id': 'FSC-country-code',\n",
       "     'type': ['https://schema.org/addressCountry',\n",
       "      'https://w3id.org/mint/modelCatalog#Parameter']},\n",
       "    {'id': 'FSC-year',\n",
       "     'type': ['http://www.geoscienceontology.org/svo/svl/property#year',\n",
       "      'https://w3id.org/mint/modelCatalog#Parameter']}],\n",
       "   'id': 'FSC_config',\n",
       "   'label': 'FSC configuration',\n",
       "   'type': ['https://w3id.org/mint/modelCatalog#ModelConfiguration',\n",
       "    'mc:ModelConfiguration']},\n",
       "  'name': 'FSC'}]"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## List Model Inputs or Outputs"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [],
   "source": [
    "model = \"FSC\"\n",
    "iotype = \"input\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\"name\": model, \"iotype\": iotype}"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/model_io\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'description': 'Agricultural reserves data from USDA.',\n",
       "  'filetype': 'csv',\n",
       "  'id': '14f14ea6-fe90-4c73-9460-5bfaf94149c6',\n",
       "  'name': 'psd_grains_pulses.csv',\n",
       "  'variables': [{'id': '00b91a51-8e5e-4928-8f0f-aa77456b2184',\n",
       "    'metadata': {},\n",
       "    'name': 'Unit_Description',\n",
       "    'standard_names': [{'standard_variable_id': 'c3a3fd4a-caba-555d-adaf-8a843c954999',\n",
       "      'standard_variable_name': 'Quantitative Value',\n",
       "      'standard_variable_uri': 'https://schema.org/QuantitativeValue'}]},\n",
       "   {'id': '1311df72-a838-4054-a2de-756e9978775c',\n",
       "    'metadata': {},\n",
       "    'name': 'Market_Year',\n",
       "    'standard_names': [{'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]},\n",
       "   {'id': '216c3afc-d03b-4c20-a115-df123967d1ca',\n",
       "    'metadata': {},\n",
       "    'name': 'Country_Name',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]},\n",
       "   {'id': '3c01ba2c-a196-4d10-a9d6-1266f8512343',\n",
       "    'metadata': {},\n",
       "    'name': 'Month',\n",
       "    'standard_names': [{'standard_variable_id': '45e9595e-162b-554b-b9d6-b7886337173e',\n",
       "      'standard_variable_name': 'date',\n",
       "      'standard_variable_uri': 'https://schema.org/Date'}]},\n",
       "   {'id': '46c168ba-f4d2-4fda-a310-df0f590165cb',\n",
       "    'metadata': {},\n",
       "    'name': 'Calendar_Year',\n",
       "    'standard_names': [{'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]},\n",
       "   {'id': '58fbbc41-1d46-4587-8835-27ef9c606d78',\n",
       "    'metadata': {},\n",
       "    'name': 'Value',\n",
       "    'standard_names': [{'standard_variable_id': '4760822e-0e1a-55fa-bd43-642ee981ed5f',\n",
       "      'standard_variable_name': 'Crop Production',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_5976'}]},\n",
       "   {'id': '72b787f2-f990-4a1e-8c46-75a3faff7336',\n",
       "    'metadata': {},\n",
       "    'name': 'Commodity_Code',\n",
       "    'standard_names': [{'standard_variable_id': 'c3a3fd4a-caba-555d-adaf-8a843c954999',\n",
       "      'standard_variable_name': 'Quantitative Value',\n",
       "      'standard_variable_uri': 'https://schema.org/QuantitativeValue'}]},\n",
       "   {'id': 'cf6861db-022f-4604-98fe-205df9d39573',\n",
       "    'metadata': {},\n",
       "    'name': 'Country_Code',\n",
       "    'standard_names': [{'standard_variable_id': '2bec089d-2304-5438-ba33-68edf769c6e1',\n",
       "      'standard_variable_name': 'ISO-3 Country Code',\n",
       "      'standard_variable_uri': 'https://schema.org/addressCountry'}]},\n",
       "   {'id': 'eca6a2d5-b657-432c-bb47-8f4e35da18ec',\n",
       "    'metadata': {},\n",
       "    'name': 'Commodity_Description',\n",
       "    'standard_names': [{'standard_variable_id': '4350b567-805e-5bf5-bc41-35822ea57bfd',\n",
       "      'standard_variable_name': 'Type Specimens',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_08d19be4'}]},\n",
       "   {'id': 'f4fd6fa3-caab-424d-8176-ea7e7ea2b274',\n",
       "    'metadata': {},\n",
       "    'name': 'Attribute_Description',\n",
       "    'standard_names': [{'standard_variable_id': '4350b567-805e-5bf5-bc41-35822ea57bfd',\n",
       "      'standard_variable_name': 'Type Specimens',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_08d19be4'}]}]},\n",
       " {'description': 'Crop production data from FAOSTAT, production quantity in tonnes',\n",
       "  'filetype': 'csv',\n",
       "  'id': '48e9c63d-2e40-4186-a65d-a5dc5d6818bf',\n",
       "  'name': 'productiondataFAOSTAT.csv',\n",
       "  'variables': [{'id': '37377535-0d8b-436d-bb81-ba636e1534d4',\n",
       "    'metadata': {},\n",
       "    'name': 'Year',\n",
       "    'standard_names': [{'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]},\n",
       "   {'id': '3c99fce7-ff93-43e4-bd1a-0b24abf001cb',\n",
       "    'metadata': {},\n",
       "    'name': 'Unit',\n",
       "    'standard_names': [{'standard_variable_id': '61575a92-a356-5be0-949d-582798ae81f3',\n",
       "      'standard_variable_name': 'Weight',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_8349'}]},\n",
       "   {'id': '9db0c06c-26d3-4d92-9cdc-54e00980a871',\n",
       "    'metadata': {},\n",
       "    'name': 'Item',\n",
       "    'standard_names': [{'standard_variable_id': '4350b567-805e-5bf5-bc41-35822ea57bfd',\n",
       "      'standard_variable_name': 'Type Specimens',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_08d19be4'}]},\n",
       "   {'id': 'b0c5706e-9d9d-43f1-ba17-169a2bea9fd5',\n",
       "    'metadata': {},\n",
       "    'name': 'Area',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]},\n",
       "   {'id': 'f0f7be8c-e756-4cbf-94a0-8b049d54a2c6',\n",
       "    'metadata': {},\n",
       "    'name': 'Value',\n",
       "    'standard_names': [{'standard_variable_id': '4760822e-0e1a-55fa-bd43-642ee981ed5f',\n",
       "      'standard_variable_name': 'Crop Production',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_5976'},\n",
       "     {'standard_variable_id': 'c3a3fd4a-caba-555d-adaf-8a843c954999',\n",
       "      'standard_variable_name': 'Quantitative Value',\n",
       "      'standard_variable_uri': 'https://schema.org/QuantitativeValue'}]}]},\n",
       " {'description': 'Wheat production change by country for a 15 year period',\n",
       "  'filetype': 'csv',\n",
       "  'id': 'a8bd169a-97d0-4251-bdad-c062cfa3c179',\n",
       "  'name': 'wheat_production_change.csv',\n",
       "  'variables': [{'id': '18b54a69-06cf-4e2d-b64a-2e629b7f3aaf',\n",
       "    'metadata': {},\n",
       "    'name': 'Country_Code',\n",
       "    'standard_names': [{'standard_variable_id': '2bec089d-2304-5438-ba33-68edf769c6e1',\n",
       "      'standard_variable_name': 'ISO-3 Country Code',\n",
       "      'standard_variable_uri': 'https://schema.org/addressCountry'}]},\n",
       "   {'id': '3fb0b9ba-5946-4a8a-aea9-32597ec072bf',\n",
       "    'metadata': {},\n",
       "    'name': 'Year',\n",
       "    'standard_names': [{'standard_variable_id': '4760822e-0e1a-55fa-bd43-642ee981ed5f',\n",
       "      'standard_variable_name': 'Crop Production',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_5976'},\n",
       "     {'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]}]},\n",
       " {'description': 'Trade data from FAOSTAT, detailed trade matrix, normalized, all data',\n",
       "  'filetype': 'csv',\n",
       "  'id': 'b18a459a-6c8a-48ed-b294-10e9a99e992a',\n",
       "  'name': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv',\n",
       "  'variables': [{'id': '04a922eb-e2b1-4c3b-9ae3-6c99ae21a8fe',\n",
       "    'metadata': {},\n",
       "    'name': 'Unit',\n",
       "    'standard_names': [{'standard_variable_id': '61575a92-a356-5be0-949d-582798ae81f3',\n",
       "      'standard_variable_name': 'Weight',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_8349'}]},\n",
       "   {'id': '124a2cdb-6fac-494d-aaa4-85ce0d78a5ce',\n",
       "    'metadata': {},\n",
       "    'name': 'Item',\n",
       "    'standard_names': [{'standard_variable_id': '4350b567-805e-5bf5-bc41-35822ea57bfd',\n",
       "      'standard_variable_name': 'Type Specimens',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_08d19be4'}]},\n",
       "   {'id': '49ffab3f-3737-45cb-bcc1-79caf7e8c485',\n",
       "    'metadata': {},\n",
       "    'name': 'Year',\n",
       "    'standard_names': [{'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]},\n",
       "   {'id': 'c091c567-3d08-4fd4-9580-ddb045fcd97f',\n",
       "    'metadata': {},\n",
       "    'name': 'Reporter Countries',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]},\n",
       "   {'id': 'dde44bc6-7f48-48c1-8515-5eeaf4d2d7cf',\n",
       "    'metadata': {},\n",
       "    'name': 'Partner Countries',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]},\n",
       "   {'id': 'fa581b41-6f3c-4676-9d07-48ff770d12b3',\n",
       "    'metadata': {},\n",
       "    'name': 'Value',\n",
       "    'standard_names': [{'standard_variable_id': '30dbfc49-4baf-5df6-8ae4-28ed08b5d9b8',\n",
       "      'standard_variable_name': 'Price',\n",
       "      'standard_variable_uri': 'https://schema.org/price'},\n",
       "     {'standard_variable_id': '4760822e-0e1a-55fa-bd43-642ee981ed5f',\n",
       "      'standard_variable_name': 'Crop Production',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_5976'},\n",
       "     {'standard_variable_id': 'e9bc1fa2-011e-576e-ae4c-76a8deef1c76',\n",
       "      'standard_variable_name': 'Trade Action',\n",
       "      'standard_variable_uri': 'https://schema.org/TradeAction'}]}]},\n",
       " {'description': 'ISO-3 country codes',\n",
       "  'filetype': 'txt',\n",
       "  'id': 'c7a24193-84a5-460f-b8e7-16b3a31a2cc4',\n",
       "  'name': 'ciso3.txt',\n",
       "  'variables': [{'id': '8c2f8acc-08eb-437d-b4f3-00997bfa732f',\n",
       "    'metadata': {},\n",
       "    'name': 'ISO3',\n",
       "    'standard_names': [{'standard_variable_id': '2bec089d-2304-5438-ba33-68edf769c6e1',\n",
       "      'standard_variable_name': 'ISO-3 Country Code',\n",
       "      'standard_variable_uri': 'https://schema.org/addressCountry'}]},\n",
       "   {'id': 'c386ca15-8b87-46f0-9b35-e8c9460e9a9a',\n",
       "    'metadata': {},\n",
       "    'name': 'name',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]}]},\n",
       " {'description': 'Normalized crop production by country from FAOSTAT',\n",
       "  'filetype': 'csv',\n",
       "  'id': 'ecd711d4-d3f9-4807-9040-cefde9a6c576',\n",
       "  'name': 'Production_Crops_E_All_Data_(Normalized).csv',\n",
       "  'variables': [{'id': '1134aa07-f9ce-4736-99fe-4d57547f78ac',\n",
       "    'metadata': {},\n",
       "    'name': 'Value',\n",
       "    'standard_names': [{'standard_variable_id': '4760822e-0e1a-55fa-bd43-642ee981ed5f',\n",
       "      'standard_variable_name': 'Crop Production',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_5976'}]},\n",
       "   {'id': '4c9619a5-1574-4ac2-a4fb-c4e9ffe25105',\n",
       "    'metadata': {},\n",
       "    'name': 'Area',\n",
       "    'standard_names': [{'standard_variable_id': 'ce76c001-3e05-593e-af4f-e450b6cc1bc1',\n",
       "      'standard_variable_name': 'Country Name',\n",
       "      'standard_variable_uri': 'https://schema.org/Country'}]},\n",
       "   {'id': '5157df00-d8a2-40c1-828d-f852e3125eee',\n",
       "    'metadata': {},\n",
       "    'name': 'Item',\n",
       "    'standard_names': [{'standard_variable_id': '4350b567-805e-5bf5-bc41-35822ea57bfd',\n",
       "      'standard_variable_name': 'Type Specimens',\n",
       "      'standard_variable_uri': 'http://aims.fao.org/aos/agrovoc/c_08d19be4'}]},\n",
       "   {'id': '80dadf02-f54a-48ff-8591-d43461d1e3cc',\n",
       "    'metadata': {},\n",
       "    'name': 'Year',\n",
       "    'standard_names': [{'standard_variable_id': 'df1daca4-d727-5dc8-bfa4-fb20c717a32b',\n",
       "      'standard_variable_name': 'year',\n",
       "      'standard_variable_uri': 'http://www.geoscienceontology.org/svo/svl/property#year'}]},\n",
       "   {'id': 'c0eaa16c-6fa5-49b3-af07-e05b87edbfb1',\n",
       "    'metadata': {},\n",
       "    'name': 'Unit',\n",
       "    'standard_names': [{'standard_variable_id': 'c3a3fd4a-caba-555d-adaf-8a843c954999',\n",
       "      'standard_variable_name': 'Quantitative Value',\n",
       "      'standard_variable_uri': 'https://schema.org/QuantitativeValue'}]}]}]"
      ]
     },
     "execution_count": 14,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Obtain Model Parameters\n",
    "Note that the `label` field for each model parameter is used as part of the payload sent to the `run_model` endpoint in order to configure a model run."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "metadata": {},
   "outputs": [],
   "source": [
    "model = \"FSC\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "TODO: this should be a `get` request, not a `post`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 16,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/model_parameters/{model}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'data_type': 'string',\n",
       "  'default_value': 'SOM',\n",
       "  'description': 'The ISO 3 country code for the country of interest.',\n",
       "  'id': 'FSC-country-code',\n",
       "  'label': 'country'},\n",
       " {'data_type': 'number',\n",
       "  'default_value': '0.3',\n",
       "  'description': 'The percentage of fractional reserves which may be accessed (from 0 to 1, where 1 equals a 100% decrease)',\n",
       "  'id': 'FSC-fractional-reserves-access',\n",
       "  'label': 'fractional_reserve_access'},\n",
       " {'data_type': 'number',\n",
       "  'default_value': '0.2',\n",
       "  'description': 'The decrease in production you wish to induce (from 0 to 1, where 1 equals a 100% decrease)',\n",
       "  'id': 'FSC-production-decrease',\n",
       "  'label': 'production_decrease'},\n",
       " {'data_type': 'integer',\n",
       "  'default_value': '2005',\n",
       "  'description': 'The year you wish to simulate',\n",
       "  'id': 'FSC-year',\n",
       "  'label': 'year'}]"
      ]
     },
     "execution_count": 17,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Search for models and datasets\n",
    "Currently, you may search for:\n",
    "\n",
    "* `geo`: datasets and models\n",
    "* `text`: keywords (against models) and standard names (against datasets)\n",
    "* `time`: datasets and models\n",
    "\n",
    "When models are returned for `geo` or `time` queries, it is because they have associated datasets that have matched the query. \n",
    "\n",
    "When models are returned for a `text` query it is because the query term matches the model description."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Geo Search\n",
    "Search for datasets based on the spatial coverage of the dataset"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\n",
    "           \"query_type\":\"geo\",\n",
    "           \"result_type\":\"datasets\",\n",
    "           \"xmin\": 33.9605286,\n",
    "           \"xmax\": 33.9895077,\n",
    "           \"ymin\": -118.4253354,\n",
    "           \"ymax\": -118.4093589\n",
    "          }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 19,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/search\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 20,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'dataset_id': '4e8ade31-7729-4891-a462-2dac66158512',\n",
       "  'dataset_metadata': {'any_additional_metadata': 'content',\n",
       "   'new_metadata': 9,\n",
       "   'variables': [{'@id': 'blah'}, {'@id': 'blah1'}]},\n",
       "  'dataset_name': 'Temperature recorded outside my house',\n",
       "  'resource_data_url': 'www.my_domain.com/storage/temp_records_2018_01_02.csv',\n",
       "  'resource_id': '25916ccf-d108-4187-b243-2b257ce67fa5',\n",
       "  'resource_metadata': {'spatial_coverage': {'type': 'BoundingBox',\n",
       "    'value': {'xmax': 33.9895077,\n",
       "     'xmin': 33.9605286,\n",
       "     'ymax': -118.4093589,\n",
       "     'ymin': -118.4253354}},\n",
       "   'temporal_coverage': {'end_time': '2018-01-02T23:59:59',\n",
       "    'start_time': '2018-01-02T00:00:00'}},\n",
       "  'resource_name': 'temp_records_2018_01_02.csv'},\n",
       " {'dataset_id': '4e8ade31-7729-4891-a462-2dac66158512',\n",
       "  'dataset_metadata': {'any_additional_metadata': 'content',\n",
       "   'new_metadata': 9,\n",
       "   'variables': [{'@id': 'blah'}, {'@id': 'blah1'}]},\n",
       "  'dataset_name': 'Temperature recorded outside my house',\n",
       "  'resource_data_url': 'www.my_domain.com/storage/temp_records_2018_01_01.csv',\n",
       "  'resource_id': 'dd52e66b-3149-4d46-8f8e-a18e46136e55',\n",
       "  'resource_metadata': {'spatial_coverage': {'type': 'BoundingBox',\n",
       "    'value': {'xmax': 33.9895077,\n",
       "     'xmin': 33.9605286,\n",
       "     'ymax': -118.4093589,\n",
       "     'ymin': -118.4253354}},\n",
       "   'temporal_coverage': {'end_time': '2018-01-01T23:59:59',\n",
       "    'start_time': '2018-01-01T00:00:00'}},\n",
       "  'resource_name': 'temp_records_2018_01_01.csv'}]"
      ]
     },
     "execution_count": 20,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Text Search\n",
    "Search for datasets or models based on standard names or keywords"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Standard Name search\n",
    "Search for datasets by Standard Name"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 21,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\n",
    "           \"query_type\":\"text\",\n",
    "           \"result_type\":\"datasets\",\n",
    "           \"term\": \"Country Name\",\n",
    "           \"type\": \"standard name\"\n",
    "          }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 22,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/search\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'dataset_id': '14f14ea6-fe90-4c73-9460-5bfaf94149c6',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2019-01-01T23:59:59',\n",
       "    'start_time': '1960-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'psd_grains_pulses.csv',\n",
       "  'resource_data_url': 'https://apps.fas.usda.gov/psdonline/downloads/psd_grains_pulses_csv.zip',\n",
       "  'resource_id': '3c71627c-4ede-4097-893c-3a295d66fb05',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2019-01-01T23:59:59',\n",
       "    'start_time': '1960-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'psd_grains_pulses.csv'},\n",
       " {'dataset_id': '14f14ea6-fe90-4c73-9460-5bfaf94149c6',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2019-01-01T23:59:59',\n",
       "    'start_time': '1960-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'psd_grains_pulses.csv',\n",
       "  'resource_data_url': 'https://apps.fas.usda.gov/psdonline/downloads/psd_grains_pulses_csv.zip',\n",
       "  'resource_id': 'dc9a1015-fe1d-4e3f-8260-9222e6668938',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2019-01-01T23:59:59',\n",
       "    'start_time': '1960-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'psd_grains_pulses.csv'},\n",
       " {'dataset_id': '48e9c63d-2e40-4186-a65d-a5dc5d6818bf',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2011-01-01T23:59:59',\n",
       "    'start_time': '1986-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'productiondataFAOSTAT.csv',\n",
       "  'resource_data_url': 'https://github.com/mjpuma/FSC-WorldModelers/blob/docker/inputs/productiondataFAOSTAT.csv',\n",
       "  'resource_id': 'be9082ff-3119-4b61-9626-600802caba8d',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2011-01-01T23:59:59',\n",
       "    'start_time': '1986-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'productiondataFAOSTAT.csv'},\n",
       " {'dataset_id': '48e9c63d-2e40-4186-a65d-a5dc5d6818bf',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2011-01-01T23:59:59',\n",
       "    'start_time': '1986-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'productiondataFAOSTAT.csv',\n",
       "  'resource_data_url': 'https://github.com/mjpuma/FSC-WorldModelers/blob/docker/inputs/productiondataFAOSTAT.csv',\n",
       "  'resource_id': 'c12a484d-5953-4e1f-8cf2-9b51c2060d63',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2011-01-01T23:59:59',\n",
       "    'start_time': '1986-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'productiondataFAOSTAT.csv'},\n",
       " {'dataset_id': 'b18a459a-6c8a-48ed-b294-10e9a99e992a',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2017-01-01T23:59:59',\n",
       "    'start_time': '1961-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv',\n",
       "  'resource_data_url': 'http://fenixservices.fao.org/faostat/static/bulkdownloads/Trade_DetailedTradeMatrix_E_All_Data_(Normalized).zip',\n",
       "  'resource_id': '7eb157d7-dffa-4a71-86c7-b06c4bb1e073',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2017-01-01T23:59:59',\n",
       "    'start_time': '1961-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv'},\n",
       " {'dataset_id': 'b18a459a-6c8a-48ed-b294-10e9a99e992a',\n",
       "  'dataset_metadata': {'temporal_coverage': {'end_time': '2017-01-01T23:59:59',\n",
       "    'start_time': '1961-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv',\n",
       "  'resource_data_url': 'http://fenixservices.fao.org/faostat/static/bulkdownloads/Trade_DetailedTradeMatrix_E_All_Data_(Normalized).zip',\n",
       "  'resource_id': 'c4e775f0-5c1f-4684-9cbc-0c53c95535f0',\n",
       "  'resource_metadata': {'temporal_coverage': {'end_time': '2017-01-01T23:59:59',\n",
       "    'start_time': '1961-01-01T00:00:00'},\n",
       "   'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'Trade_DetailedTradeMatrix_E_All_Data_(Normalized).csv'},\n",
       " {'dataset_id': 'c7a24193-84a5-460f-b8e7-16b3a31a2cc4',\n",
       "  'dataset_metadata': {'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'ciso3.txt',\n",
       "  'resource_data_url': 'https://raw.githubusercontent.com/mjpuma/FSC-WorldModelers/docker/inputs/ciso3.txt?token=ABMR2R26PFW2DYD3SQ2XYKS46FVEK',\n",
       "  'resource_id': '1a7ee3a7-ee25-4c43-b64f-17f5cd99be29',\n",
       "  'resource_metadata': {'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'ciso3.txt'},\n",
       " {'dataset_id': 'c7a24193-84a5-460f-b8e7-16b3a31a2cc4',\n",
       "  'dataset_metadata': {'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'ciso3.txt',\n",
       "  'resource_data_url': 'https://raw.githubusercontent.com/mjpuma/FSC-WorldModelers/docker/inputs/ciso3.txt?token=ABMR2R26PFW2DYD3SQ2XYKS46FVEK',\n",
       "  'resource_id': 'f3c1ac38-3cfe-47fa-942b-1069e1cc1a28',\n",
       "  'resource_metadata': {'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'ciso3.txt'},\n",
       " {'dataset_id': 'ecd711d4-d3f9-4807-9040-cefde9a6c576',\n",
       "  'dataset_metadata': {'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'Production_Crops_E_All_Data_(Normalized).csv',\n",
       "  'resource_data_url': 'http://fenixservices.fao.org/faostat/static/bulkdownloads/Production_Crops_E_All_Data_(Normalized).zip',\n",
       "  'resource_id': '899ab561-ed16-4ba8-8cbd-a0f47472444f',\n",
       "  'resource_metadata': {'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'Production_Crops_E_All_Data_(Normalized).csv'},\n",
       " {'dataset_id': 'ecd711d4-d3f9-4807-9040-cefde9a6c576',\n",
       "  'dataset_metadata': {'type': 'Input to FSC Model'},\n",
       "  'dataset_name': 'Production_Crops_E_All_Data_(Normalized).csv',\n",
       "  'resource_data_url': 'http://fenixservices.fao.org/faostat/static/bulkdownloads/Production_Crops_E_All_Data_(Normalized).zip',\n",
       "  'resource_id': 'b310bee6-9b78-4080-8a8e-784d3ea39c36',\n",
       "  'resource_metadata': {'type': 'Input to FSC Model'},\n",
       "  'resource_name': 'Production_Crops_E_All_Data_(Normalized).csv'}]"
      ]
     },
     "execution_count": 23,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Keyword search\n",
    "Search for models based on keyword. This may take several seconds."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 24,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\n",
    "           \"query_type\":\"text\",\n",
    "           \"result_type\":\"models\",\n",
    "           \"term\": \"food\",\n",
    "           \"type\": \"keyword\"\n",
    "          }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/search\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "metadata": {
    "scrolled": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'category': ['Economic'],\n",
       "  'description': 'The Food Shocks Cascade Model (FSC) is a simple agent-based network model that computes chain-reactions due to negative production anomalies based on dynamic food balance sheets at the country level.',\n",
       "  'maintainer': '',\n",
       "  'name': 'FSC',\n",
       "  'versions': ['FSC_0.1']}]"
      ]
     },
     "execution_count": 26,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Time Search\n",
    "Search for datasets or models based on temporal coverage"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 27,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\n",
    "           \"query_type\":\"time\",\n",
    "           \"result_type\":\"models\",\n",
    "           \"start_time\": \"1960-01-01T00:00:00\",\n",
    "           \"end_time\": \"2019-01-01T23:59:59\"\n",
    "          }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 28,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/search\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 29,
   "metadata": {
    "scrolled": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "[{'category': ['Economic'],\n",
       "  'description': 'The Food Shocks Cascade Model (FSC) is a simple agent-based network model that computes chain-reactions due to negative production anomalies based on dynamic food balance sheets at the country level.',\n",
       "  'maintainer': '',\n",
       "  'name': 'FSC',\n",
       "  'versions': ['FSC_0.1']}]"
      ]
     },
     "execution_count": 29,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Run Model\n",
    "Note that the `config` within the model payload below should contain each of the paramater `labels` obtained from the `model_parameters` endpoint."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 30,
   "metadata": {},
   "outputs": [],
   "source": [
    "payload = {\n",
    "           \"config\":{\n",
    "              \"year\":2005,\n",
    "              \"country\":\"USA\",\n",
    "              \"production_decrease\":0.4,\n",
    "              \"fractional_reserve_access\":0.5\n",
    "           },\n",
    "           \"name\":\"FSC\"\n",
    "        }"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 31,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.post(f\"{url}/run_model\", json=payload)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 32,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'f9c796787d534ba92ff1528353e045921a74b56ef9c20cd54282d0073d2015c3'"
      ]
     },
     "execution_count": 32,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We should store the response to the run as a `run_id` for future reference."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 33,
   "metadata": {},
   "outputs": [],
   "source": [
    "run_id = response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## List Model Runs\n",
    "We can list model runs; we should see our run in the list."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 34,
   "metadata": {},
   "outputs": [],
   "source": [
    "model = \"FSC\""
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 35,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.get(f\"{url}/list_runs/{model}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 36,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['f9c796787d534ba92ff1528353e045921a74b56ef9c20cd54282d0073d2015c3',\n",
       " 'cf49488892ea86c77f0f0a4176e73cfa112b52db9126d9236db9f4d3e0e21a17']"
      ]
     },
     "execution_count": 36,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Check Run Status\n",
    "We will use the `run_id` we stored from our prior model run."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 37,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.get(f\"{url}/run_status/{run_id}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 38,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "'SUCCESS'"
      ]
     },
     "execution_count": 38,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Get Run Results\n",
    "We will use the `run_id` we stored from our prior model run."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 39,
   "metadata": {},
   "outputs": [],
   "source": [
    "response = requests.get(f\"{url}/run_results/{run_id}\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'config': {'config': {'country': 'USA',\n",
       "   'fractional_reserve_access': 0.5,\n",
       "   'production_decrease': 0.4,\n",
       "   'run_id': 'f9c796787d534ba92ff1528353e045921a74b56ef9c20cd54282d0073d2015c3',\n",
       "   'year': 2005},\n",
       "  'name': 'FSC'},\n",
       " 'output': 'https://s3.amazonaws.com/world-modelers/results/fsc_model/f9c796787d534ba92ff1528353e045921a74b56ef9c20cd54282d0073d2015c3.zip',\n",
       " 'status': 'SUCCESS'}"
      ]
     },
     "execution_count": 40,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "response.json()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 41,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Results are stored to S3 at: https://s3.amazonaws.com/world-modelers/results/fsc_model/f9c796787d534ba92ff1528353e045921a74b56ef9c20cd54282d0073d2015c3.zip\n"
     ]
    }
   ],
   "source": [
    "print(f\"Results are stored to S3 at: {response.json()['output']}\")"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.7.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}