Skip to content

Commit

Permalink
fix image paths in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alperaltuntas committed Oct 31, 2024
1 parent 729c9cb commit edd004c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions docs/compset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,20 +76,20 @@ coupler infrastructure but have no impact on the simulation. This variety allows
configure a custom compset that includes as many or as few active components as desired,
depending on the specific goals of your simulation.

.. image:: assets/stage1_6.png
.. image:: assets/Stage1_6.png

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

.. image:: assets/stage1_7.png
.. image:: assets/Stage1_7.png

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

.. image:: assets/stage1_8.png
.. image:: assets/Stage1_8.png

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

.. image:: assets/stage1_9.png
.. image:: assets/Stage1_9.png

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

.. image:: assets/stage1_10.png
.. image:: assets/Stage1_10.png

Once you've completed the selection of models, physics, and optional modifiers,
visualCaseGen will automatically advance to the next main stage, `Grid`, where
Expand Down
14 changes: 7 additions & 7 deletions docs/grid.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ existing model grids. In `Custom` mode, you can also generate custom model grids
using auxiliary tools included in visualCaseGen. Begin by selecting between `Standard`
and `Custom` grid modes.

.. image:: assets/stage2_1.png
.. image:: assets/Stage2_1.png

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

.. image:: assets/stage2_2.png
.. image:: assets/Stage2_2.png

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

.. image:: assets/stage2_3.png
.. image:: assets/Stage2_3.png

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

.. image:: assets/stage2_4.png
.. image:: assets/Stage2_4.png

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

.. image:: assets/stage2_5.png
.. image:: assets/Stage2_5.png

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

.. image:: assets/stage2_6.png
.. image:: assets/Stage2_6.png

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

.. image:: assets/stage2_7.png
.. image:: assets/Stage2_7.png

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

Expand Down
6 changes: 3 additions & 3 deletions docs/launch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The final main stage of visualCaseGen is the `Launch` stage, where you bring you
life with the selected compset and grid configuration. In this stage, you'll find tools to
select the case directory, choose a target machine, and initiate case creation.

.. image:: assets/stage3_1.png
.. image:: assets/Stage3_1.png

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

.. image:: assets/stage3_2.png
.. image:: assets/Stage3_2.png

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

.. image:: assets/stage3_3.png
.. image:: assets/Stage3_3.png

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

0 comments on commit edd004c

Please sign in to comment.