Update viz doc to clarify its current status (partial functionality - incompatible with OA API changes)

doc/source/example_notebooks/IS2_data_visualization.ipynb

@@ -7,7 +7,14 @@
    "source": [
     "# Visualizing ICESat-2 Elevations\n",
     "\n",
-    "This notebook ({nb-download}`download <IS2_data_visualization.ipynb>`) demonstrates interactive ICESat-2 elevation visualization by requesting data from [OpenAltimetry](https://www.openaltimetry.org/) based on metadata provided by [icepyx](https://icepyx.readthedocs.io/en/latest/). We will show how to plot spatial extent and elevation interactively. "
+    "This notebook ({nb-download}`download <IS2_data_visualization.ipynb>`) demonstrates interactive ICESat-2 elevation visualization by requesting data from [OpenAltimetry](https://www.openaltimetry.org/) based on metadata provided by [icepyx](https://icepyx.readthedocs.io/en/latest/). We will show how to plot spatial extent and elevation interactively.\n",
+    "\n",
+    "> ⚠️ **Some of this notebook is currently non-functional**\n",
+    ">\n",
+    "> Visualizations requiring the\n",
+    "> [OpenAltimetry API](https://openaltimetry.earthdatacloud.nasa.gov/data/openapi/swagger-ui/index.html)\n",
+    "> are currently unavailable (since ~October 2023).\n",
+    "> The API changed and we haven't yet updated this notebook correspondingly."
    ]
   },
   {
@@ -33,7 +40,7 @@
    "id": "57f2cfd8",
    "metadata": {},
    "source": [
-    "Create an ICESat-2 query object\n",
+    "## Create an ICESat-2 query object\n",
     "\n",
     "Set the desired parameters for your data visualization.\n",
     "\n",
@@ -148,6 +155,7 @@
    "execution_count": null,
    "id": "93a712af-ab1f-4d79-834d-c2735a5677a8",
    "metadata": {
+    "scrolled": true,
     "tags": []
    },
    "outputs": [],
@@ -222,16 +230,16 @@
     "### Alternative Access Options to Visualize ICESat-2 elevation using OpenAltimetry API\n",
     "\n",
     "You can also view elevation data by importing the visualization module directly and initializing it with your query object or a list of parameters:\n",
-    " ```\n",
+    " ```python\n",
     " from icepyx.core.visualization import Visualize\n",
     " ```\n",
     " - passing your query object directly to the visualization module\n",
-    " ```\n",
+    " ```python\n",
     " region2 = ipx.Query(short_name, spatial_extent, date_range)\n",
     " vis = Visualize(region2)\n",
     " ```\n",
     " - creating a visualization object directly without first creating a query object\n",
-    " ```\n",
+    " ```python\n",
     " vis = Visualize(product=short_name, spatial_extent=spatial_extent, date_range=date_range)\n",
     " ```"
    ]
@@ -264,7 +272,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.12.4"
   }
  },
  "nbformat": 4,

icepyx/core/visualization.py

@@ -312,7 +312,13 @@
         --------
         request_OA_data
         """
-        return requests.get(base_url, params=payload)
+        response = requests.get(base_url, params=payload)
+        if not response.ok:
+            raise RuntimeError(
+                f"Status {response.status_code} requesting url {response.request.url}"
+            )
+
+        return response
 
     def request_OA_data(self, paras) -> da.array:
         """
@@ -331,9 +337,8 @@
         """
 
         warnings.warn(
-            "NOTICE: visualizations requiring the OpenAltimetry API are currently (October 2023) "
-            "unavailable while hosting of OpenAltimetry transitions from UCSD to NSIDC."
-            "A ticket has been issued to restore programmatic API access."
+            "NOTICE: visualizations requiring the OpenAltimetry API are currently"
+            " (August 2024) unavailable until we can adapt to API changes."
         )
 
         base_url = "http://openaltimetry.earthdatacloud.nasa.gov/data/api/icesat2"