test/hga/HGA_Regression.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "3fba6e94",
   "metadata": {},
   "source": [
    "# Harmony GDAL Adapter (HGA) regression tests\n",
    "\n",
    "The scope of this Jupyter notebook is to run a suite of regression tests against sample collections for the Harmony GDAL Adapter (HGA). These sample collections are primarily from the Alaska Satellite Facility (ASF), including:\n",
    "\n",
    "* [ALOS AVNIR OBS ORI](https://cmr.earthdata.nasa.gov/search/concepts/C1808440897-ASF.html)\n",
    "* [Sentinel 1 Interferograms](https://cmr.earthdata.nasa.gov/search/concepts/C1595422627-ASF.html)\n",
    "* [UAVSAR POLSAR Pauli](https://cmr.uat.earthdata.nasa.gov/search/concepts/C1244141264-EEDTEST.html)\n",
    "\n",
    "## Set the Harmony environment:\n",
    "\n",
    "The cell below sets the `harmony_host_url` to one of the following valid values:\n",
    "\n",
    "* Production: <https://harmony.earthdata.nasa.gov>\n",
    "* UAT: <https://harmony.uat.earthdata.nasa.gov>\n",
    "* SIT: <https://harmony.sit.earthdata.nasa.gov>\n",
    "* Local: <http://localhost:3000>\n",
    "\n",
    "The default value is for the UAT environment. When using this notebook there are two ways to use the non-default environment:\n",
    "\n",
    "* Run this notebook in a local Jupyter notebook server and change the value of `harmony_host_url` in the cell below to the value for the environment you require from the above list.\n",
    "* Use the `run_notebooks.sh` script, which requires you to declare an environment variable `HARMONY_HOST_URL`. Set that environment variable to the value above that corresponds to the environment you want to test. That environment variable will take precedence over the default value in the cell below."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "b7cada63",
   "metadata": {
    "tags": [
     "parameters"
    ]
   },
   "outputs": [],
   "source": [
    "harmony_host_url = 'https://harmony.uat.earthdata.nasa.gov'"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "abad61a7-e49a-475f-8cb8-7822c232f1da",
   "metadata": {},
   "source": [
    "## Prerequisites\n",
    "\n",
    "The dependencies for this notebook are listed in the [environment.yaml](./environment.yaml). To test or install locally, create the papermill environment used in the automated regression testing suite:\n",
    "\n",
    "`conda env create -f ./environment.yaml && conda activate papermill-hga`\n",
    "\n",
    "A `.netrc` file must also be located in the `test` directory of this repository."
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7f0766b7",
   "metadata": {},
   "source": [
    "### Import required packages:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "99f6c451",
   "metadata": {},
   "outputs": [],
   "source": [
    "from datetime import datetime\n",
    "\n",
    "from harmony import BBox, Client, Collection, Environment, Request\n",
    "\n",
    "from test_utilities import (\n",
    "    check_request_output,\n",
    "    clean_test_artefacts,\n",
    "    get_test_granule_id,\n",
    "    make_request_and_download_result,\n",
    "    print_success,\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1fbb7835",
   "metadata": {},
   "source": [
    "### Set up environment dependent variables:\n",
    "\n",
    "This includes the Harmony `Client` object and `Collection` objects for each of the collections for which there are regression tests. The local, SIT and UAT Harmony instances all utilise resources from CMR UAT, meaning any non-production environment will use the same resources.\n",
    "\n",
    "When adding a production entry to the dictionary below, the collection instances can be included directly in the production dictionary entry, as they do not need to be shared."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "59e7fab7",
   "metadata": {},
   "outputs": [],
   "source": [
    "non_production_collections = {\n",
    "    'avnir_collection': Collection(id='C1244141281-EEDTEST'),\n",
    "    'sentinel_collection': Collection(id='C1244141250-EEDTEST'),\n",
    "    'uavsar_collection': Collection(id='C1244141264-EEDTEST'),\n",
    "    'mur_collection': Collection(id='C1238621141-POCLOUD'),\n",
    "}\n",
    "\n",
    "collection_data = {\n",
    "    'https://harmony.uat.earthdata.nasa.gov': {\n",
    "        'env': Environment.UAT,\n",
    "        **non_production_collections,\n",
    "    },\n",
    "    'https://harmony.sit.earthdata.nasa.gov': {\n",
    "        'env': Environment.SIT,\n",
    "        **non_production_collections,\n",
    "    },\n",
    "    'http://localhost:3000': {'env': Environment.LOCAL, **non_production_collections},\n",
    "}\n",
    "\n",
    "environment_information = collection_data.get(harmony_host_url)\n",
    "\n",
    "if environment_information is not None:\n",
    "    harmony_client = Client(env=environment_information['env'])"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "85ae985d",
   "metadata": {},
   "source": [
    "## AVNIR\n",
    "\n",
    "The tests below will use the ALOS AVNIR OBS ORI collection (for UAT this is mirrored in the EEDTEST CMR environment). There are no reference images provided for this collection, as they would each be large (tens of MB).\n",
    "\n",
    "### AVNIR test case 1:\n",
    "\n",
    "This test case combines a bounding box spatial subset across the Equator with a variable subset for bands 1 and 2.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving 2 output bands."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "9b12328c",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1813212660-ASF', 'G1244144597-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_one = 'avnir_test_one'\n",
    "\n",
    "    avnir_request_one = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-51.0, -0.05, -50.75, 0.25),\n",
    "        variables=['Band1', 'Band2'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    avnir_output_one = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_one, avnir_directory_one\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_one = 'ALAV2A237403590-OORIRFU'\n",
    "\n",
    "    avnir_variables_one = {\n",
    "        f'IMG-01-{avnir_variable_base_one}_000_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_one}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_one = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 2,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 22N',\n",
    "        'proj_epsg': '32622',\n",
    "        'spatial_extent': [-0.05, 0.3, -50.99, -50.75],\n",
    "        'variables': avnir_variables_one,\n",
    "        'width': 3410,\n",
    "        'height': 3238,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_one[0], expected_avnir_results_one)\n",
    "    clean_test_artefacts(avnir_directory_one)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "aab35c49",
   "metadata": {},
   "source": [
    "### AVNIR test case 2:\n",
    "\n",
    "This test case combines a bounding box spatial subset across the Prime Meridian with a variable subset of bands 3 and 4.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving 2 output bands."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "81cd798f",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1817336128-ASF', 'G1244144599-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_two = 'avnir_test_two'\n",
    "\n",
    "    avnir_request_two = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-0.15, 14.8, 0.15, 14.9),\n",
    "        variables=['Band3', 'Band4'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    avnir_output_two = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_two, avnir_directory_two\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_two = 'ALAV2A264953300-OORIRFU'\n",
    "\n",
    "    avnir_variables_two = {\n",
    "        f'IMG-03-{avnir_variable_base_two}_000_band_1',\n",
    "        f'IMG-04-{avnir_variable_base_two}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_two = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 2,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 30N',\n",
    "        'proj_epsg': '32630',\n",
    "        'spatial_extent': [14.74, 14.96, -0.14, 0.14],\n",
    "        'variables': avnir_variables_two,\n",
    "        'width': 3392,\n",
    "        'height': 1762,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_two[0], expected_avnir_results_two)\n",
    "    clean_test_artefacts(avnir_directory_two)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1ae8879b",
   "metadata": {},
   "source": [
    "### AVNIR test case 3:\n",
    "\n",
    "This test combines a bounding box spatial subset across the anti-meridian with a variable subset for bands 1 and 2.  \n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving 2 output bands."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "61f13767",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1835935580-ASF', 'G1244144598-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_three = 'avnir_test_three'\n",
    "\n",
    "    avnir_request_three = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(179.75, 66.5, -179.85, 66.75),\n",
    "        variables=['Band1', 'Band2'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    avnir_output_three = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_three, avnir_directory_three\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_three = 'ALAV2A239652240-OORIRFU'\n",
    "\n",
    "    avnir_variables_three = {\n",
    "        f'IMG-01-{avnir_variable_base_three}_002_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_three}_002_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_three = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 2,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 1N',\n",
    "        'proj_epsg': '32601',\n",
    "        'spatial_extent': [66.44, 66.81, 179.85, -179.95],\n",
    "        'variables': avnir_variables_three,\n",
    "        'width': 2694,\n",
    "        'height': 3250,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_three[0], expected_avnir_results_three)\n",
    "    clean_test_artefacts(avnir_directory_three)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ec888af6",
   "metadata": {},
   "source": [
    "### AVNIR test case 4:\n",
    "\n",
    "This test case combines a bounding box spatial subset in the Northern Hemisphere with a variable subset requesting only band 4.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving 1 output band."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ff076e0b",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1849288272-ASF', 'G1244144595-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_four = 'avnir_test_four'\n",
    "\n",
    "    avnir_request_four = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-99.15, 36.9, -98.85, 37.1),\n",
    "        variables=['Band4'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    avnir_output_four = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_four, avnir_directory_four\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_four = 'ALAV2A278852850-OORIRFU'\n",
    "    avnir_variables_four = {f'IMG-04-{avnir_variable_base_four}_000_band_1'}\n",
    "\n",
    "    expected_avnir_results_four = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 14N',\n",
    "        'proj_epsg': '32614',\n",
    "        'spatial_extent': [36.85, 37.15, -99.13, -98.87],\n",
    "        'variables': avnir_variables_four,\n",
    "        'width': 3108,\n",
    "        'height': 2774,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_four[0], expected_avnir_results_four)\n",
    "    clean_test_artefacts(avnir_directory_four)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7d59241b",
   "metadata": {},
   "source": [
    "### AVNIR test case 5:\n",
    "\n",
    "This test case requests a bounding box spatial subsest in the Northern Hemisphere. No variable subset is specified, so the request will retrieve all variables.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving all variables and expect 4 output variables.\n",
    "This output is identical to the output if each band is requested e.g. adding `variables=['Band1','Band2', 'Band3', 'Band4']` to the Request.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d22ba7a1",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1849288272-ASF', 'G1244144595-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_five = 'avnir_test_five'\n",
    "\n",
    "    avnir_request_five = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-99.2, 36.95, -98.9, 37.05),\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    avnir_output_five = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_five, avnir_directory_five\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_five = 'ALAV2A278852850-OORIRFU'\n",
    "\n",
    "    avnir_variables_five = {\n",
    "        f'IMG-03-{avnir_variable_base_five}_000_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_five}_000_band_1',\n",
    "        f'IMG-04-{avnir_variable_base_five}_000_band_1',\n",
    "        f'IMG-01-{avnir_variable_base_five}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_five = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 14N',\n",
    "        'proj_epsg': '32614',\n",
    "        'spatial_extent': [36.9, 37.1, -99.18, -98.92],\n",
    "        'variables': avnir_variables_five,\n",
    "        'width': 2853,\n",
    "        'height': 1693,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_five[0], expected_avnir_results_five)\n",
    "    clean_test_artefacts(avnir_directory_five)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "94258b25",
   "metadata": {},
   "source": [
    "### AVNIR test case 6:\n",
    "\n",
    "This test combines a bounding box spatial subset in the Southern Hemisphere with a variable subset requesting bands 1 and 3 and specifies the height and width of the output bands.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving 2 output bands.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "a6cdb628",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1835549401-ASF', 'G1244144601-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_six = 'avnir_test_six'\n",
    "\n",
    "    avnir_request_six = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(18.07, -26.1, 18.25, -25.8),\n",
    "        variables=['Band1', 'Band3'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "        height=30,\n",
    "        width=75,\n",
    "    )\n",
    "\n",
    "    avnir_output_six = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_six, avnir_directory_six\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_six = 'ALAV2A151894120-OORIRFU'\n",
    "\n",
    "    avnir_variables_six = {\n",
    "        f'IMG-01-{avnir_variable_base_six}_000_band_1',\n",
    "        f'IMG-03-{avnir_variable_base_six}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_six = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 2,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 34S',\n",
    "        'proj_epsg': '32734',\n",
    "        'spatial_extent': [-26.13, -25.77, 18.07, 18.25],\n",
    "        'variables': avnir_variables_six,\n",
    "        'width': 75,\n",
    "        'height': 30,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_six[0], expected_avnir_results_six)\n",
    "    clean_test_artefacts(avnir_directory_six)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f7557e45",
   "metadata": {},
   "source": [
    "### AVNIR test case 7:\n",
    "\n",
    "This test combines a bounding box spatial subset (with negative longitude values) with all bands being explicitly specified alongside the height and width of the output array.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving all 4 output bands.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "0d5802e0",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1906378530-ASF', 'G1244144603-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_seven = 'avnir_test_seven'\n",
    "\n",
    "    avnir_request_seven = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-97.65, 49.65, -97.35, 49.95),\n",
    "        variables=['Band1', 'Band2', 'Band3', 'Band4'],\n",
    "        granule_id=granule_id,\n",
    "        height=45,\n",
    "        width=90,\n",
    "        format='image/tiff',\n",
    "    )\n",
    "\n",
    "    avnir_output_seven = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_seven, avnir_directory_seven\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_seven = 'ALAV2A277832590-OORIRFU'\n",
    "\n",
    "    avnir_variables_seven = {\n",
    "        f'IMG-01-{avnir_variable_base_seven}_000_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_seven}_000_band_1',\n",
    "        f'IMG-04-{avnir_variable_base_seven}_000_band_1',\n",
    "        f'IMG-03-{avnir_variable_base_seven}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_seven = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 14N',\n",
    "        'proj_epsg': '32614',\n",
    "        'spatial_extent': [49.6, 49.99, -97.64, -97.36],\n",
    "        'variables': avnir_variables_seven,\n",
    "        'width': 90,\n",
    "        'height': 45,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_seven[0], expected_avnir_results_seven)\n",
    "    clean_test_artefacts(avnir_directory_seven)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9409843c",
   "metadata": {},
   "source": [
    "### AVNIR test case 8:\n",
    "\n",
    "This test requests a bounding box spatial subset, where the bounding box is larger than granule itself. No variables are specified, meaning the request should return all variables.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are retrieving all 4 output bands."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "70eb75a2",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1813329318-ASF', 'G1244144596-EEDTEST'\n",
    "    )\n",
    "\n",
    "    avnir_directory_eight = 'avnir_test_eight'\n",
    "\n",
    "    avnir_request_eight = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        spatial=BBox(-79.9, 9.2, -78.9, 10.3),\n",
    "        granule_id=granule_id,\n",
    "        format='image/tiff',\n",
    "    )\n",
    "\n",
    "    avnir_output_eight = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_eight, avnir_directory_eight\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_eight = 'ALAV2A150623400-OORIRFU'\n",
    "\n",
    "    avnir_variables_eight = {\n",
    "        f'IMG-01-{avnir_variable_base_eight}_000_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_eight}_000_band_1',\n",
    "        f'IMG-04-{avnir_variable_base_eight}_000_band_1',\n",
    "        f'IMG-03-{avnir_variable_base_eight}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_eight = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 17N',\n",
    "        'proj_epsg': '32617',\n",
    "        'spatial_extent': [9.4, 10.24, -79.7, -79.2],\n",
    "        'variables': avnir_variables_eight,\n",
    "        'width': 7215,\n",
    "        'height': 8000,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_eight[0], expected_avnir_results_eight)\n",
    "    clean_test_artefacts(avnir_directory_eight)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "7adcc83a",
   "metadata": {},
   "source": [
    "### AVNIR test case 9:\n",
    "\n",
    "This test combines a bounding box spatial subset with a temporal range subset. All variables are explicitly specified. No granules are specified in this request, meaning the results will be determined by those granules that match the spatial and temporal criteria.\n",
    "\n",
    "The input `.zip` file contains 4 Image GeoTIFFs, one per band each representing a spectrum range. In this test, we are requesting \"all\" variables and expecting to retrieve all 4 output bands.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "8d252736",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    avnir_directory_nine = 'avnir_test_nine'\n",
    "\n",
    "    avnir_request_nine = Request(\n",
    "        collection=environment_information['avnir_collection'],\n",
    "        variables=['all'],\n",
    "        spatial=BBox(18.4, -26.1, 18.6, -26.0),\n",
    "        format='image/tiff',\n",
    "    )\n",
    "\n",
    "    avnir_output_nine = make_request_and_download_result(\n",
    "        harmony_client, avnir_request_nine, avnir_directory_nine\n",
    "    )\n",
    "\n",
    "    avnir_variable_base_nine = 'ALAV2A151894120-OORIRFU'\n",
    "\n",
    "    avnir_variables_nine = {\n",
    "        f'IMG-01-{avnir_variable_base_nine}_000_band_1',\n",
    "        f'IMG-02-{avnir_variable_base_nine}_000_band_1',\n",
    "        f'IMG-03-{avnir_variable_base_nine}_000_band_1',\n",
    "        f'IMG-04-{avnir_variable_base_nine}_000_band_1',\n",
    "    }\n",
    "\n",
    "    expected_avnir_results_nine = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Projected',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': 'WGS 84 / UTM zone 34S',\n",
    "        'proj_epsg': '32734',\n",
    "        'spatial_extent': [-26.13, -25.96, 18.41, 18.59],\n",
    "        'variables': avnir_variables_nine,\n",
    "        'width': 2195,\n",
    "        'height': 1516,\n",
    "    }\n",
    "\n",
    "    check_request_output(avnir_output_nine[0], expected_avnir_results_nine)\n",
    "    clean_test_artefacts(avnir_directory_nine)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "d6dde860",
   "metadata": {},
   "source": [
    "## Sentinel 1 Interferograms:\n",
    "\n",
    "The tests below will use the Sentinel 1 Interferograms collection (for UAT this is mirrored in the EEDTEST CMR environment).\n",
    "\n",
    "### Sentinel test case 1:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/amplitude`). The input NetCDF-4 file contains many variables (in a hierarchical structure).\n",
    "\n",
    "The output NetCDF-4 file is expected to have one band per requested variable, alongside coordinate variables. This leads to 4 total output variables (`amplitude`, `lat`, `lon`, `latitude_longitude`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "8b999881",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1715962900-ASF', 'G1244144618-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_one = 'sentinel_test_one'\n",
    "\n",
    "    sentinel_request_one = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-115.5, 33, -115.25, 33.1),\n",
    "        variables=['science/grids/data/amplitude'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_one = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_one, sentinel_directory_one\n",
    "    )\n",
    "\n",
    "    sentinel_variables_one = {'amplitude', 'lat', 'lon', 'latitude_longitude'}\n",
    "\n",
    "    expected_sentinel_results_one = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_one.nc',\n",
    "        'spatial_extent': [33.0, 33.1, -115.5, -115.25],\n",
    "        'variables': sentinel_variables_one,\n",
    "        'width': 300,\n",
    "        'height': 120,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_one[0], expected_sentinel_results_one)\n",
    "    clean_test_artefacts(sentinel_directory_one)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "47da7fad",
   "metadata": {},
   "source": [
    "### Sentinel test case 2:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/coherence`). The output format will be GeoTIFF.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output GeoTIFF is expected to have one band per requested variable, this leads to 1 total output bands."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "5c5ddeca",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1944514838-ASF', 'G1244144611-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_two = 'sentinel_test_two'\n",
    "\n",
    "    sentinel_request_two = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(37.25, 26.95, 38.15, 27.25),\n",
    "        variables=['science/grids/data/coherence'],\n",
    "        granule_id=granule_id,\n",
    "        format='image/tiff',\n",
    "    )\n",
    "\n",
    "    sentinel_output_two = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_two, sentinel_directory_two\n",
    "    )\n",
    "\n",
    "    sentinel_variables_two = {\n",
    "        (\n",
    "            'S1-GUNW-A-R-014-tops-20191127_20191115-153047-28315N_26592N-PP-8a6f-v2_0_3_'\n",
    "            'science_grids_data_coherence_subsetted__science_grids_data_coherence__subsetted_band_1'\n",
    "        )\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_two = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_two.tiff',\n",
    "        'spatial_extent': [26.95, 27.25, 37.25, 38.15],\n",
    "        'variables': sentinel_variables_two,\n",
    "        'width': 1080,\n",
    "        'height': 360,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_two[0], expected_sentinel_results_two)\n",
    "    clean_test_artefacts(sentinel_directory_two)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "351a6e68",
   "metadata": {},
   "source": [
    "### Sentinel test case 3:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/connectedComponents`). \n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output NetCDF-4 is expected to have one band per requested variable, alongside coordinate variables. This leads to 4 total output variables (`connectedComponents`, `lat`, `lon`, `latitude_longitude`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "66907e2c",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1944514838-ASF', 'G1244144611-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_three = 'sentinel_test_three'\n",
    "\n",
    "    sentinel_request_three = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(37.5, 27.0, 38.25, 27.5),\n",
    "        variables=['science/grids/data/connectedComponents'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_three = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_three, sentinel_directory_three\n",
    "    )\n",
    "\n",
    "    sentinel_variables_three = {\n",
    "        'connectedComponents',\n",
    "        'lat',\n",
    "        'lon',\n",
    "        'latitude_longitude',\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_three = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_three.nc',\n",
    "        'spatial_extent': [27.0, 27.5, 37.5, 38.25],\n",
    "        'variables': sentinel_variables_three,\n",
    "        'width': 900,\n",
    "        'height': 600,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_three[0], expected_sentinel_results_three)\n",
    "    clean_test_artefacts(sentinel_directory_three)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "9fb1516b",
   "metadata": {},
   "source": [
    "### Sentinel test case 4:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/unwrappedPhase`). The input NetCDF-4 file contains many variables (in a hierarchical structure).\n",
    "\n",
    "The output NetCDF-4 is expected to have one band per requested variable, alongside coordinate variables. This leads to 4 total output variables (`unwrappedPhase`, `lat`, `lon`, and `latitude_longitude`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "7ab215b0",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1944514838-ASF', 'G1244144611-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_four = 'sentinel_test_four'\n",
    "\n",
    "    sentinel_request_four = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(36.9, 26.9, 39.1, 27.5),\n",
    "        variables=['science/grids/data/unwrappedPhase'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_four = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_four, sentinel_directory_four\n",
    "    )\n",
    "\n",
    "    sentinel_base_variable_four = (\n",
    "        'S1_GUNW_A_R_014_tops_20191127_20191115_153047_28315N_26592N_PP_8a6f_v2_0_3_'\n",
    "        'science_grids_data_unwrappedPhase_subsetted__'\n",
    "        'science_grids_data_unwrappedPhase__colored_band'\n",
    "    )\n",
    "\n",
    "    sentinel_variables_four = {'unwrappedPhase', 'lat', 'lon', 'latitude_longitude'}\n",
    "\n",
    "    expected_sentinel_results_four = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_four.nc',\n",
    "        'spatial_extent': [26.9, 27.5, 36.9, 39.1],\n",
    "        'variables': sentinel_variables_four,\n",
    "        'width': 2640,\n",
    "        'height': 720,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_four[0], expected_sentinel_results_four)\n",
    "    clean_test_artefacts(sentinel_directory_four)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "908e1d2c",
   "metadata": {},
   "source": [
    "### Sentinel test case 5:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/amplitude` and `/science/grids/data/coherence`). Additionally, the height and width of the output variables are specified.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure).\n",
    "\n",
    "The output NetCDF-4 is expected to have one band per requested variable, alongside coordinate variables. This leads to 5 total output variables (`amplitude` and `coherence`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "9007e615",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1715962900-ASF', 'G1244144618-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_five = 'sentinel_test_five'\n",
    "\n",
    "    sentinel_request_five = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-115.5, 33, -115.25, 33.1),\n",
    "        variables=['science/grids/data/amplitude', 'science/grids/data/coherence'],\n",
    "        granule_id=granule_id,\n",
    "        height=60,\n",
    "        width=150,\n",
    "    )\n",
    "\n",
    "    sentinel_output_five = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_five, sentinel_directory_five\n",
    "    )\n",
    "\n",
    "    sentinel_variables_five = {\n",
    "        'amplitude',\n",
    "        'coherence',\n",
    "        'lat',\n",
    "        'lon',\n",
    "        'latitude_longitude',\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_five = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 5,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_five.nc',\n",
    "        'spatial_extent': [33.0, 33.1, -115.5, -115.25],\n",
    "        'variables': sentinel_variables_five,\n",
    "        'width': 150,\n",
    "        'height': 60,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_five[0], expected_sentinel_results_five)\n",
    "    clean_test_artefacts(sentinel_directory_five)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "864fec93",
   "metadata": {},
   "source": [
    "### Sentinel test case 6:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/amplitude`, `/science/grids/data/coherence` and `/science/grids/data/connectedComponents`). Additionally, the height and width of the output variables are specified.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output NetCDF-4 is expected to have one band per requested variable, alongside coordinate variables. This leads to 6 total output variables (`amplitude`, `coherence` and `connectedComponents`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "146f0592",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1715962900-ASF', 'G1244144618-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_six = 'sentinel_test_six'\n",
    "\n",
    "    sentinel_request_six = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-115.52, 33.05, -115.27, 33.1),\n",
    "        variables=[\n",
    "            'science/grids/data/amplitude',\n",
    "            'science/grids/data/coherence',\n",
    "            'science/grids/data/connectedComponents',\n",
    "        ],\n",
    "        granule_id=granule_id,\n",
    "        height=30,\n",
    "        width=75,\n",
    "    )\n",
    "\n",
    "    sentinel_output_six = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_six, sentinel_directory_six\n",
    "    )\n",
    "\n",
    "    sentinel_variables_six = {\n",
    "        'amplitude',\n",
    "        'coherence',\n",
    "        'connectedComponents',\n",
    "        'lat',\n",
    "        'lon',\n",
    "        'latitude_longitude',\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_six = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 6,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_six.nc',\n",
    "        'spatial_extent': [33.05, 33.1, -115.52, -115.27],\n",
    "        'variables': sentinel_variables_six,\n",
    "        'width': 75,\n",
    "        'height': 30,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_six[0], expected_sentinel_results_six)\n",
    "    clean_test_artefacts(sentinel_directory_six)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "bd78003c",
   "metadata": {},
   "source": [
    "### Sentinel test case 7:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`/science/grids/data/amplitude`, `/science/grids/data/coherence`, `/science/grids/data/connectedComponents` and `/science/grids/data/unwrappedPhase`).\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output is expected to have one band per requested variable, alongside coordinate variables. This leads to 7 total output variables (`amplitude`, `coherence`, `connectedComponents` and `unwrappedPhase`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "077d70f5",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1715962900-ASF', 'G1244144618-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_seven = 'sentinel_test_seven'\n",
    "\n",
    "    sentinel_request_seven = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-115.45, 32.95, -115.15, 33.09),\n",
    "        variables=[\n",
    "            'science/grids/data/amplitude',\n",
    "            'science/grids/data/coherence',\n",
    "            'science/grids/data/connectedComponents',\n",
    "            'science/grids/data/unwrappedPhase',\n",
    "        ],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_seven = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_seven, sentinel_directory_seven\n",
    "    )\n",
    "\n",
    "    sentinel_variables_seven = {\n",
    "        'amplitude',\n",
    "        'coherence',\n",
    "        'connectedComponents',\n",
    "        'unwrappedPhase',\n",
    "        'lat',\n",
    "        'lon',\n",
    "        'latitude_longitude',\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_seven = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 7,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_seven.nc',\n",
    "        'spatial_extent': [32.95, 33.09, -115.45, -115.15],\n",
    "        'variables': sentinel_variables_seven,\n",
    "        'width': 360,\n",
    "        'height': 168,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_seven[0], expected_sentinel_results_seven)\n",
    "    clean_test_artefacts(sentinel_directory_seven)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "841929a6",
   "metadata": {},
   "source": [
    "### Sentinel test case 8:\n",
    "\n",
    "This test combines a bounding box spatial subset in the Southern Hemisphere (negative latitudes and longitudes) with a variable subset (`/science/grids/data/amplitude`). The bounding box is smaller than the extent of the input granule.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output is expected to have one band per requested variable, alongside coordinate variables. This leads to 4 total output variables (`amplitude`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d4a9efc1",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1697222082-ASF', 'G1244144612-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_eight = 'sentinel_test_eight'\n",
    "\n",
    "    sentinel_request_eight = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-69.8, -37.2, -68.8, -36.9),\n",
    "        variables=['science/grids/data/amplitude'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_eight = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_eight, sentinel_directory_eight\n",
    "    )\n",
    "\n",
    "    sentinel_variables_eight = {'amplitude', 'lat', 'lon', 'latitude_longitude'}\n",
    "\n",
    "    expected_sentinel_results_eight = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_eight.nc',\n",
    "        'spatial_extent': [-37.2, -36.9, -69.8, -68.8],\n",
    "        'variables': sentinel_variables_eight,\n",
    "        'width': 1200,\n",
    "        'height': 360,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_eight[0], expected_sentinel_results_eight)\n",
    "    clean_test_artefacts(sentinel_directory_eight)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "c689d053",
   "metadata": {},
   "source": [
    "### Sentinel test case 9:\n",
    "\n",
    "This test combines a bounding box spatial subset in the Southern Hemisphere (negative latitudes and longitudes) with a variable subset (`/science/grids/data/coherence`). The bounding box is larger than the extent of the input granule.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output is expected to have one band per requested variable, alongside coordinate variables. This leads to 4 total output variables (`coherence`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "e10f5d2c",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1697222082-ASF', 'G1244144612-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_nine = 'sentinel_test_nine'\n",
    "\n",
    "    sentinel_request_nine = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-71.6, -39.0, -67.5, -35.0),\n",
    "        variables=['science/grids/data/coherence'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_nine = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_nine, sentinel_directory_nine\n",
    "    )\n",
    "\n",
    "    sentinel_variables_nine = {'coherence', 'lat', 'lon', 'latitude_longitude'}\n",
    "\n",
    "    expected_sentinel_results_nine = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 4,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_nine.nc',\n",
    "        'spatial_extent': [-38.14, -36.0, -71.41, -67.96],\n",
    "        'variables': sentinel_variables_nine,\n",
    "        'width': 4143,\n",
    "        'height': 2559,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_nine[0], expected_sentinel_results_nine)\n",
    "    clean_test_artefacts(sentinel_directory_nine)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "46a9f5c8",
   "metadata": {},
   "source": [
    "### Sentinel test case 10:\n",
    "\n",
    "This test combines a bounding box spatial subset of China with a variable subset (`/science/grids/data/coherence` and `/science/grids/data/unwrappedPhase`). The bounding box is smaller than the extent of the input granule.\n",
    "\n",
    "The input NetCDF-4 file contains many variables (in a hierarchical structure). The output is expected to have one band per requested variable, alongside coordinate variables. This leads to 5 total output variables (`coherence` and `unwrappedPhase`, `latitude`, `longitude` and `CRS`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "03327e0c",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1722540208-ASF', 'G1244144616-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_directory_ten = 'sentinel_test_ten'\n",
    "\n",
    "    sentinel_request_ten = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(86.85, 43.75, 88.15, 44.85),\n",
    "        variables=['science/grids/data/coherence', 'science/grids/data/unwrappedPhase'],\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    sentinel_output_ten = make_request_and_download_result(\n",
    "        harmony_client, sentinel_request_ten, sentinel_directory_ten\n",
    "    )\n",
    "\n",
    "    sentinel_variables_ten = {\n",
    "        'coherence',\n",
    "        'unwrappedPhase',\n",
    "        'lat',\n",
    "        'lon',\n",
    "        'latitude_longitude',\n",
    "    }\n",
    "\n",
    "    expected_sentinel_results_ten = {\n",
    "        'authority': None,\n",
    "        'cs': None,\n",
    "        'gcs': None,\n",
    "        'gcs_epsg': None,\n",
    "        'n_bands': 5,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/sentinel_reference_ten.nc',\n",
    "        'spatial_extent': [43.75, 44.85, 86.85, 88.15],\n",
    "        'variables': sentinel_variables_ten,\n",
    "        'width': 1560,\n",
    "        'height': 1320,\n",
    "    }\n",
    "\n",
    "    check_request_output(sentinel_output_ten[0], expected_sentinel_results_ten)\n",
    "    clean_test_artefacts(sentinel_directory_ten)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "788f22ac",
   "metadata": {},
   "source": [
    "### Sentinel test case 11:\n",
    "\n",
    "The Sentinel data has 7 variables with two different sets of grid sizes. This test requests a bounding box spatial subset while specifying two variables with different grids. This leads to a request that cannot be fulfilled by HGA and an exception should be raised. The internal exception type is an `IncompatibleVariableError`, which can be identified via the string reported to the end-user."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "cec9b4ba",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1715962900-ASF', 'G1244144618-EEDTEST'\n",
    "    )\n",
    "\n",
    "    sentinel_request_thirteen = Request(\n",
    "        collection=environment_information['sentinel_collection'],\n",
    "        spatial=BBox(-115.45, 32.95, -115.15, 33.09),\n",
    "        granule_id=granule_id,\n",
    "        ignore_errors=False,\n",
    "        variables=[\n",
    "            'science/grids/data/amplitude',\n",
    "            'science/grids/imagingGeometry/azimuthAngle',\n",
    "        ],\n",
    "    )\n",
    "\n",
    "    sentinel_job_id_thirteen = harmony_client.submit(sentinel_request_thirteen)\n",
    "    try:\n",
    "        harmony_client.wait_for_processing(sentinel_job_id_thirteen, show_progress=True)\n",
    "    except Exception as exception:\n",
    "        assert 'datasets are incompatible and cannot be combined' in str(\n",
    "            exception\n",
    "        ), 'Exception not raised correctly'\n",
    "    print_success('Test raised expected Exception')\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ccc0d161",
   "metadata": {},
   "source": [
    "## UAVSAR POLSAR Pauli\n",
    "\n",
    "The tests below will use the UAVSAR POLSAR Pauli collection (for UAT this is mirrored in the EEDTEST CMR environment).\n",
    "\n",
    "The UAVSAR POLSAR data consists of 3 variables of data where each band represents a science variable (e.g., \"HH minus VV, Red Band\", \"HV,Green Band\" and \"HH plus VV, Blue Band\").\n",
    "\n",
    "### UAVSAR test case 1:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`Band1`).\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "3e98098b",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1422449017-ASF', 'G1244144733-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_one = 'uavsar_test_one'\n",
    "\n",
    "    uavsar_request_one = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-145.75, 64.0, -145.70, 64.1),\n",
    "        variables=['Band1'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_one = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_one, uavsar_directory_one\n",
    "    )\n",
    "\n",
    "    uavsar_variable_base_one = 'djNEON_00101_17095_012_170910_L090_CX_01_pauli_Band1_subsetted__Band1__subsetted_band'\n",
    "\n",
    "    uavsar_variables_one = {f'{uavsar_variable_base_one}_1'}\n",
    "\n",
    "    expected_uavsar_results_one = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_one.tiff',\n",
    "        'spatial_extent': [64.0, 64.1, -145.75, -145.7],\n",
    "        'variables': uavsar_variables_one,\n",
    "        'width': 450,\n",
    "        'height': 1800,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_one[0], expected_uavsar_results_one)\n",
    "    clean_test_artefacts(uavsar_directory_one)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "626236d0",
   "metadata": {},
   "source": [
    "### UAVSAR test case 2:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`Band2`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "c11c753a",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1422449017-ASF', 'G1244144733-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_two = 'uavsar_test_two'\n",
    "\n",
    "    uavsar_request_two = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-145.9, 63.75, -145.8, 63.80),\n",
    "        variables=['Band2'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_two = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_two, uavsar_directory_two\n",
    "    )\n",
    "\n",
    "    uavsar_variables_two = {\n",
    "        'djNEON_00101_17095_012_170910_L090_CX_01_pauli_Band2_subsetted__Band2__subsetted_band_1'\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_two = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_two.tiff',\n",
    "        'spatial_extent': [63.75, 63.80, -145.9, -145.8],\n",
    "        'variables': uavsar_variables_two,\n",
    "        'width': 900,\n",
    "        'height': 900,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_two[0], expected_uavsar_results_two)\n",
    "    clean_test_artefacts(uavsar_directory_two)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ce1a1897",
   "metadata": {},
   "source": [
    "### UAVSAR test case 3:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`Band3`).\n",
    "\n",
    "Each input variable for the UAVSAR POLSAR Pauli collection is a science variable (e.g., \"HH - VV\")."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "24b33c39",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1422449017-ASF', 'G1244144733-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_three = 'uavsar_test_three'\n",
    "\n",
    "    uavsar_request_three = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-145.85, 63.85, -145.80, 63.90),\n",
    "        variables=['Band3'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_three = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_three, uavsar_directory_three\n",
    "    )\n",
    "\n",
    "    uavsar_variables_three = {\n",
    "        'djNEON_00101_17095_012_170910_L090_CX_01_pauli_Band3_subsetted__Band3__subsetted_band_1'\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_three = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_three.tiff',\n",
    "        'spatial_extent': [63.85, 63.90, -145.85, -145.80],\n",
    "        'variables': uavsar_variables_three,\n",
    "        'width': 450,\n",
    "        'height': 900,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_three[0], expected_uavsar_results_three)\n",
    "    clean_test_artefacts(uavsar_directory_three)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "6b266d24",
   "metadata": {},
   "source": [
    "### UAVSAR test case 4:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset for multiple variables (`Band1` and `Band2`).\n",
    "\n",
    "Each input variable for the UAVSAR POLSAR Pauli collection is a science variable (e.g., \"HH - VV\") this test requests 2 bands. "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "d1d478b2",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1366089385-ASF', 'G1244144737-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_four = 'uavsar_test_four'\n",
    "\n",
    "    uavsar_request_four = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-123.39, 40.05, -123.34, 40.06),\n",
    "        variables=['Band1', 'Band2'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_four = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_four, uavsar_directory_four\n",
    "    )\n",
    "\n",
    "    uavsar_variables_four = {\n",
    "        'eelriv_06508_16103_002_161206_L090_CX_02_pauli_subsetted__Band1__subsetted_band_1',\n",
    "        'eelriv_06508_16103_002_161206_L090_CX_02_pauli_subsetted__Band2__subsetted_band_1',\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_four = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 2,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_four.tiff',\n",
    "        'spatial_extent': [40.05, 40.06, -123.39, -123.34],\n",
    "        'variables': uavsar_variables_four,\n",
    "        'width': 900,\n",
    "        'height': 180,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_four[0], expected_uavsar_results_four)\n",
    "    clean_test_artefacts(uavsar_directory_four)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "4c109f01",
   "metadata": {},
   "source": [
    "### UAVSAR test case 5:\n",
    "\n",
    "This test performs a bounding box spatial subset, while requesting all variables.\n",
    "\n",
    "Each input variable for the UAVSAR POLSAR Pauli collection is a science variable (e.g., \\\"HH - VV\\\"), so the output is expected to have a total of 3 bands (1 each for `Band1`, `Band2` and `Band3`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "54283a29",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1366089385-ASF', 'G1244144737-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_five = 'uavsar_test_five'\n",
    "\n",
    "    uavsar_request_five = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-123.69, 39.95, -123.59, 40.0),\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_five = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_five, uavsar_directory_five\n",
    "    )\n",
    "\n",
    "    uavsar_variables_five = {\n",
    "        'eelriv_06508_16103_002_161206_L090_CX_02_pauli_subsetted__all__subsetted_band_1',\n",
    "        'eelriv_06508_16103_002_161206_L090_CX_02_pauli_subsetted__all__subsetted_band_2',\n",
    "        'eelriv_06508_16103_002_161206_L090_CX_02_pauli_subsetted__all__subsetted_band_3',\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_five = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 3,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_five.tiff',\n",
    "        'spatial_extent': [39.95, 40.0, -123.69, -123.59],\n",
    "        'variables': uavsar_variables_five,\n",
    "        'width': 1800,\n",
    "        'height': 900,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_five[0], expected_uavsar_results_five)\n",
    "    clean_test_artefacts(uavsar_directory_five)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "b1f9ca99",
   "metadata": {},
   "source": [
    "### UAVSAR test case 6:\n",
    "\n",
    "This test performs a bounding box spatial subset that crosses the Equator, while explicitly requesting all variables by identifier \"all\".\n",
    "\n",
    "Each band in the UAVSAR POLSAR Pauli collection is a science variable (e.g., \"HH - VV\") so the output is expected to have 3 bands (1 each for `Band1`, `Band2` and `Band3`)."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "75d42d47",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1232482059-ASF', 'G1244144732-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_six = 'uavsar_test_six'\n",
    "\n",
    "    uavsar_request_six = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        variables=['all'],\n",
    "        spatial=BBox(11.57, -0.03, 11.60, 0.02),\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_six = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_six, uavsar_directory_six\n",
    "    )\n",
    "\n",
    "    uavsar_base_six = (\n",
    "        'eighty_14047_16008_006_160225_L090_CX_01_pauli_subsetted__all__subsetted'\n",
    "    )\n",
    "\n",
    "    uavsar_variables_six = {\n",
    "        f'{uavsar_base_six}_band_1',\n",
    "        f'{uavsar_base_six}_band_2',\n",
    "        f'{uavsar_base_six}_band_3',\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_six = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 3,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_six.tiff',\n",
    "        'spatial_extent': [-0.03, 0.02, 11.57, 11.60],\n",
    "        'variables': uavsar_variables_six,\n",
    "        'width': 540,\n",
    "        'height': 900,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_six[0], expected_uavsar_results_six)\n",
    "    clean_test_artefacts(uavsar_directory_six)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "8fe348ab",
   "metadata": {},
   "source": [
    "### UAVSAR test case 7:\n",
    "\n",
    "This test performs a bounding box spatial subset in the Northern Hemisphere, explicitly requesting a bounding box that is larger than the input granule extent. To limit the size of the reference image stored in the repository, the request specifies a variable subset for only `Band1`, and the output dimensions are specified to be coarser resolution than the input granule.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ed0785ab",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1402334529-ASF', 'G1244144730-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_seven = 'uavsar_test_seven'\n",
    "\n",
    "    uavsar_request_seven = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        variables=['Band1'],\n",
    "        spatial=BBox(-139, 61, -137, 62),\n",
    "        format='image/tiff',\n",
    "        height=870,\n",
    "        width=1129,\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_seven = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_seven, uavsar_directory_seven\n",
    "    )\n",
    "\n",
    "    uavsar_variables_seven = {\n",
    "        'kluane_01902_17064_005_170615_L090_CX_01_pauli_Band1_regridded_subsetted__Band1__resized_band_1'\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_seven = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_seven.tiff',\n",
    "        'spatial_extent': [61.57, 61.76, -138.36, -137.85],\n",
    "        'variables': uavsar_variables_seven,\n",
    "        'width': 1129,\n",
    "        'height': 870,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_seven[0], expected_uavsar_results_seven)\n",
    "    clean_test_artefacts(uavsar_directory_seven)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "661efddb",
   "metadata": {},
   "source": [
    "### UAVSAR test case 8:\n",
    "\n",
    "This test combines a bounding box spatial subset with a variable subset (`Band2`). The bounding box extends past the western bound of the input granule extent.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "ac2b6077",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    granule_id = get_test_granule_id(\n",
    "        environment_information['env'], 'G1223713114-ASF', 'G1244144731-EEDTEST'\n",
    "    )\n",
    "\n",
    "    uavsar_directory_eight = 'uavsar_test_eight'\n",
    "\n",
    "    uavsar_request_eight = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        spatial=BBox(-72.3, -40.02, -72.0, -40.0),\n",
    "        variables=['Band2'],\n",
    "        format='image/tiff',\n",
    "        granule_id=granule_id,\n",
    "    )\n",
    "\n",
    "    uavsar_output_eight = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_eight, uavsar_directory_eight\n",
    "    )\n",
    "\n",
    "    uavsar_variables_eight = {\n",
    "        'ChiVol_00700_15030_010_150330_L090_CX_01_pauli_Band2_subsetted__Band2__subsetted_band_1'\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_eight = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 1,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_eight.tiff',\n",
    "        'spatial_extent': [-40.02, -40.0, -72.17, -72.0],\n",
    "        'variables': uavsar_variables_eight,\n",
    "        'width': 3004,\n",
    "        'height': 360,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_eight[0], expected_uavsar_results_eight)\n",
    "    clean_test_artefacts(uavsar_directory_eight)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ea022ee8",
   "metadata": {},
   "source": [
    "### UAVSAR test case 9:\n",
    "\n",
    "This test combines a bounding box spatial subset with a temporal subset. All three variables are explicitly listed in the request. The temporal subset should return only a single granule, and apply the spatial and variable subset to that granule."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "858d8e03",
   "metadata": {},
   "outputs": [],
   "source": [
    "if environment_information is not None:\n",
    "    uavsar_directory_nine = 'uavsar_test_nine'\n",
    "\n",
    "    uavsar_request_nine = Request(\n",
    "        collection=environment_information['uavsar_collection'],\n",
    "        variables=['all'],\n",
    "        spatial=BBox(-89.02, 28.98, -89.00, 29.00),\n",
    "        temporal={\n",
    "            'start': datetime(2016, 11, 17, 23, 27, 0),\n",
    "            'stop': datetime(2016, 11, 17, 23, 28, 0),\n",
    "        },\n",
    "        format='image/tiff',\n",
    "    )\n",
    "\n",
    "    uavsar_output_nine = make_request_and_download_result(\n",
    "        harmony_client, uavsar_request_nine, uavsar_directory_nine\n",
    "    )\n",
    "\n",
    "    uavsar_variables_nine = {\n",
    "        'gulfco_27086_16101_004_161117_L090_CX_01_pauli_subsetted__all__subsetted_band_1',\n",
    "        'gulfco_27086_16101_004_161117_L090_CX_01_pauli_subsetted__all__subsetted_band_2',\n",
    "        'gulfco_27086_16101_004_161117_L090_CX_01_pauli_subsetted__all__subsetted_band_3',\n",
    "    }\n",
    "\n",
    "    expected_uavsar_results_nine = {\n",
    "        'authority': 'EPSG',\n",
    "        'cs': 'Geographic',\n",
    "        'gcs': 'WGS 84',\n",
    "        'gcs_epsg': '4326',\n",
    "        'n_bands': 3,\n",
    "        'proj_cs': None,\n",
    "        'proj_epsg': None,\n",
    "        'reference_image': 'reference_images/uavsar_reference_nine.tiff',\n",
    "        'spatial_extent': [28.98, 29.00, -89.02, -89.00],\n",
    "        'variables': uavsar_variables_nine,\n",
    "        'width': 360,\n",
    "        'height': 360,\n",
    "    }\n",
    "\n",
    "    check_request_output(uavsar_output_nine[0], expected_uavsar_results_nine)\n",
    "    clean_test_artefacts(uavsar_directory_nine)\n",
    "else:\n",
    "    print('Skipping test: HGA regression tests not configured for this environment.')"
   ]
  }
 ],
 "metadata": {
  "celltoolbar": "Tags",
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "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.9.20"
  },
  "name": "HGA_Regression.ipynb"
 },
 "nbformat": 4,
 "nbformat_minor": 5
}