Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions .github/workflows/gh-page_builder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@ name: JupyterBook
#name: Build and Publish JupyterBook to GitHub Pages
#
on:
[push, workflow_dispatch]
push:
branches:
- main
workflow_dispatch:
pull_request:

jobs:
build:
Expand All @@ -14,16 +18,18 @@ jobs:
uses: actions/setup-python@v6
with:
python-version: 3.9
cache: 'pip'
- name: Install Python dependencies
run: |
sudo apt-get install python3-pip
pip install ghp-import
pip install "jupyter-book<2"
pip install -r requirements.txt
PATH="${PATH}:${HOME}/.local/bin"
- name: Build book HTML
run: |
jupyter-book build .
jupyter-book build -W --keep-going .
- name: Push _build/html to gh-pages
# The below condition allows publication on pushes to main (including PR merges) as well as workflow_dispatch from main.
if: github.ref == 'refs/heads/main'
run: |
sudo chown -R $(whoami):$(whoami) .
git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com"
Expand Down
6 changes: 6 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ logo: images/ncar_logo.png
# Removing CESM2 Porting for 2026 tutorial (need to update to CESM3 in future)
exclude_patterns:
- notebooks/resources/porting.ipynb
- notebooks/challenge/cam/exercice_overview.ipynb
- notebooks/modifications/xml/copying_cases.ipynb
- notebooks/modifications/xml/run_length/number_of_submissions.ipynb
- notebooks/resources/ncar_hpc_login.ipynb
- notebooks/resources/profile.ipynb
- notebooks/resources/tutorial_specific.ipynb

sphinx:
config:
Expand Down
7 changes: 7 additions & 0 deletions notebooks/challenge/cam-chem_waccm/cam-chem_waccm.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
"cells": [
{
"cell_type": "markdown",
"id": "a71d9f66-43a6-4dc7-9252-5b2fb07690e3",
"metadata": {},
"source": [
"# Atmospheric chemistry"
]
},
{
"cell_type": "markdown",
"id": "2d89d5b4-5af7-4a24-926d-65d8a997ea55",
"metadata": {
"tags": []
},
Expand All @@ -22,6 +24,7 @@
},
{
"cell_type": "markdown",
"id": "f60c6c06-4b10-41a0-b3e8-853a59b93f36",
"metadata": {},
"source": [
"## CAM-chem and WACCM component sets\n",
Expand All @@ -42,6 +45,7 @@
}
},
"cell_type": "markdown",
"id": "cf000a8d-c6e3-497f-8646-1e16d8988097",
"metadata": {},
"source": [
"## CAM-chem and WACCM F component sets\n",
Expand All @@ -61,6 +65,7 @@
},
{
"cell_type": "markdown",
"id": "fe3ca599-d884-4277-b421-2fbaafe4d93a",
"metadata": {},
"source": [
"## Overview of the Challenge Exercises for CAM-chem/WACCM\n",
Expand All @@ -74,6 +79,7 @@
},
{
"cell_type": "markdown",
"id": "7dffcef5-b06d-4143-bab6-29cd90aff98a",
"metadata": {},
"source": [
"_______________\n",
Expand All @@ -94,6 +100,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "e60af30a-2425-4412-9a67-40ac6656c186",
"metadata": {},
"outputs": [],
"source": []
Expand Down
5 changes: 5 additions & 0 deletions notebooks/challenge/cam-chem_waccm/exercise_1.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
"cells": [
{
"cell_type": "markdown",
"id": "f97c18d1-eee0-4074-96d2-5a62d026ccd7",
"metadata": {},
"source": [
"# 1: Control case: running with chemistry"
]
},
{
"cell_type": "markdown",
"id": "4a876c90-5738-47d2-921a-4ba392725130",
"metadata": {},
"source": [
"\n",
Expand All @@ -29,6 +31,7 @@
},
{
"cell_type": "markdown",
"id": "a45d3bf8-9b01-4d16-8c7f-36cfad680884",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -82,6 +85,7 @@
},
{
"cell_type": "markdown",
"id": "4226f4d2-98e9-4d4c-8a7e-facb39dac400",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -227,6 +231,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "73087ac0-96a1-4915-a00e-118adab201f7",
"metadata": {},
"outputs": [],
"source": []
Expand Down
5 changes: 5 additions & 0 deletions notebooks/challenge/cam-chem_waccm/exercise_2.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
"cells": [
{
"cell_type": "markdown",
"id": "06e86d57-b628-4ac6-b709-5ce8471e387e",
"metadata": {},
"source": [
"# 2: Test case: changing the chemistry"
]
},
{
"cell_type": "markdown",
"id": "9e78e571-ea6c-4017-a309-d880fda4a95c",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -44,6 +46,7 @@
},
{
"cell_type": "markdown",
"id": "0f49fdeb-2f0a-408f-b9ff-ad5e85af714e",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -84,6 +87,7 @@
},
{
"cell_type": "markdown",
"id": "210f69f4-96f6-47ed-b5fc-0422b6996f11",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -252,6 +256,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "1c346bc1-47f4-4bed-b53c-c16d88ee5f00",
"metadata": {},
"outputs": [],
"source": []
Expand Down
5 changes: 5 additions & 0 deletions notebooks/challenge/cam-chem_waccm/exercise_3.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
"cells": [
{
"cell_type": "markdown",
"id": "e516483d-290b-4a13-b3f2-3c36d74ba443",
"metadata": {},
"source": [
"# 3: Test case: changing the emissions"
]
},
{
"cell_type": "markdown",
"id": "fa4eb23f-ced7-4c49-b80e-8e11b35e27d5",
"metadata": {},
"source": [
"\n",
Expand All @@ -29,6 +31,7 @@
},
{
"cell_type": "markdown",
"id": "37626595-43cf-490a-908b-23f1f5fe8507",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -58,6 +61,7 @@
},
{
"cell_type": "markdown",
"id": "ee1de48c-2096-4274-be27-3670737e2d99",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -325,6 +329,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "8f7ed79f-be6d-44af-9144-b2cece9013c2",
"metadata": {},
"outputs": [],
"source": []
Expand Down
3 changes: 3 additions & 0 deletions notebooks/challenge/cam-chem_waccm/visualization.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
"cells": [
{
"cell_type": "markdown",
"id": "fc8f1fa6-d1ee-4140-ba7a-448d827e4b84",
"metadata": {},
"source": [
"# 4: Visualization option with GEOV"
]
},
{
"cell_type": "markdown",
"id": "90c45506-cd94-4c2d-948e-b1d6e5b16719",
"metadata": {},
"source": [
"\n",
Expand Down Expand Up @@ -55,6 +57,7 @@
{
"cell_type": "code",
"execution_count": null,
"id": "9e3ed3d5-d6c0-4365-9cdb-93b6e7cccb99",
"metadata": {},
"outputs": [],
"source": []
Expand Down
4 changes: 2 additions & 2 deletions notebooks/challenge/cam/exercise_3.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@
"\n",
"___\n",
"\n",
"### **Verify the Configuration**\n",
"## **Verify the Configuration**\n",
"\n",
"**# Check the Run Type**\n",
"```\n",
Expand Down Expand Up @@ -341,7 +341,7 @@
"\n",
"___\n",
"\n",
"### **Check your solution**\n",
"## **Check your solution**\n",
"\n",
"When the run is completed, look at the history files into the archive directory. \n",
" \n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/challenge/cice/cice.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"source": [
"<div class=\"alert alert-info\" style=\"text-align: center;\">\n",
"\n",
"[Compset Definitions]()\n",
"[Compset Definitions](https://www2.cesm.ucar.edu/models/cesm2/config/compsets.html)\n",
"\n",
"</div>"
]
Expand Down
8 changes: 4 additions & 4 deletions notebooks/challenge/cism/cism_exercise_2.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"id": "916e2e9b-fd7e-4fc3-83f9-4f69c052a16b",
"metadata": {},
"source": [
"### Loading packages"
"## Loading packages"
]
},
{
Expand Down Expand Up @@ -74,7 +74,7 @@
"id": "071fa04b-c689-4c76-8da6-eed739ca6398",
"metadata": {},
"source": [
"### Set your user name "
"## Set your user name "
]
},
{
Expand All @@ -92,7 +92,7 @@
"id": "177b05f1-ec2b-4086-9f26-2234c19d18c6",
"metadata": {},
"source": [
"### Set the 2 years you would like to compare"
"## Set the 2 years you would like to compare"
]
},
{
Expand All @@ -111,7 +111,7 @@
"id": "e57243eb-3968-4a6d-9e6a-b477507507ed",
"metadata": {},
"source": [
"### Defining the path and filenames "
"## Defining the path and filenames "
]
},
{
Expand Down
13 changes: 4 additions & 9 deletions notebooks/challenge/clm_ctsm/clm_ctsm.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -131,19 +131,14 @@
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"id": "06a6c211",
"metadata": {
"vscode": {
"languageId": "shellscript"
}
},
"outputs": [],
"metadata": {},
"source": [
"```bash\n",
"cd /glade/u/home/$USER/code/my_cesm_code\n",
"cime/scripts/query_config --compsets clm | grep \"I2000Clm60Sp \"\n",
"\n"
"```"
]
},
{
Expand Down
13 changes: 4 additions & 9 deletions notebooks/challenge/clm_ctsm/clm_exercise_2.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,14 @@
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"id": "b4513705",
"metadata": {
"vscode": {
"languageId": "shellscript"
}
},
"outputs": [],
"metadata": {},
"source": [
"```bash\n",
"cd /glade/u/home/$USER/code/my_cesm_code\n",
"cime/scripts/query_config --compsets clm | grep \"I2000Clm60Sp \"\n",
"\n"
"```"
]
},
{
Expand Down
13 changes: 4 additions & 9 deletions notebooks/challenge/clm_ctsm/clm_exercise_3.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -60,19 +60,14 @@
]
},
{
"cell_type": "code",
"execution_count": null,
"cell_type": "markdown",
"id": "286afe86",
"metadata": {
"vscode": {
"languageId": "shellscript"
}
},
"outputs": [],
"metadata": {},
"source": [
"```bash\n",
"cd /glade/u/home/$USER/code/my_cesm_code\n",
"cime/scripts/query_config --compsets clm | grep \"I2000Clm60FatesSpCrujraRsGs \"\n",
"\n"
"```"
]
},
{
Expand Down
Loading
Loading