{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "f30aa9dc",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "# ocean: line\n",
    "\n",
    "ocean transport data cross defined lines\n",
    "\n",
    "```{dropdown}  **Branding suffix of datasets**\n",
    "Datasets with the folloing branding suffix are shown in this page: \\\n",
    "[time]-[vertical]-[horizontal]-[domain]\n",
    "```\n",
    "* tavg-u-ht-sea\n",
    "    - tavg: time average\n",
    "    - u: ocean surface\n",
    "    - ht: defined lines\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 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 read_variables, read_compound_names"
   ]
  },
  {
   "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": "bf04c5e0",
   "metadata": {
    "tags": [
     "injected-parameters"
    ]
   },
   "outputs": [],
   "source": [
    "# Parameters\n",
    "cmorout = \"/scratch/agu002/cmorout\"\n",
    "source_id = \"UKESM1-3-LL\"\n",
    "experiment_id = \"piControl\"\n",
    "variant_label = \"r1i1p1f1\"\n",
    "grid_label = \"g143\"\n",
    "version = \"v20260917\"\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 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",
    "```{dropdown}  **List of datasets:** \n",
    "List of compound names of datasets that needs to be cmorized. \\\n",
    "Those datasets which are not cmorized have no link.\n",
    "``"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "67a5a359",
   "metadata": {
    "papermill": {},
    "tags": [
     "remove-input"
    ]
   },
   "outputs": [],
   "source": [
    "# load compound names\n",
    "\n",
    "coords = ('tavg-u-ht-sea')\n",
    "cnames = read_compound_names('data/variables.nml')\n",
    "# examples of compound names:\n",
    "# cnames = ['ocean.hfacrossline.tavg-u-ht-sea.mon.glb', 'ocean.mfo.tavg-u-ht-sea.mon.glb', 'ocean.sfacrossline.tavg-u-ht-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",
    "    region = cname.split('.')[4]\n",
    "    \n",
    "    if realm != 'ocean' or coord not in coords:\n",
    "        continue\n",
    "    else:\n",
    "        data_file = f\"{var}_{coord}_{freq}_{region}_{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": "3906dacb",
   "metadata": {
    "papermill": {},
    "tags": []
   },
   "source": [
    "---\n",
    "```{dropdown}  **Dataset validated**\n",
    "Each validated dataset has some text information and some plots (2D and/or 1D)\n",
    "```"
   ]
  },
  {
   "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_vert = 'mean'\n",
    "    mth_ts = 'mean'\n",
    "    mth_cmap = 'mpl.colormaps[\"viridis\"]'\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",
    "            if 'vertical' in methods[cname].keys():\n",
    "                mth_vert = methods[cname]['vertical']\n",
    "\n",
    "            if 'timeseries' in methods[cname].keys():\n",
    "                mth_ts = methods[cname]['timeseries']\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",
    "    region = cname.split('.')[4]\n",
    "\n",
    "    if realm != 'ocean' or coord not in coords:\n",
    "        continue\n",
    "\n",
    "    data_file = f\"{var}_{coord}_{freq}_{region}_{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",
    "    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",
    "    print(f'original_name: {data.attrs[\"original_name\"]} -> {var}')\n",
    "    if 'history' in data.attrs:\n",
    "        print(f'history: {data.attrs[\"history\"]}')\n",
    "    if 'comment' in data.attrs:\n",
    "        print(f'comment: {data.attrs[\"comment\"]}')    \n",
    "    nlines = data.line.size\n",
    "    sector = ds['sector'].data\n",
    "    fig, axs = plt.subplots((nlines+1)//2, 2, figsize=(12, 16), dpi=96, sharex=True, sharey=False)\n",
    "    ax = axs.flatten()\n",
    "    for i in range(nlines):\n",
    "        data.isel(line=i).plot(ax=ax[i])\n",
    "        data.isel(line=i).plot(ax=ax[i])\n",
    "        ax[i].set_title(f'{sector[i].astype(str).strip()}')\n",
    "        ax[i].set_ylabel(data.units)\n",
    "        ax[i].set_xlabel('')\n",
    "        ax[i].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('Time')\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_line.ipynb",
   "output_path": "ocean_line.ipynb",
   "parameters": {
    "cmorout": "/scratch/agu002/cmorout",
    "experiment_id": "piControl",
    "grid_label": "g143",
    "source_id": "UKESM1-3-LL",
    "variant_label": "r1i1p1f1",
    "version": "v20260917"
   },
   "version": "2.7.0"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}