Skip to content

Commit efbe23e

Browse files
committed
Add new section describing all current CAM_CONFIG_OPTS options for CAM-SIMA.
1 parent c8012ce commit efbe23e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/usage/creating-a-case.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Many configurable settings can be found within the env_*.xml files in your case
7676
- `CAM_CONFIG_OPTS`: This is where we tell CAM-SIMA what physics scheme(s) we wish to run, as well as if we wish to run the `null` dycore.
7777
- FKESSLER will default to `--physics-suites kessler --analytic_ic`, which means we're running the `suite_kessler.xml` SDF with the SE dycore (with analytic initial conditions - no need to supply an ncdata initial conditions file)
7878
- If you instead want to run a test with the null dycore, you'll want to change this with `./xmlchange CAM_CONFIG_OPTS = "--physics-suites kessler --dyn none"`
79+
- A list of all possible configuration options can be found at the bottom of this page, or [here](#current-can_config_opts-options-in-cam-sima)
7980
- `CAM_LINKED_LIBS`: Hopefully, you won't have to change this often; however, if you are getting linking errors during your build, try turning off the linked libraries (`./xmlchange CAM_LINKED_LIBS=''`)
8081
- `DOUT_S`: This is the flag to archive log files of successful runs. During development, we advise turning this off so your log files don't disappear on you (`./xmlchange DOUT_S=False`)
8182
- `STOP_OPTION` & `STOP_N`: How long you are going to run the model. If `STOP_N` is 8 and `STOP_OPTION` is "ndays", you are setting the model up to run for 8 days.
@@ -110,3 +111,30 @@ The job will be submitted to the system's queue. You can see the status of your
110111

111112
[Debugging tips](../development/debugging.md#run-time-errors)
112113

114+
## Current CAN_CONFIG_OPTS options in CAM-SIMA
115+
116+
The following is a list of all the allowed options that can be included in `CAM_CONFIG_OPTS`, what each option does, whether or not they are required (and if not what the dfault value is), and what config variable it maps to in the `ConfigCAM` code.
117+
118+
- **physics-suites** (required)
119+
- usage example: `--physics-suites cam7`
120+
- purpose: Specifies what CCPP physics suite(s) will be built and made available for the given case. More than one suite can be specified using a semi-colon, e.g. `cam4;cam7`.
121+
- configCAM variable: `physics_suites`
122+
- **dyn** (required)
123+
- usage example: `--dyn mpas`
124+
- purpose: Specifies what dynamical core will be built and made available for the given case.
125+
- ConfigCAM variable: `dyn`
126+
- **analytic-ic** (optional)
127+
- useage example: `--analytic-ic`
128+
- purpose: Specifies whether Analytic Initial Conditions (IC) will be used for the given case.
129+
- default value: `False` (file-provided ICs will be used instead)
130+
- ConfigCAM variable: `analytic_ic`
131+
- **dyn-kind** (optional)
132+
- useage example: `--dyn-kind REAL64`
133+
- purpose: Specifies the precision used by the dycore for real-type variables. Currently the only two options are `REAL64` for double precision and `REAL32` for single precision.
134+
- default value: `REAL64`
135+
- ConfigCAM variable: `dyn_kind`
136+
- **phys-kind**
137+
- useage example: `--phys-kind REAL64`
138+
- purpose: Specifies the precision used by the physics for real-type variables. Currently the only two options are `REAL64` for double precision and `REAL32` for single precision.
139+
- default value: `REAL64`
140+
- ConfigCAM variable: `phys_kind`

0 commit comments

Comments
 (0)