Skip to content

Commit b6e9e3d

Browse files
committed
fix image paths in docs
1 parent f5c65e4 commit b6e9e3d

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/compset.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,20 +76,20 @@ coupler infrastructure but have no impact on the simulation. This variety allows
7676
configure a custom compset that includes as many or as few active components as desired,
7777
depending on the specific goals of your simulation.
7878

79-
.. image:: assets/stage1_6.png
79+
.. image:: assets/Stage1_6.png
8080

8181
As you make selections in this stage and elsewhere, visualCaseGen will guide you by crossing
8282
out incompatible options, helping to prevent invalid configurations. For example, if you select
8383
`cam` for the atmosphere and `mom` for the ocean, the GUI will disable several other model
8484
options that are incompatible with this combination. This real-time feedback keeps your
8585
configuration process streamlined and ensures that all selected options work together compatibly.
8686

87-
.. image:: assets/stage1_7.png
87+
.. image:: assets/Stage1_7.png
8888

8989
At any stage, you can click on any crossed-out option to view a brief explanation of
9090
why it's incompatible with your current selections for additional guidance.
9191

92-
.. image:: assets/stage1_8.png
92+
.. image:: assets/Stage1_8.png
9393

9494
After choosing your models, you'll proceed to select the physics options for each. The physics
9595
settings determine the complexity of each model component and impact computational requirements.
@@ -100,7 +100,7 @@ will be selected by default. Since each physics option provides different levels
100100
the selection should be based on the specific requirements of your simulation. Refer to
101101
the individual model documentations for more information on the available physics options.
102102

103-
.. image:: assets/stage1_9.png
103+
.. image:: assets/Stage1_9.png
104104

105105
The final part of custom compset creation is selecting optional physics modifiers.
106106
Modifiers allow additional adjustments to physics and parameter settings, offering
@@ -113,7 +113,7 @@ does not verify compatibility between multiple modifiers within a single compone
113113
so it's advisable to consult CESM documentation or model experts if you're using complex
114114
modifier combinations.
115115

116-
.. image:: assets/stage1_10.png
116+
.. image:: assets/Stage1_10.png
117117

118118
Once you've completed the selection of models, physics, and optional modifiers,
119119
visualCaseGen will automatically advance to the next main stage, `Grid`, where

docs/grid.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ existing model grids. In `Custom` mode, you can also generate custom model grids
88
using auxiliary tools included in visualCaseGen. Begin by selecting between `Standard`
99
and `Custom` grid modes.
1010

11-
.. image:: assets/stage2_1.png
11+
.. image:: assets/Stage2_1.png
1212

1313
.. note:: In CESM terminology, *resolution* and *grid* are often used interchangeably,
1414
both referring to the combination of model grids used in a CESM simulation. Unless
@@ -25,7 +25,7 @@ from this list. Use the search box to refine the list further. For exact matches
2525
use double quotes; otherwise, the search will display all grids containing one
2626
or more of the search terms.
2727

28-
.. image:: assets/stage2_2.png
28+
.. image:: assets/Stage2_2.png
2929

3030
After selecting a grid, visualCaseGen will advance to the `Launch` stage, where
3131
you can create your CESM case using the chosen compset and grid configuration.
@@ -38,13 +38,13 @@ model grids or generating new MOM6 and/or CLM grids with specialized tools that
3838
Start by specifying a path to save the new grid files and a name to refer to this
3939
new grid in the configuration process and beyond.
4040

41-
.. image:: assets/stage2_3.png
41+
.. image:: assets/Stage2_3.png
4242

4343
After clicking `Select`, a file browser will open to help you locate your preferred
4444
directory for saving the new grid files. Once the directory is selected, enter the
4545
new grid name in the text box at the top right and click `Select` to proceed.
4646

47-
.. image:: assets/stage2_4.png
47+
.. image:: assets/Stage2_4.png
4848

4949
Atmosphere Grid
5050
~~~~~~~~~~~~~~~
@@ -53,7 +53,7 @@ Next, choose an atmosphere grid from the list of compatible options based on the
5353
compset you selected in the `Compset` stage. Use the search box to filter options if needed.
5454
This chosen atmosphere grid will be integrated with other model grids to form your custom CESM grid (resolution).
5555

56-
.. image:: assets/stage2_5.png
56+
.. image:: assets/Stage2_5.png
5757

5858
Ocean Grid
5959
~~~~~~~~~~
@@ -67,7 +67,7 @@ If using a standard ocean grid, select one from the list compatible with your ch
6767
and atmosphere grid. If creating a new MOM6 grid, complete the required parameters, then proceed
6868
to launch the `mom6_bathy` tool for final customization.
6969

70-
.. image:: assets/stage2_6.png
70+
.. image:: assets/Stage2_6.png
7171

7272
After specifying all ocean grid parameters, click `Launch mom6_bathy`. This will open an
7373
auto-generated Jupyter notebook where you can fine-tune the ocean grid bathymetry and generate
@@ -86,7 +86,7 @@ Following ocean grid selection or creation, you'll move to land grid selection.
8686
as the land model, you can also modify an existing CLM grid. If so, select a base land grid for
8787
customization.
8888

89-
.. image:: assets/stage2_7.png
89+
.. image:: assets/Stage2_7.png
9090

9191
.. note:: Detailed instructions on customizing an existing CLM grid will be added here shortly.
9292

docs/launch.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The final main stage of visualCaseGen is the `Launch` stage, where you bring you
55
life with the selected compset and grid configuration. In this stage, you'll find tools to
66
select the case directory, choose a target machine, and initiate case creation.
77

8-
.. image:: assets/stage3_1.png
8+
.. image:: assets/Stage3_1.png
99

1010
Chosing the case directory
1111
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -14,7 +14,7 @@ To begin, open the file browser widget by clicking the `Select` button to set th
1414
the new case. Navigate to your desired location, then enter a unique name for the case in the
1515
text box at the top right of the browser. Click `Select` to confirm your directory and case name.
1616

17-
.. image:: assets/stage3_2.png
17+
.. image:: assets/Stage3_2.png
1818

1919
Selecting the target machine
2020
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -40,7 +40,7 @@ example of the interface after clicking `Create Case`. Notice how visualCaseGen
4040
case setup process, including modifying CESM XML files, executing the create_newcase tool,
4141
running the `case.setup` script, and applying any XML and namelist changes needed.
4242

43-
.. image:: assets/stage3_3.png
43+
.. image:: assets/Stage3_3.png
4444

4545
The completion log provides confirmation of a successful case creation, including the path to
4646
the new case directory, where you can proceed with case customization, building, and execution.

0 commit comments

Comments
 (0)