{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Quick Start - Area of Interest (AOI) Query\n", "\n", "In this section, we will find and request a pre-defined area of interest (AOI) and use it to initiate a Environmental Intelligence (EI): Geospatial APIs raster query.\n", "\n", "In order to run this notebook, `ibmpairs`, `geopandas`, `geoplot`, `numpy` and `matplotlib` must be installed to your python environment using your package manager of choice, e.g. with pip:\n", "\n", "```\n", "pip install ibmpairs geopandas geoplot numpy matplotlib\n", "```\n", "\n", "## Search for AOI\n", "\n", "An AOI, in Geospatial APIs, is a pre-defined labelled spatial definition that can be specified as the spatial extent (area) of a raster query; usually a jurisdiction (e.g. country, state etc).\n", "\n", "To use an AOI in a raster query, we must find an area that we wish to query; to do so, we can use the SDK method `query.search_aois`:" ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "2024-06-19 10:03:54 - paw - INFO - The client authentication method is assumed to be OAuth2.\n", "2024-06-19 10:03:54 - paw - INFO - Legacy Environment is False\n", "2024-06-19 10:03:54 - paw - INFO - The authentication api key type is assumed to be IBM Cloud IAM, because the api key prefix 'PHX' is not present.\n", "2024-06-19 10:03:55 - paw - INFO - Authentication success.\n", "2024-06-19 10:03:55 - paw - INFO - HOST: https://api.ibm.com/geospatial/run/na/core/v3\n" ] }, { "data": { "text/html": [ "
\n", " | id | \n", "key | \n", "name | \n", "
---|---|---|---|
0 | \n", "51575 | \n", "missouri.texas | \n", "Missouri.Texas | \n", "
1 | \n", "52132 | \n", "oklahoma.texas | \n", "Oklahoma.Texas | \n", "
2 | \n", "52653 | \n", "texas.anderson | \n", "Texas.Anderson | \n", "
3 | \n", "52558 | \n", "texas.andrews | \n", "Texas.Andrews | \n", "
4 | \n", "52661 | \n", "texas.angelina | \n", "Texas.Angelina | \n", "
... | \n", "... | \n", "... | \n", "... | \n", "
509 | \n", "52553 | \n", "texas.yoakum | \n", "Texas.Yoakum | \n", "
510 | \n", "52595 | \n", "texas.young | \n", "Texas.Young | \n", "
511 | \n", "52769 | \n", "texas.zapata | \n", "Texas.Zapata | \n", "
512 | \n", "52758 | \n", "texas.zavala | \n", "Texas.Zavala | \n", "
513 | \n", "164 | \n", "usa-texas | \n", "USA - Texas | \n", "
514 rows × 3 columns
\n", "