Skip to content

Commit c143e2c

Browse files
authored
Documentation: Small update (#64)
* doc: typo fix * doc: additional information on namelist files / history files
1 parent 73df087 commit c143e2c

2 files changed

Lines changed: 12 additions & 4 deletions

File tree

docs/users_guide/case_examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Runnning example cases
1+
# Running example cases
22

33
Always load the eCLM environment before creating a case. This only needs to be done once per terminal session.
44

docs/users_guide/running_eCLM/case_customization.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
# Case customization
22

3-
eCLM uses various namelist files that handle different settings and configurations for running a case. These namelists are similar to CLM5 (only the editing is different) so that you can refer to <a href="https://escomp.github.io/ctsm-docs/versions/release-clm5.0/html/users_guide/setting-up-and-running-a-case/customizing-the-clm-namelist.html#" target="_blank">Section 1.2.3 and 1.2.4 of the CLM5 User's Guide</a> for more detailed information.
3+
eCLM uses various **namelist files** that handle different settings and configurations for running a case.
4+
Namelist files are text files, where the user can provide values for various input fields, called **namelist items**.
5+
Namelist items are parsed by eCLM and connected internal variables are set according to their values.
6+
eCLM's namelist files are very similar to the namelist files used in CLM5 (only the editing is different) so that you can refer to <a href="https://escomp.github.io/ctsm-docs/versions/release-clm5.0/html/users_guide/setting-up-and-running-a-case/customizing-the-clm-namelist.html#" target="_blank">Section 1.2.3 and 1.2.4 of the CLM5 User's Guide</a> for more detailed information.
47

58
The eCLM namelist files are:
69
- Land model namelist `lnd_in` (see <a href="https://docs.cesm.ucar.edu/models/cesm2/settings/2.1.0/clm5_0_nml.html" target="_blank">here</a> for definitions of namelist items)
@@ -61,7 +64,12 @@ Important namelist parameter in the `drv_in` are:
6164

6265
## 3. Customizing case output
6366

64-
To customize your simulation output, you can specify the history field options in the namelist file `lnd_in`. By default, there is one stream of monthly data files. The field options to customize are:
67+
To customize your simulation output, you can specify the history field
68+
options in the namelist file `lnd_in`.
69+
By default, there is one stream of monthly data files called history
70+
files.
71+
History files are in NetCDF format.
72+
The field options to customize are:
6573

6674
- `hist_fincl1`: The list of history variables that you want to analyze
6775
- `hist_mfilt`: The number of records within one output file. Default is 1.
@@ -103,4 +111,4 @@ You can then submit the job.
103111
sbatch run-eclm-job.sh
104112
```
105113

106-
You can monitor your job using `sacct` or `squeue -u $USER`.
114+
You can monitor your job using `sacct` or `squeue -u $USER`.

0 commit comments

Comments
 (0)