Skip to content

Commit 108d16c

Browse files
committed
initiate examples pages
1 parent 7342c81 commit 108d16c

File tree

7 files changed

+91
-0
lines changed

7 files changed

+91
-0
lines changed

docs/assets/ridge1.png

96.3 KB
Loading

docs/assets/ridge2.png

71.6 KB
Loading

docs/assets/ridge3.png

108 KB
Loading

docs/fillindian.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Fill Indian Ocean
2+
=================
3+
4+
Instructions coming soon...

docs/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,10 @@ For more information on each step, please refer to the corresponding sections in
5353
grid
5454
launch
5555
troubleshooting
56+
57+
.. toctree::
58+
:maxdepth: 3
59+
:caption: Examples:
60+
61+
ridge
62+
fillindian

docs/open.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Open:
2+
13
Opening the GUI
24
===============================
35

docs/ridge.rst

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Ridge World
2+
==============================
3+
4+
This example provides step-by-step guidance on how to generate a coupled idealized
5+
configuration that consists of an aquaplanet with land caps at the pole and a narrow
6+
land ridge extending between the two poles, similar to the configuration used in `Wu et al (2021) <https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2021GL093966>`_ .
7+
In the example given below, the visualCaseGen GUI is used to guide users through choosing
8+
their CESM components, setting up all the ocean input files, setting up all the land input
9+
files, and finally setting up and configuring their case.
10+
11+
Here we are not running a standard case with CESM. We are modifying the configuration substantially by changing the ocean grid, ocean bathymetry, continental geometry and land surface properties, so you should select "Custom" here.
12+
13+
14+
Stage 0: Open visualCaseGen
15+
--------------------------
16+
17+
Follow the instructions in the :ref:`Open` to open visualCaseGen in your Jupyter notebook environment.
18+
19+
Stage 1: Select Compset
20+
----------------------
21+
22+
After having executed the cell with the command `from visualCaseGen import gui; gui`,
23+
and clicking the **Start** button, you will see the main interface of visualCaseGen.
24+
25+
Click the **Custom** button to proceed with creating a custom compset for our idealized
26+
Ridge World configuration.
27+
28+
.. image:: assets/stage1_1.png
29+
30+
Initialization time
31+
~~~~~~~~~~~~~~~~~~~
32+
33+
Once the `Custom` button is clicked, you will be prompted to select the initialization time.
34+
For this example, we will select `1850`` as the initialization time.
35+
36+
.. image:: assets/stage1_5.png
37+
38+
39+
Models
40+
~~~~~~
41+
42+
Once you've selected the initialization time, visualCaseGen will prompt you to select the
43+
models for each component class. In this ridge world case we select the following component options:
44+
`cam` as the atmosphere;
45+
`clm`` as the land component; `cice`` as the ice component; `mom`` as the ocean component, `srof``
46+
(i.e., stub run off) as the river component; `sglc`` (i.e., stub land ice) as the land ice component;
47+
and, `swav` (i.e. stub wave) as the wave component. After all the selections are made, the
48+
model matrix should look like:
49+
50+
.. image:: assets/ridge1.png
51+
52+
Model Physics
53+
~~~~~~~~~~~~~
54+
55+
Having selected the models, you will proceed to select the physics options for each. The physics
56+
settings determine the complexity of each model component and impact computational requirements.
57+
For this example, we will select the following physics options which are based on the selections
58+
made in `Wu et al (2021) <https://agupubs.onlinelibrary.wiley.com/doi/full/10.1029/2021GL093966>`_ :
59+
60+
.. image:: assets/ridge2.png
61+
62+
Component Options (Modifiers)
63+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64+
65+
We are now ready to finalize the compset by selecting optional physics modifiers. For this example,
66+
we will select `(none)` for all the components except for the `clm` component where we will select
67+
the satellite phenology (SP) mode for the land which means that aspects of the land model such as
68+
leaf-area index are prescribed as opposed to being prognosed interactively by the land biogeochemistry.
69+
70+
.. image:: assets/ridge3.png
71+
72+
Stage 2: Grid
73+
----------------------
74+
Having completed the compset configuration, you will now proceed to the `Grid` stage ...
75+
76+
Further instructions will be added as the example is developed...
77+
78+

0 commit comments

Comments
 (0)