Apply final review changes to GTSMip notebook

Apply final review changes to GTSMip notebook

Author: nicrie

gtsmip-water-levels.ipynb

@@ -41,7 +41,7 @@
    "source": [
     "This notebook provides a practical introduction on how to access, visualize and analyse [GTSMip tide and surge water level timeseries](https://cds.climate.copernicus.eu/datasets/sis-water-level-change-timeseries-cmip6?tab=overview) data available in the Climate Data Store (CDS) of the Copernicus Climate Change Service (C3S), developed by Deltares in order to accompany the dataset. This data is the output of the the global tide and surge model [GTSMv3.0](https://www.deltares.nl/en/expertise/projects/global-modelling-of-tides-and-storm-surges). \n",
     "\n",
-    "The GTSMip dataset on CDS includes total water level, surge and tidal elevation timeseries, as well as annual mean sea level values (based on sea level rise projections). Next to the reanalysis data forced with ERA5, also model timeseries forced with several high-resolution climate models (HighResMIP) are available for the period of 1950 to 2050. The timeseries are available for a large number of offshore and coastal locations (over 43.000 locations globally). For more information on the full dataset, please refer to the [Product User Guide](https://cds.climate.copernicus.eu/datasets/sis-water-level-change-timeseries-cmip6?tab=documentation).\n",
+    "The GTSMip dataset on CDS includes total water level, surge and tidal elevation timeseries, as well as annual mean sea level values (based on sea level rise projections). Next to the reanalysis data forced with [ERA5](https://cds.climate.copernicus.eu/datasets/reanalysis-era5-single-levels?tab=overview), also model timeseries forced with several high-resolution climate models (HighResMIP) are available for the period of 1950 to 2050. The timeseries are available for a large number of offshore and coastal locations (over 43.000 locations globally). For more information on the full dataset, please refer to the [Product User Guide](https://cds.climate.copernicus.eu/datasets/sis-water-level-change-timeseries-cmip6?tab=documentation).\n",
     "\n",
     "In this notebook we use the data from the GTSM `reanalysis` experiment where the surges were generated using the ERA5 meteorological reanalysis. This data is available for the period from 1950 onwards. We use the reanalysis experiment data to explore historical storm events. Reanalysis experiment data is useful for analyzing the contribution of surge to high coastal water levels, and as input for hydrodynamic modelling on local scale, including scenario modelling."
    ]
@@ -282,7 +282,7 @@
     "- tidal elevation at 10 min temporal resolution for the specified period relevant to the selected storm - this data is used to visually inspect the contribution of tidal elevation to total water levels during the storm;\n",
     "- Mean sea level for multiple years to better understand the vertical reference of the data and the contribution of sea level rise.\n",
     "\n",
-    "At the moment it is not possible to download the data within a geografical bounding box, therefore we download the full dataset for the given year. "
+    "At the moment it is not possible to download the data within a geografical bounding box, therefore we download the full dataset for the given year. In total, this notebook will download about 300 MB of data."
    ]
   },
   {
@@ -312,9 +312,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2025-06-18 14:33:03,525 INFO [2025-06-16T00:00:00] CC-BY licence to replace Licence to use Copernicus Products on 02 July 2025. More information available [here](https://forum.ecmwf.int/t/cc-by-licence-to-replace-licence-to-use-copernicus-products-on-02-july-2025/13464)\n",
-      "2025-06-18 14:33:03,527 INFO [2025-06-10T00:00:00] To improve our C3S service, we need to hear from you! Please complete this very short [survey](https://confluence.ecmwf.int/x/E7uBEQ/). Thank you.\n",
-      "2025-06-18 14:33:03,528 INFO [2024-09-26T00:00:00] Watch our [Forum](https://forum.ecmwf.int/) for Announcements, news and other discussed topics.\n"
+      "2025-08-22 10:32:39,085 INFO [2024-09-26T00:00:00] Watch our [Forum](https://forum.ecmwf.int/) for Announcements, news and other discussed topics.\n"
      ]
     }
    ],
@@ -323,18 +321,31 @@
     "c = cdsapi.Client(url=URL, key=KEY)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    ":::{note}\n",
+    "\n",
+    "If the data request does not run successfully, please check the [CDS system status page](https://cds.climate.copernicus.eu/live). If the problem persists, consider reaching out to [CDS Support](https://cds.climate.copernicus.eu/help).\n",
+    "\n",
+    ":::"
+   ]
+  },
   {
    "cell_type": "code",
-   "execution_count": 43,
+   "execution_count": 11,
    "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2025-06-18 14:50:54,680 INFO Request ID is 9fd69b40-8093-45cc-abf9-83f17e0878b6\n",
-      "2025-06-18 14:50:54,811 INFO status has been updated to accepted\n",
-      "2025-06-18 14:51:27,862 INFO status has been updated to successful\n",
+      "2025-08-22 10:41:51,350 INFO [2025-04-17T00:00:00] A new version has been added requiring a change to the download form. Users are advised that CDS API requests will need to be updated to accommodate this change. Please see the known issues under the Documentation tab for more information regarding the version update.\n",
+      "2025-08-22 10:41:51,350 INFO Request ID is 53d90b3d-6474-4d7c-a24c-f334dc13f089\n",
+      "2025-08-22 10:41:51,409 INFO status has been updated to accepted\n",
+      "2025-08-22 10:42:05,162 INFO status has been updated to running\n",
+      "2025-08-22 10:42:12,788 INFO status has been updated to successful\n",
       "                                                                                          \r"
      ]
     },
@@ -344,7 +355,7 @@
        "'./data_dir/water_levels_2023.zip'"
       ]
      },
-     "execution_count": 43,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -361,24 +372,27 @@
     "        'year': year,\n",
     "        'month': [f'{mm:02}' for mm in range(datetime.strptime(starttime + f' {year}', '%d %B %Y').month,\n",
     "                                              datetime.strptime(endtime + f' {year}', '%d %B %Y').month+1)],\n",
+    "        'version': [\"v3\"],\n",
     "        'format': 'zip',\n",
     "    },\n",
     "    filename)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 44,
+   "execution_count": 12,
    "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2025-06-18 14:51:33,900 INFO Request ID is 4923d5e7-b23f-474c-abe5-1e45c0c39bbc\n",
-      "2025-06-18 14:51:33,988 INFO status has been updated to accepted\n",
-      "2025-06-18 14:51:47,588 INFO status has been updated to successful\n",
-      "                                                                                         \r"
+      "2025-08-22 10:43:11,283 INFO [2025-04-17T00:00:00] A new version has been added requiring a change to the download form. Users are advised that CDS API requests will need to be updated to accommodate this change. Please see the known issues under the Documentation tab for more information regarding the version update.\n",
+      "2025-08-22 10:43:11,283 INFO Request ID is e60cb44a-f9b0-4160-941a-fe94f14c9d6b\n",
+      "2025-08-22 10:43:11,307 INFO status has been updated to accepted\n",
+      "2025-08-22 10:43:24,870 INFO status has been updated to running\n",
+      "2025-08-22 10:43:32,553 INFO status has been updated to successful\n",
+      "                                                                                        \r"
      ]
     },
     {
@@ -387,7 +401,7 @@
        "'./data_dir/tide_2023.zip'"
       ]
      },
-     "execution_count": 44,
+     "execution_count": 12,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -404,23 +418,25 @@
     "        'year': year,\n",
     "        'month': [f'{mm:02}' for mm in range(datetime.strptime(starttime + f' {year}', '%d %B %Y').month,\n",
     "                                              datetime.strptime(endtime + f' {year}', '%d %B %Y').month+1)],\n",
+    "        'version': [\"v1\"],\n",
     "        'format': 'zip',\n",
     "    },\n",
     "    filename)"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 14,
    "metadata": {},
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "2025-06-18 14:36:53,613 INFO Request ID is 16b9a23b-ce39-4a2e-bbbd-e697d4d05307\n",
-      "2025-06-18 14:36:53,688 INFO status has been updated to accepted\n",
-      "2025-06-18 14:37:07,451 INFO status has been updated to successful\n",
+      "2025-08-22 11:46:45,514 INFO [2025-04-17T00:00:00] A new version has been added requiring a change to the download form. Users are advised that CDS API requests will need to be updated to accommodate this change. Please see the known issues under the Documentation tab for more information regarding the version update.\n",
+      "2025-08-22 11:46:45,514 INFO Request ID is 004ce407-2bd3-4caf-8491-f48d045a6da5\n",
+      "2025-08-22 11:46:45,643 INFO status has been updated to accepted\n",
+      "2025-08-22 11:47:18,132 INFO status has been updated to successful\n",
       "                                                                                          \r"
      ]
     },
@@ -430,7 +446,7 @@
        "'./data_dir/MSL.zip'"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 14,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -445,6 +461,7 @@
     "        'experiment': ['historical', 'future'],\n",
     "        'temporal_aggregation': ['annual'],\n",
     "        'year': [str(x) for x in list(range(1985, year+1))],\n",
+    "        'version': [\"v1\"],\n",
     "        'format': 'zip',\n",
     "    },\n",
     "    filename)"
@@ -461,7 +478,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "From the CDS, the GTSMip water level data are available as `NetCDF` files compressed into `zip` archives. For this reason, before we can load any data, we have to extract the files. We can use the functions from the `zipfile` Python package to extract their contents. For each zip file we first construct a `ZipFile()` object, then we apply the function `extractall()` to extract its content."
+    "From the CDS, the GTSMip water level data are available as netCDF files compressed into `zip` archives. For this reason, before we can load any data, we have to extract the files. We can use the functions from the `zipfile` Python package to extract their contents. For each zip file we first construct a `ZipFile()` object, then we apply the function `extractall()` to extract its content."
    ]
   },
   {
@@ -483,7 +500,7 @@
    "source": [
     "### Create a list of the retrieved data files\n",
     "\n",
-    "The data was downloaded in separate files, each corresponding to a variable and a month of the year or full year (in the case of MSL). To facilitate data analysis later in the tutorial, we can create a list of the extracted NetCDF files for water level, surge and tide variables:"
+    "The data was downloaded in separate files, each corresponding to a variable and a month of the year or full year (in the case of MSL). To facilitate data analysis later in the tutorial, we can create a list of the extracted netCDF files for water level, surge and tide variables:"
    ]
   },
   {
@@ -505,7 +522,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We can inspect these lists by printing their elements - filenames of the extracted NetCDF files:"
+    "We can inspect these lists by printing their elements - filenames of the extracted netCDF files:"
    ]
   },
   {
@@ -568,7 +585,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "We begin by opening the downloaded water level timeseries NetCDF files in our list. We can use the Python library [xarray](http://xarray.pydata.org/en/stable/) and its function `open_mfdataset` to read in multiple NetCDF files. \n",
+    "We begin by opening the downloaded water level timeseries netCDF files in our list. We can use the Python library [xarray](http://xarray.pydata.org/en/stable/) and its function `open_mfdataset` to read in multiple netCDF files. \n",
     "\n",
     "The result is a `xarray.Dataset` object with two dimensions: `time` and `stations`. Each station correspond to coordinates `station_x_coordinate` and `station_y_coordinate`. By looking at the contents of the dataset we see that it contains 43119 stations. Please note, that after this step the dataset is opened, but not yet loaded into memory."
    ]
@@ -4826,6 +4843,13 @@
     "print(\"MSL in %i at the location of interest: %.2f m\" % (year, MSL_year))"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Take home messages"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -4844,7 +4868,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "cds_training_material",
+   "display_name": "default",
    "language": "python",
    "name": "python3"
   },
@@ -4858,7 +4882,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.13.0"
+   "version": "3.12.10"
   }
  },
  "nbformat": 4,