{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "f30aa9dc",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# ocean: zonal\n",
    "\n",
    "zonal ocean data\n",
    "\n",
    "**coordinate**: tavg-ol-hyb-sea\n",
    "- tavg: time average\n",
    "- ol: ocean levels\n",
    "- hyb: zonal mean\n",
    "- sea: ocean domain"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f1f107ce",
   "metadata": {
    "papermill": {},
    "tags": [
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    "## Import libraries\n",
    "import numpy as np\n",
    "import xarray as xr\n",
    "import matplotlib.pyplot as plt\n",
    "import matplotlib as mpl\n",
    "from matplotlib.colors import ListedColormap, BoundaryNorm\n",
    "import cartopy.feature as cfeature\n",
    "import cartopy.crs as ccrs\n",
    "import cmocean\n",
    "import sys\n",
    "import os\n",
    "import glob\n",
    "from IPython.display import HTML, display\n",
    "\n",
    "sys.path.append(os.getcwd())\n",
    "from utils import load_grid_vertex, read_variables, read_compound_name"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "1227985d",
   "metadata": {
    "papermill": {},
    "tags": [
     "parameters",
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    "# parameters for the cmorized data\n",
    "cmorout=''                  # root for cmorized data, e.g., '/scratch/$USER/cmorout'\n",
    "source_id      = ''         # model name, e.g., 'NorESM3-LM'\n",
    "experiment_id  = ''         # experiment name, e.g., 'historical', 'ssp585', 'piControl'\n",
    "variant_label  = ''         # variant label, e.g., 'r1i1p1f1'\n",
    "grid_label     = ''         # grid label, e.g., 'gn', 'gr', 'g999'\n",
    "version        = ''         # version, e.g., 'v20260601'"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "9e0e27f5",
   "metadata": {
    "tags": [
     "injected-parameters"
    ]
   },
   "outputs": [],
   "source": [
    "# Parameters\n",
    "cmorout = \"/scratch/yanchun/cmorout\"\n",
    "source_id = \"UKESM1-0-LL\"\n",
    "experiment_id = \"piControl\"\n",
    "variant_label = \"r1i1p1f1\"\n",
    "grid_label = \"g99\"\n",
    "version = \"v20260609\"\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "8314513c",
   "metadata": {
    "papermill": {},
    "tags": [
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    "# data path\n",
    "data_path = os.path.join(cmorout, source_id, experiment_id, version)\n",
    "\n",
    "# load grid\n",
    "grid_file = 'data/grid.nc'\n",
    "lat, lon, clat, clon = load_grid_vertex(grid_file)\n",
    "with xr.open_dataset(grid_file) as ds:\n",
    "    pmask = ds['pmask']\n",
    "    parea = ds['parea']\n",
    "\n",
    "parea = parea.rename({'y': 'j', 'x': 'i'})\n",
    "pmask = pmask.rename({'y': 'j', 'x': 'i'})\n",
    "# load methods for plotting and set defaults\n",
    "methods =read_variables('data/methods.txt')\n",
    "#print(methods.keys())"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f06c51b7",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "---\n",
    "**List of datasets:** \\\n",
    "(datasets which are not presented/cmorized have no link.)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "67a5a359",
   "metadata": {
    "papermill": {},
    "tags": [
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    "# load compound names\n",
    "\n",
    "coords = ('tavg-ol-hyb-sea','tavg-rho-hyb-sea','tavg-u-hyb-sea')\n",
    "cnames = read_compound_name('data/variables.nml')\n",
    "# examples of compound names:\n",
    "# cnames = ['ocean.tos.tavg-u-hxy-sea.mon.glb', 'ocean.ficeberg.tavg-u-hxy-sea.mon.glb']\n",
    "for cname in cnames:\n",
    "    realm = cname.split('.')[0]\n",
    "    var = cname.split('.')[1]\n",
    "    coord = cname.split('.')[2]\n",
    "    freq = cname.split('.')[3]\n",
    "    \n",
    "    if realm != 'ocean' or coord not in coords:\n",
    "        continue\n",
    "    else:\n",
    "        data_file = var+'_'+coord+'_*_'+grid_label+'_'+source_id+'_'+experiment_id+'_'+variant_label+'_*.nc'\n",
    "        if not glob.glob(os.path.join(data_path, data_file)):\n",
    "            print(cname)\n",
    "            continue\n",
    "        else:\n",
    "            display(HTML(f'<a href=\"#{cname}\">{cname}</a>'))\n"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1f2b50e9",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "---\n",
    "**Datasets validated:**"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "25072041",
   "metadata": {
    "papermill": {},
    "tags": [
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    " # loop through compound names and plot\n",
    "for cname in cnames:\n",
    "    mth_cmap = 'mpl.colormaps[\"seismic\"]'\n",
    "    if cname not in methods.keys():\n",
    "        print(f\"{cname} not found in methods.txt, using default methods for plotting.\")\n",
    "    else:\n",
    "        if methods[cname] is not None:\n",
    "\n",
    "            if 'cmap' in methods[cname].keys():\n",
    "                mth_cmap = methods[cname]['cmap']\n",
    "\n",
    "    realm = cname.split('.')[0]\n",
    "    var = cname.split('.')[1]\n",
    "    coord = cname.split('.')[2]\n",
    "    freq = cname.split('.')[3]\n",
    "\n",
    "    if realm != 'ocean' or coord not in coords:\n",
    "        continue\n",
    "\n",
    "    data_file = var+'_'+coord+'_*_'+grid_label+'_'+source_id+'_'+experiment_id+'_'+variant_label+'_*.nc'\n",
    "\n",
    "    if not glob.glob(os.path.join(data_path, data_file)):\n",
    "        continue\n",
    "\n",
    "    #with xr.open_mfdataset(os.path.join(data_path, data_file)) as ds:\n",
    "    data_file = glob.glob(os.path.join(data_path, data_file))[0]\n",
    "    with xr.open_dataset(os.path.join(data_path, data_file)) as ds:\n",
    "        if var in ds:\n",
    "            data = ds[var]\n",
    "        else:\n",
    "            continue\n",
    "\n",
    "    data2d = data \n",
    "\n",
    "    # Scale\n",
    "    vmin, vmax = data2d.quantile([0.001, 0.999], dim=None).values\n",
    "    vmax = max(abs(vmin),abs(vmax))\n",
    "    vmin = -vmax\n",
    "    # Define the discrete levels (boundaries) and the corresponding colors\n",
    "    n_levels = 20\n",
    "    levels = np.linspace(vmin, vmax, n_levels+1)\n",
    "    colors = eval(mth_cmap)(np.linspace(0,1,n_levels))\n",
    "    cmap = ListedColormap(colors)\n",
    "\n",
    "    # Create a BoundaryNorm to map data to discrete color indices\n",
    "    norm = BoundaryNorm(levels, ncolors=len(cmap.colors), clip=False)\n",
    "\n",
    "    display(HTML(f'<div id=\"{cname}\"></div>'))\n",
    "    print(f'\\033[1m{cname}\\033[0m')\n",
    "    print(f'long name: {data.long_name} ({data.units})')\n",
    "\n",
    "    nlines = data.basin.size\n",
    "    sector = ds['sector'].data\n",
    "    fig, axs = plt.subplots((nlines+1)//2, 2, figsize=(11.69, 8.27), dpi=96, sharex=True, sharey=False)\n",
    "    ax = axs.flatten()\n",
    "    for n in range(nlines):\n",
    "        if any(dim in data.dims for dim in ['lev', 'rho']):\n",
    "            if vmin == vmax:\n",
    "                data.isel(basin=n).mean(dim='time').plot(ax=ax[n], cmap=cmap, bar_kwargs={\"extend\":\"both\", \"label\": f\"{data.name} ({data.units})\"})\n",
    "            else:\n",
    "                data.isel(basin=n).mean(dim='time').plot(ax=ax[n], cmap=cmap, norm=norm, cbar_kwargs={\"extend\":\"both\", \"label\": f\"{data.name} ({data.units})\"})\n",
    "            ax[n].invert_yaxis()\n",
    "        else:\n",
    "            data.isel(basin=n).mean(dim='time').plot(ax=ax[n])\n",
    "            ax[n].set_ylabel(data.units)\n",
    "            \n",
    "        ax[n].set_title(f'{sector[n].astype(str).strip()}')\n",
    "        ax[n].set_xlabel('')\n",
    "        ax[n].grid()\n",
    "\n",
    "    # Turn off x‑axis ticks for all subplots\n",
    "    for ax in axs.flatten():\n",
    "        ax.xaxis.set_tick_params(labelbottom=False, bottom=False)\n",
    "\n",
    "    # Turn on x‑axis ticks only for the bottom row (last two axes)\n",
    "    for ax in axs[-1,:]:\n",
    "        ax.xaxis.set_tick_params(labelbottom=True, bottom=True)\n",
    "        ax.set_xlabel(data.lat.long_name)\n",
    "\n",
    "    fig.suptitle(f\"{data.long_name}\", fontsize=16)\n",
    "\n",
    "    plt.tight_layout()\n",
    "    plt.show()\n",
    "\n",
    "    del data\n",
    "    del ax, axs, fig "
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "cmip7validate-env",
   "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.13.3"
  },
  "papermill": {
   "default_parameters": {},
   "environment_variables": {},
   "input_path": "notebooks/ocean_zonal.ipynb",
   "output_path": "ocean_zonal.ipynb",
   "parameters": {
    "cmorout": "/scratch/yanchun/cmorout",
    "experiment_id": "piControl",
    "grid_label": "g99",
    "source_id": "UKESM1-0-LL",
    "variant_label": "r1i1p1f1",
    "version": "v20260609"
   },
   "version": "2.7.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}