Update documentation

NCAR · Aug 8, 2024 · 931ba91 · 931ba91
commit 931ba91
Show file tree

Hide file tree

Showing 583 changed files with 161,618 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 08c226f57982fca33cc7beee8c87c901
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.html b/README.html
diff --git a/_images/19e7e1d8c86213c1e67fd671db564e5bc11031544651f28121af9fd5edf24d5e.png b/_images/19e7e1d8c86213c1e67fd671db564e5bc11031544651f28121af9fd5edf24d5e.png
diff --git a/_images/CAMchem_compsets.png b/_images/CAMchem_compsets.png
diff --git a/_images/CESM2.png b/_images/CESM2.png
diff --git a/_images/CESM2_CIME_Infrastructure.png b/_images/CESM2_CIME_Infrastructure.png
diff --git a/_images/CESM2_Code_Components_List.png b/_images/CESM2_Code_Components_List.png
diff --git a/_images/CESM2_Create_Newcase_Command.png b/_images/CESM2_Create_Newcase_Command.png
diff --git a/_images/CESM2_Create_Newcase_Compset.png b/_images/CESM2_Create_Newcase_Compset.png
diff --git a/_images/CESM2_Create_Newcase_Resolution.png b/_images/CESM2_Create_Newcase_Resolution.png
diff --git a/_images/CESM2_Discuss.png b/_images/CESM2_Discuss.png
diff --git a/_images/CESM2_Events.png b/_images/CESM2_Events.png
diff --git a/_images/CESM2_MCT_Coupling.png b/_images/CESM2_MCT_Coupling.png
diff --git a/_images/CESM2_Porting.png b/_images/CESM2_Porting.png
diff --git a/_images/CESM2_Workspaces_Code.png b/_images/CESM2_Workspaces_Code.png
diff --git a/_images/CESM2_Workspaces_Detail.png b/_images/CESM2_Workspaces_Detail.png
diff --git a/_images/CESM2_case_build.png b/_images/CESM2_case_build.png
diff --git a/_images/CESM2_case_setup.png b/_images/CESM2_case_setup.png
diff --git a/_images/CESM2_case_submit.png b/_images/CESM2_case_submit.png
diff --git a/_images/CESM2_create_newcase.png b/_images/CESM2_create_newcase.png
diff --git a/_images/CESM2_github_CESM.png b/_images/CESM2_github_CESM.png
diff --git a/_images/CESM2_github_ESCOMP.png b/_images/CESM2_github_ESCOMP.png
diff --git a/_images/CESM2_github_main.png b/_images/CESM2_github_main.png
diff --git a/_images/CESM2_short_term_archive.png b/_images/CESM2_short_term_archive.png
diff --git a/_images/CESM2_xml_files.png b/_images/CESM2_xml_files.png
diff --git a/_images/CESM_NUOPC_Coupling.png b/_images/CESM_NUOPC_Coupling.png
diff --git a/_images/CESM_directories_and_SourceMods.png b/_images/CESM_directories_and_SourceMods.png
diff --git a/_images/CESM_directories_and_log_files.png b/_images/CESM_directories_and_log_files.png
diff --git a/_images/CESM_directories_and_namelists.png b/_images/CESM_directories_and_namelists.png
diff --git a/_images/CESM_exp_1.png b/_images/CESM_exp_1.png
diff --git a/_images/CESM_exp_2.png b/_images/CESM_exp_2.png
diff --git a/_images/CESM_exp_3.png b/_images/CESM_exp_3.png
diff --git a/_images/CESM_github.png b/_images/CESM_github.png
diff --git a/_images/Diagnostics_1.png b/_images/Diagnostics_1.png
diff --git a/_images/Diagnostics_2.png b/_images/Diagnostics_2.png
diff --git a/_images/Diagnostics_3.png b/_images/Diagnostics_3.png
diff --git a/_images/Diagnostics_4.png b/_images/Diagnostics_4.png
diff --git a/_images/Diagnostics_5.png b/_images/Diagnostics_5.png
diff --git a/_images/Diagnostics_6.png b/_images/Diagnostics_6.png
diff --git a/_images/Diagnostics_7.png b/_images/Diagnostics_7.png
diff --git a/_images/Diagnostics_8.png b/_images/Diagnostics_8.png
diff --git a/_images/Diagnostics_duo_pcode.png b/_images/Diagnostics_duo_pcode.png
diff --git a/_images/Fcompset.png b/_images/Fcompset.png
diff --git a/_images/NCVIEW_App_Window.png b/_images/NCVIEW_App_Window.png
diff --git a/_images/NCVIEW_Jan0001_PRECC.png b/_images/NCVIEW_Jan0001_PRECC.png
diff --git a/_images/NCVIEW_Jan0001_PRECL.png b/_images/NCVIEW_Jan0001_PRECL.png
diff --git a/_images/NCVIEW_Jan0001_TS.png b/_images/NCVIEW_Jan0001_TS.png
diff --git a/_images/Precip_isotope_Cartoon.jpg b/_images/Precip_isotope_Cartoon.jpg
diff --git a/_images/WACCM_compsets1.png b/_images/WACCM_compsets1.png
diff --git a/_images/WACCM_compsets2.png b/_images/WACCM_compsets2.png
diff --git a/_images/a9c31dcbdc46b7741ccba9cf1c77e876cfa663c218434ffb3081171289102baf.png b/_images/a9c31dcbdc46b7741ccba9cf1c77e876cfa663c218434ffb3081171289102baf.png
diff --git a/_images/advanced_plot_1.png b/_images/advanced_plot_1.png
diff --git a/_images/advanced_plot_11.png b/_images/advanced_plot_11.png
diff --git a/_images/advanced_plot_12.png b/_images/advanced_plot_12.png
diff --git a/_images/advanced_plot_2.png b/_images/advanced_plot_2.png
diff --git a/_images/advanced_plot_21.png b/_images/advanced_plot_21.png
diff --git a/_images/advanced_plot_3.png b/_images/advanced_plot_3.png
diff --git a/_images/advanced_plot_4.png b/_images/advanced_plot_4.png
diff --git a/_images/advanced_plot_5.png b/_images/advanced_plot_5.png
diff --git a/_images/advanced_plot_6.png b/_images/advanced_plot_6.png
diff --git a/_images/basics_plot_1.png b/_images/basics_plot_1.png
diff --git a/_images/basics_plot_10.png b/_images/basics_plot_10.png
diff --git a/_images/basics_plot_101.png b/_images/basics_plot_101.png
diff --git a/_images/basics_plot_11.png b/_images/basics_plot_11.png
diff --git a/_images/basics_plot_12.png b/_images/basics_plot_12.png
diff --git a/_images/basics_plot_13.png b/_images/basics_plot_13.png
diff --git a/_images/basics_plot_14.png b/_images/basics_plot_14.png
diff --git a/_images/basics_plot_2.png b/_images/basics_plot_2.png
diff --git a/_images/basics_plot_21.png b/_images/basics_plot_21.png
diff --git a/_images/basics_plot_22.png b/_images/basics_plot_22.png
diff --git a/_images/basics_plot_23.png b/_images/basics_plot_23.png
diff --git a/_images/basics_plot_24.png b/_images/basics_plot_24.png
diff --git a/_images/basics_plot_3.png b/_images/basics_plot_3.png
diff --git a/_images/basics_plot_31.png b/_images/basics_plot_31.png
diff --git a/_images/basics_plot_32.png b/_images/basics_plot_32.png
diff --git a/_images/basics_plot_33.png b/_images/basics_plot_33.png
diff --git a/_images/basics_plot_34.png b/_images/basics_plot_34.png
diff --git a/_images/basics_plot_4.png b/_images/basics_plot_4.png
diff --git a/_images/basics_plot_41.png b/_images/basics_plot_41.png
diff --git a/_images/basics_plot_42.png b/_images/basics_plot_42.png
diff --git a/_images/basics_plot_43.png b/_images/basics_plot_43.png
diff --git a/_images/basics_plot_44.png b/_images/basics_plot_44.png
diff --git a/_images/basics_plot_5.png b/_images/basics_plot_5.png
diff --git a/_images/basics_plot_51.png b/_images/basics_plot_51.png
diff --git a/_images/basics_plot_52.png b/_images/basics_plot_52.png
diff --git a/_images/basics_plot_53.png b/_images/basics_plot_53.png
diff --git a/_images/basics_plot_6.png b/_images/basics_plot_6.png
diff --git a/_images/basics_plot_61.png b/_images/basics_plot_61.png
diff --git a/_images/basics_plot_62.png b/_images/basics_plot_62.png
diff --git a/_images/basics_plot_63.png b/_images/basics_plot_63.png
diff --git a/_images/basics_plot_7.png b/_images/basics_plot_7.png
diff --git a/_images/basics_plot_71.png b/_images/basics_plot_71.png
diff --git a/_images/basics_plot_72.png b/_images/basics_plot_72.png
diff --git a/_images/basics_plot_8.png b/_images/basics_plot_8.png
diff --git a/_images/basics_plot_81.png b/_images/basics_plot_81.png
diff --git a/_images/basics_plot_82.png b/_images/basics_plot_82.png
diff --git a/_images/basics_plot_9.png b/_images/basics_plot_9.png
diff --git a/_images/basics_plot_91.png b/_images/basics_plot_91.png
diff --git a/_images/bgc_table_1.png b/_images/bgc_table_1.png
diff --git a/_images/bgc_table_2.png b/_images/bgc_table_2.png
diff --git a/_images/cam_SST_diff.png b/_images/cam_SST_diff.png
diff --git a/_images/cam_topo_diff.png b/_images/cam_topo_diff.png
diff --git a/_images/cape.png b/_images/cape.png
diff --git a/_images/chemistry-mechanism-example.png b/_images/chemistry-mechanism-example.png
diff --git a/_images/chemistry-ozone-reaction.png b/_images/chemistry-ozone-reaction.png
diff --git a/_images/chemistry-ozone-reaction_orig.png b/_images/chemistry-ozone-reaction_orig.png
diff --git a/_images/chemistry-preprocessor-info.png b/_images/chemistry-preprocessor-info.png
diff --git a/_images/chemistry-rundir-example.png b/_images/chemistry-rundir-example.png
diff --git a/_images/cice_rsnw2.png b/_images/cice_rsnw2.png
diff --git a/_images/clim_data_gateway.png b/_images/clim_data_gateway.png
diff --git a/_images/clim_data_guide.png b/_images/clim_data_guide.png
diff --git a/_images/d5e9aa2b789d8cba96db4711ac132bc332b8449f7f2d6306c8ba66bb9aaa23b4.png b/_images/d5e9aa2b789d8cba96db4711ac132bc332b8449f7f2d6306c8ba66bb9aaa23b4.png
diff --git a/_images/d9bdf37c00b9c590f5d56178f24912181493a22d6ab3f0daa70560ddcb068767.png b/_images/d9bdf37c00b9c590f5d56178f24912181493a22d6ab3f0daa70560ddcb068767.png
diff --git a/_images/dcs.png b/_images/dcs.png
diff --git a/_images/gcase.png b/_images/gcase.png
diff --git a/_images/gecocase.png b/_images/gecocase.png
diff --git a/_images/geov-2files.png b/_images/geov-2files.png
diff --git a/_images/geov-difference.png b/_images/geov-difference.png
diff --git a/_images/geov-openingfile.png b/_images/geov-openingfile.png
diff --git a/_images/i2000.png b/_images/i2000.png
diff --git a/_images/ihist.png b/_images/ihist.png
diff --git a/_images/light_dark_mode.png b/_images/light_dark_mode.png
diff --git a/_images/modules.png b/_images/modules.png
diff --git a/_images/namelist_var_search.png b/_images/namelist_var_search.png
diff --git a/_images/ncdump_example.png b/_images/ncdump_example.png
diff --git a/_images/ncview.png b/_images/ncview.png
diff --git a/_images/ncview_T750-T500.png b/_images/ncview_T750-T500.png
diff --git a/_images/ncview_diff_dcs.png b/_images/ncview_diff_dcs.png
diff --git a/_images/nhtfrq.png b/_images/nhtfrq.png
diff --git a/_images/overflows.png b/_images/overflows.png
diff --git a/_images/term_jupyter_1.png b/_images/term_jupyter_1.png
diff --git a/_images/term_jupyter_2.png b/_images/term_jupyter_2.png
diff --git a/_images/term_mac.png b/_images/term_mac.png
diff --git a/_images/term_pc.png b/_images/term_pc.png
diff --git a/_images/transport_sections_mom6.png b/_images/transport_sections_mom6.png
diff --git a/_sources/README.md b/_sources/README.md
@@ -0,0 +1,33 @@
+
+# Welcome to the [CESM Tutorial](https://ncar.github.io/CESM-Tutorial/README.html)
+
+<br>
+
+In 1983 NCAR created the _Community Climate Model_ (CCM) as a freely available global atmosphere model for use by the climate research community. The scope of CCM development continued to expand and in 1994 NCAR scientists released the _Climate System Model_ (CSM), a global model that included component models for the atmosphere, land surface, ocean, and sea-ice, communicating through a central coupler component. To recognize the broad community of users and sponsors contributing to this effort, the CSM was renamed the _Community Climate System Model_ (CCSM). The CCSM model evolved to include ice sheet and biogeochemical modeling and was renamed the _Community Earth System Model_ (CESM) in 2013.
+
+This repository includes materials designed to be an introduction to running the CESM. The materials were developed to support the CESM tutorial and serve as reference documentation for all CESM users.
+
+## Goals of This Tutorial
+
+**Through this online tutorial you will learn how to run the CESM model, modify the model experiments, and use the model output. These tutorial materials are designed for the CESM version 2 (CESM2)**
+
+## Yearly In-Person Tutorials
+
+The CESM tutorial was started in 2010 and is typically offered as an in-person summer workshop. If you are interested in attending the tutorial, please see the [CESM webpage](https://www.cesm.ucar.edu/events/tutorials) for the most up to date information about when the tutorial will next be offered in Boulder, Colorado and the timeline for applying.
+
+## CESM Project Funding 
+
+This material is based upon work supported by the National Center for Atmospheric Research (NCAR), which is a major facility sponsored by the National Science Foundation (NSF) under Cooperative Agreement No. 1852977. Staff time on this project was also supported by the Climate and Global Dynamics (CGD) laboratory.
+
+## Acknowledgements
+
+A number of people have been critical to this effort, including:
+- Cecile Hannay, David Bailey, Peter Lawrence, Hui Li, Sophia Macarewich, Jesse Nusbaumer, Adam Phillips, and Kate Thayer-Calder who serve on the CESM tutorial committee and put together the tutorial materials.
+- Alice DuVivier, Brian Dobbins, Gunter Leguy, and Gustavo Marques, who helped test materials and have contributed substantially.
+- Elizabeth Faircloth, who supports the CESM program administratively and without whom everything would probably fall apart.
+- David Lawrence, who supported this effort as CESM chief scientist.
+- Testers, others...
+
+<br>
+
+<div>
diff --git a/_sources/notebooks/basics/basics_overview.ipynb b/_sources/notebooks/basics/basics_overview.ipynb
@@ -0,0 +1,109 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "b2cd974a-dfbb-4937-8ed0-ab87ab60f1ef",
+   "metadata": {},
+   "source": [
+    "# Basics"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9db9d54e-ef78-44ef-a003-4ddd8a416317",
+   "metadata": {},
+   "source": [
+    "The CESM Model is developed around a structured workflow. The first step of this workflow is to set up your workspace, which is usually a one-time task. After setting up your workspace, a basic CESM simulation can be run with only four commands. This section will cover these steps and enable you to complete your first CESM run."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e2abf5cb-c507-408e-8f2a-2fd12934873d",
+   "metadata": {},
+   "source": [
+    "## Workflow Elements"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "acfe09a5-e3ee-457a-a328-bde665cfe761",
+   "metadata": {
+    "jp-MarkdownHeadingCollapsed": true,
+    "tags": []
+   },
+   "source": [
+    "<div class=\"alert alert-info\" style=\"text-align: left;\">\n",
+    "\n",
+    "- Set up workspace (one time setup)\n",
+    "    - **``Download``** the CESM code\n",
+    "    - **``Create or Locate ``** an **``Input Data``** Root Directory\n",
+    "    - Possibly **``Porting``** if not on a setup machine\n",
+    "- Creating, Running and Reviewing a Case\n",
+    "    - **``Create``** a new case\n",
+    "    - **``Invoke``** `case.setup`\n",
+    "    - **``Build``** the executable with `case.build`\n",
+    "    - **``Run``** the model with `case.submit`\n",
+    "    - **``Review``** output data\n",
+    "\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "0c07b51d-f999-4737-9739-3ea989f20802",
+   "metadata": {},
+   "source": [
+    "## Setting up your environment"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9d6954eb-3505-4a58-b6fa-bea7047c63cf",
+   "metadata": {},
+   "source": [
+    "Every time you log onto the NCAR HPC you want to ensure you have the correct modules loaded. Please refer to the NCAR supercomputer section under Resources to make sure you are setting up your environment properly. \n",
+    "\n",
+    "**YOU SHOULD ENSURE YOU CHECK THIS EVERY TIME YOU ARE BUILDING A NEW CASE**\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "523165e7-728b-4305-b9f7-4e6ee530a27d",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "715674b2-a858-49ae-b044-7f7fc61a750c",
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "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.10.13"
+  },
+  "toc-showcode": false
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
diff --git a/_sources/notebooks/basics/cesm_workflow.ipynb b/_sources/notebooks/basics/cesm_workflow.ipynb
@@ -0,0 +1,92 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# CESM Workflow"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "CESM has been designed to be easy to use. Once you have downloaded the CESM code, a CESM `case` can be run with a set of 4 commands. \n",
+    "\n",
+    "*Note: In CESM jargon, a case refers to a specific instance of a model simulation.*"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-info\" style=\"text-align: left;\">\n",
+    "\n",
+    "1) Create a new case using `create_newcase`\n",
+    "2) Set up the case by invoking `case.setup`\n",
+    "3) Build the executable using `case.build`\n",
+    "4) Run your case using `case.submit`\n",
+    "  \n",
+    "</div>\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The following sections will go into more detail about these 4 commands and also provide information about how to check your job status or create a clone of a previous case."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### More information"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "More detailed information on the CESM2 Workflow is documented in the following links and can be read in detail at a later time."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "<div class=\"alert alert-info\" style=\"text-align: center;\">\n",
+    "\n",
+    "[CESM2 release](https://escomp.github.io/CESM/release-cesm2/)\n",
+    "    \n",
+    "[CIME](https://esmci.github.io/cime/versions/master/html/index.html)\n",
+    "\n",
+    "</div>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Bash",
+   "language": "bash",
+   "name": "bash"
+  },
+  "language_info": {
+   "codemirror_mode": "shell",
+   "file_extension": ".sh",
+   "mimetype": "text/x-sh",
+   "name": "bash"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}