{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "623cbc23-45bf-4dfd-9f49-8d814d0394ba",
   "metadata": {
    "papermill": {
     "duration": 0.003689,
     "end_time": "2025-10-10T19:57:42.264860",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.261171",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "# Link to ADF output\n",
    "\n",
    "The output from the stand-alone ADF configuration is in the link below\n",
    "\n",
    "\n",
    "Note that ADF is currently run by users. We hope to update this in response to [CUPiD issue #105](https://github.com/NCAR/CUPiD/issues/105). Temporarily, we suggest users walk through the following process:\n",
    "1) Install ADF and activate cupid-analysis\n",
    "2) Use the `CUPiD/helper_scripts/generate_adf_config_file.py` script to generate an ADF config file based on a CUPiD configuration file.\n",
    "   * `cd CUPiD/examples/external_diag_packages`\n",
    "   * `../../helper_scripts/generate_adf_config_file.py --cupid-config-loc . --adf-template ../../externals/ADF/config_amwg_default_plots.yaml --out-file ADF_config.yaml`\n",
    "3) Run ADF with the newly created configuration file.\n",
    "   * `../../externals/ADF/run_adf_diag ADF_config.yaml`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "82af7435-3849-4fd1-bb2d-2e062719ec5b",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.272369Z",
     "iopub.status.busy": "2025-10-10T19:57:42.272049Z",
     "iopub.status.idle": "2025-10-10T19:57:42.514293Z",
     "shell.execute_reply": "2025-10-10T19:57:42.513728Z"
    },
    "papermill": {
     "duration": 0.247273,
     "end_time": "2025-10-10T19:57:42.515447",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.268174",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-cell"
    ]
   },
   "outputs": [],
   "source": [
    "import os\n",
    "\n",
    "from IPython.core.display import HTML, Image\n",
    "from IPython.display import display\n",
    "import pandas as pd"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "id": "2a759f1b-eca7-4eec-a16a-eede1a6ab36c",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.523355Z",
     "iopub.status.busy": "2025-10-10T19:57:42.523012Z",
     "iopub.status.idle": "2025-10-10T19:57:42.526565Z",
     "shell.execute_reply": "2025-10-10T19:57:42.526218Z"
    },
    "papermill": {
     "duration": 0.008329,
     "end_time": "2025-10-10T19:57:42.527512",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.519183",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "parameters",
     "hide-cell"
    ]
   },
   "outputs": [],
   "source": [
    "adf_root = \".\"\n",
    "case_name = None\n",
    "base_case_name = None\n",
    "start_date = \"\"\n",
    "end_date = \"\"\n",
    "base_start_date = None\n",
    "base_end_date = None\n",
    "key_plots = None\n",
    "# adf_root will be external_diag_packages/computed_notebooks/ADF/"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "id": "d6fc0eb7",
   "metadata": {
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.533082Z",
     "iopub.status.busy": "2025-10-10T19:57:42.532846Z",
     "iopub.status.idle": "2025-10-10T19:57:42.537839Z",
     "shell.execute_reply": "2025-10-10T19:57:42.537454Z"
    },
    "papermill": {
     "duration": 0.00764,
     "end_time": "2025-10-10T19:57:42.538334",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.530694",
     "status": "completed"
    },
    "tags": [
     "injected-parameters"
    ]
   },
   "outputs": [],
   "source": [
    "# Parameters\n",
    "case_name = \"b.e23_alpha17f.BLT1850.ne30_t232.092\"\n",
    "base_case_name = \"b.e30_beta02.BLT1850.ne30_t232.104\"\n",
    "CESM_output_dir = \"/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CESM_output_for_testing\"\n",
    "start_date = \"0001-01-01\"\n",
    "end_date = \"0101-01-01\"\n",
    "obs_data_dir = (\n",
    "    \"/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CUPiD_obs_data\"\n",
    ")\n",
    "ts_dir = None\n",
    "lc_kwargs = {\"threads_per_worker\": 1}\n",
    "serial = False\n",
    "adf_root = \"../../examples/external_diag_packages/ADF_output/\"\n",
    "key_plots = [\n",
    "    \"Surface_Wind_Stress_ANN_LatLon_Vector_Mean.png\",\n",
    "    \"PRECT_ANN_LatLon_Mean.png\",\n",
    "    \"PS_DJF_SHPolar_Mean.png\",\n",
    "    \"TaylorDiag_ANN_Special_Mean.png\",\n",
    "]\n",
    "subset_kwargs = {}\n",
    "product = \"/glade/work/richling/CUPid_pr_test/CUPiD/examples/external_diag_packages/computed_notebooks//atm/link_to_ADF.ipynb\"\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "id": "81bf4573-8806-486f-a2f6-79e244415c07",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.541351Z",
     "iopub.status.busy": "2025-10-10T19:57:42.541256Z",
     "iopub.status.idle": "2025-10-10T19:57:42.549280Z",
     "shell.execute_reply": "2025-10-10T19:57:42.548963Z"
    },
    "papermill": {
     "duration": 0.010437,
     "end_time": "2025-10-10T19:57:42.550184",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.539747",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-cell"
    ]
   },
   "outputs": [],
   "source": [
    "# Want some base case parameter defaults to equal control case values\n",
    "if base_case_name is not None:\n",
    "    if base_start_date is None:\n",
    "        base_start_date = start_date\n",
    "\n",
    "    if base_end_date is None:\n",
    "        base_end_date = end_date"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "id": "4104f878-a8c3-4d0f-8c00-555e6b2b3273",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.557175Z",
     "iopub.status.busy": "2025-10-10T19:57:42.556964Z",
     "iopub.status.idle": "2025-10-10T19:57:42.560716Z",
     "shell.execute_reply": "2025-10-10T19:57:42.560184Z"
    },
    "papermill": {
     "duration": 0.007818,
     "end_time": "2025-10-10T19:57:42.561231",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.553413",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-cell"
    ]
   },
   "outputs": [],
   "source": [
    "# convert start-date and end-date to year range\n",
    "case_year_range = [int(start_date.split(\"-\")[0]), int(end_date.split(\"-\")[0]) - 1]\n",
    "\n",
    "base_case_year_range = [\n",
    "    int(base_start_date.split(\"-\")[0]),\n",
    "    int(base_end_date.split(\"-\")[0]) - 1,\n",
    "]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "id": "ee0774cc-c68a-4385-b94c-08fa806f28c0",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.564620Z",
     "iopub.status.busy": "2025-10-10T19:57:42.564370Z",
     "iopub.status.idle": "2025-10-10T19:57:42.572560Z",
     "shell.execute_reply": "2025-10-10T19:57:42.572233Z"
    },
    "papermill": {
     "duration": 0.010314,
     "end_time": "2025-10-10T19:57:42.573004",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.562690",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-input"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<a href=\"../ADF/b.e23_alpha17f.BLT1850.ne30_t232.092_1_100_vs_b.e30_beta02.BLT1850.ne30_t232.104_1_100/website/index.html\">Full ADF output</a>"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "adf_comparison_name = f\"{case_name}_{case_year_range[0]}_{case_year_range[1]}_vs_{base_case_name}_{base_case_year_range[0]}_{base_case_year_range[1]}\"\n",
    "adf_root = os.path.join(adf_root, adf_comparison_name)\n",
    "display(\n",
    "    HTML(\n",
    "        f'<a href=\"../ADF/{adf_comparison_name}/website/index.html\">Full ADF output</a>'\n",
    "    )\n",
    ")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f9234aec-1fe5-4bbf-ad6c-fb565297afbe",
   "metadata": {
    "papermill": {
     "duration": 0.001303,
     "end_time": "2025-10-10T19:57:42.575845",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.574542",
     "status": "completed"
    },
    "tags": []
   },
   "source": [
    "## Key Metrics from ADF\n",
    "\n",
    "Some important things to look at from ADF include a comparison table and a few maps:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "id": "a5b02451-98ad-4089-b184-75391a262db3",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.579209Z",
     "iopub.status.busy": "2025-10-10T19:57:42.578981Z",
     "iopub.status.idle": "2025-10-10T19:57:42.592775Z",
     "shell.execute_reply": "2025-10-10T19:57:42.592251Z"
    },
    "papermill": {
     "duration": 0.016671,
     "end_time": "2025-10-10T19:57:42.593846",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.577175",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-input"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table border=\"1\" class=\"dataframe\">\n",
       "  <thead>\n",
       "    <tr style=\"text-align: right;\">\n",
       "      <th>variable</th>\n",
       "      <th>unit</th>\n",
       "      <th>test</th>\n",
       "      <th>control</th>\n",
       "      <th>diff</th>\n",
       "    </tr>\n",
       "  </thead>\n",
       "  <tbody>\n",
       "    <tr>\n",
       "      <td>OCNFRAC</td>\n",
       "      <td>fraction</td>\n",
       "      <td>0.668</td>\n",
       "      <td>0.662</td>\n",
       "      <td>0.006</td>\n",
       "    </tr>\n",
       "    <tr>\n",
       "      <td>PRECT</td>\n",
       "      <td>m/s</td>\n",
       "      <td>3.58e-08</td>\n",
       "      <td>3.56e-08</td>\n",
       "      <td>2e-10</td>\n",
       "    </tr>\n",
       "  </tbody>\n",
       "</table>"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "metadata": {},
     "output_type": "display_data"
    }
   ],
   "source": [
    "comparison_table = os.path.join(adf_root, \"amwg_table_comp.csv\")\n",
    "if os.path.isfile(comparison_table):\n",
    "    table = pd.read_csv(comparison_table)\n",
    "    display(HTML(table.to_html(index=False, float_format=\"{:6g}\".format)))"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "id": "be819352-c723-4f48-afac-d93f6d192f96",
   "metadata": {
    "editable": true,
    "execution": {
     "iopub.execute_input": "2025-10-10T19:57:42.601424Z",
     "iopub.status.busy": "2025-10-10T19:57:42.601190Z",
     "iopub.status.idle": "2025-10-10T19:57:42.604706Z",
     "shell.execute_reply": "2025-10-10T19:57:42.604221Z"
    },
    "papermill": {
     "duration": 0.007512,
     "end_time": "2025-10-10T19:57:42.605215",
     "exception": false,
     "start_time": "2025-10-10T19:57:42.597703",
     "status": "completed"
    },
    "slideshow": {
     "slide_type": ""
    },
    "tags": [
     "hide-input"
    ]
   },
   "outputs": [],
   "source": [
    "for path_to_key_plot in key_plots:\n",
    "    full_path = os.path.join(adf_root, path_to_key_plot)\n",
    "    if os.path.isfile(full_path):\n",
    "        display(Image(full_path))"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "cupid-infrastructure",
   "language": "python",
   "name": "cupid-infrastructure"
  },
  "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.11.4"
  },
  "papermill": {
   "duration": 1.339458,
   "end_time": "2025-10-10T19:57:42.823397",
   "exception": null,
   "input_path": "/glade/derecho/scratch/richling/tmp/tmpnyfhvrun.ipynb",
   "output_path": "/glade/work/richling/CUPid_pr_test/CUPiD/examples/external_diag_packages/computed_notebooks/atm/link_to_ADF.ipynb",
   "parameters": {
    "CESM_output_dir": "/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CESM_output_for_testing",
    "adf_root": "../../examples/external_diag_packages/ADF_output/",
    "base_case_name": "b.e30_beta02.BLT1850.ne30_t232.104",
    "case_name": "b.e23_alpha17f.BLT1850.ne30_t232.092",
    "end_date": "0101-01-01",
    "key_plots": [
     "Surface_Wind_Stress_ANN_LatLon_Vector_Mean.png",
     "PRECT_ANN_LatLon_Mean.png",
     "PS_DJF_SHPolar_Mean.png",
     "TaylorDiag_ANN_Special_Mean.png"
    ],
    "lc_kwargs": {
     "threads_per_worker": 1
    },
    "obs_data_dir": "/glade/campaign/cesm/development/cross-wg/diagnostic_framework/CUPiD_obs_data",
    "product": "/glade/work/richling/CUPid_pr_test/CUPiD/examples/external_diag_packages/computed_notebooks//atm/link_to_ADF.ipynb",
    "serial": false,
    "start_date": "0001-01-01",
    "subset_kwargs": {},
    "ts_dir": null
   },
   "start_time": "2025-10-10T19:57:41.483939"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}