|
| 1 | +Stage 1/3: Compset |
| 2 | +================== |
| 3 | + |
| 4 | +In this stage, the component set (compset), i.e., the collection of models (`cam`, `clm`, `mom`, etc), physics |
| 5 | +(`CAM70`, `CLM50`, `MOM6`, etc), and component options. e.g., `LT` (low top), `SP` (satellite phenology), `MARBL-BIO`, |
| 6 | +etc. are determined. |
| 7 | +You'll start by choosing between the `Standard` compset mode, which provides predefined and stable CESM configurations, |
| 8 | +and the `Custom` compset mode, which allows for more tailored combinations for unique experiments. |
| 9 | + |
| 10 | +.. image:: assets/stage1_1.png |
| 11 | + |
| 12 | +Standard Compsets |
| 13 | +------------------ |
| 14 | + |
| 15 | +- **Support Level:** You can select from a list of all standard compsets or only those that are scientifically |
| 16 | + supported. `Supported` compsets have been validated by CESM developers, ensuring they produce |
| 17 | + scientifically vetted results. These are typically recommended for production runs. The `All` option, |
| 18 | + however, includes experimental compsets that may not be validated but can be useful for testing and |
| 19 | + development. Selecting a supported compset ensures that you are working with configurations approved |
| 20 | + for stability and accuracy, while the `All` option offers broader but potentially unstable options for |
| 21 | + specialized needs. |
| 22 | + |
| 23 | + .. image:: assets/stage1_2.png |
| 24 | + |
| 25 | +- **Models to Include:** If you choose the `Supported` option, a list of scientifically validated |
| 26 | + compsets will appear for you to choose from. However, if you choose the `All` option, you'll be |
| 27 | + presented with a *model matrix* to refine the list of compsets displayed. This matrix allows you |
| 28 | + to specify which model components you want to include. For instance, if you select `cam` as the |
| 29 | + atmosphere model and `mom` as the ocean model, the list will filter down to include only those |
| 30 | + compsets that incorporate both. If you're flexible with certain components, you can select `any` |
| 31 | + for those classes, or click the `Defaults` button in the Stage top bar to apply typical defaults |
| 32 | + for all components, streamlining your selection. This feature is particularly useful if you're |
| 33 | + unsure about specific settings or wish to adhere to commonly used configurations. |
| 34 | + |
| 35 | + .. image:: assets/stage1_3.png |
| 36 | + |
| 37 | +- **Standard Compsets List:** After refining your options, visualCaseGen will display a list of |
| 38 | + matching compsets. Each compset is labeled with an alias and incorporates an initialization time |
| 39 | + and a short description of the included models, providing a snapshot of each configuration. |
| 40 | + To narrow down the list further, you can use the search box above the list. Typing keywords |
| 41 | + in the search box will display all compsets containing one or more of the search terms. For |
| 42 | + precise filtering, use double quotes around terms for exact matches. This flexibility makes |
| 43 | + it easy to locate specific compsets or explore different configurations to find the most |
| 44 | + suitable one for your simulation needs. |
| 45 | + |
| 46 | + .. image:: assets/Stage1_4.png |
| 47 | + |
| 48 | +After selecting a compset, visualCaseGen will guide you to the next primary stage, `Grid`, where |
| 49 | +you'll select a model resolution compatible with your chosen compset. |
| 50 | + |
| 51 | +Custom Compsets |
| 52 | +------------------ |
| 53 | + |
| 54 | +.. note:: |
| 55 | + If you initially selected the `Standard` compset mode, the `Custom` compset stages will not |
| 56 | + display, and instead visualCaseGen will proceed directly to the `Grid` stage. To switch to the `Custom` |
| 57 | + compset mode after already completing the `Standard` compset stages, you can click `Revert` |
| 58 | + buttons to navigate back to the selection of configuration mode. |
| 59 | + |
| 60 | +If you prefer to build a custom compset, visualCaseGen provides a step-by-step process, |
| 61 | +starting with the initialization time for your experiment. This choice impacts the initial |
| 62 | +conditions and forcings for your simulation. You can choose from: |
| 63 | + |
| 64 | +- 1850: Represents pre-industrial conditions and is suitable for fixed-time-period runs, such as for model spin-ups. |
| 65 | +- 2000: Represents modern-day conditions, also appropriate for fixed-period simulations. |
| 66 | +- HIST: Represents a historical run setup, which covers transient simulations (e.g., from 1850 through 2015) that evolve with changing conditions over time. |
| 67 | + |
| 68 | + .. image:: assets/stage1_5.png |
| 69 | + |
| 70 | +Once you've selected the initialization time, visualCaseGen will prompt you to select the |
| 71 | +models for each component class. You'll see options that include active models, data models |
| 72 | +(prefixed with d, like `datm`), and stub models (prefixed with s, like `sice`). Data models |
| 73 | +perform the basic function of reading preexisting forcing data, modifying that data, and then |
| 74 | +sending it to active models via the coupler. Stub models act as placeholders required by the CESM |
| 75 | +coupler infrastructure but have no impact on the simulation. This variety allows you to |
| 76 | +configure a custom compset that includes as many or as few active components as desired, |
| 77 | +depending on the specific goals of your simulation. |
| 78 | + |
| 79 | + .. image:: assets/Stage1_6.png |
| 80 | + |
| 81 | +As you make selections in this stage and elsewhere, visualCaseGen will guide you by crossing |
| 82 | +out incompatible options, helping to prevent invalid configurations. For example, if you select |
| 83 | +`cam` for the atmosphere and `mom` for the ocean, the GUI will disable several other model |
| 84 | +options that are incompatible with this combination. This real-time feedback keeps your |
| 85 | +configuration process streamlined and ensures that all selected options work together compatibly. |
| 86 | + |
| 87 | + .. image:: assets/Stage1_7.png |
| 88 | + |
| 89 | +At any stage, you can click on any crossed-out option to view a brief explanation of |
| 90 | +why it's incompatible with your current selections for additional guidance. |
| 91 | + |
| 92 | + .. image:: assets/Stage1_8.png |
| 93 | + |
| 94 | +After choosing your models, you'll proceed to select the physics options for each. The physics |
| 95 | +settings determine the complexity of each model component and impact computational requirements. |
| 96 | +Higher version numbers indicate newer and more complex physics for a given model. Depending on |
| 97 | +the model, you may have multiple physics options available. For example, `cam` and |
| 98 | +`clm` have multiple physics options, while other models may offer only one, in which case it |
| 99 | +will be selected by default. Since each physics option provides different levels of model complexity, |
| 100 | +the selection should be based on the specific requirements of your simulation. Refer to |
| 101 | +the individual model documentations for more information on the available physics options. |
| 102 | + |
| 103 | + .. image:: assets/Stage1_9.png |
| 104 | + |
| 105 | +The final part of custom compset creation is selecting optional physics modifiers. |
| 106 | +Modifiers allow additional adjustments to physics and parameter settings, offering |
| 107 | +further customization to meet modeling requirements and goals. Each component class |
| 108 | +is represented in individual tabs within this stage. You can switch between tabs to |
| 109 | +select modifiers or opt out of a modifier by choosing `(none)`. Tabs with available |
| 110 | +modifiers will display a red question mark until a selection is made. While you can |
| 111 | +select multiple modifiers for a single component class, be cautious: visualCaseGen |
| 112 | +does not verify compatibility between multiple modifiers within a single component, |
| 113 | +so it's advisable to consult CESM documentation or model experts if you're using complex |
| 114 | +modifier combinations. |
| 115 | + |
| 116 | + .. image:: assets/Stage1_10.png |
| 117 | + |
| 118 | +Once you've completed the selection of models, physics, and optional modifiers, |
| 119 | +visualCaseGen will automatically advance to the next main stage, `Grid`, where |
| 120 | +you'll select a model resolution compatible with your chosen compset. |
| 121 | + |
0 commit comments