Skip to content

Documentation: Small update #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jjokella merged 2 commits into from
May 6, 2025
Merged

Documentation: Small update #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3df2529
doc: typo fix
jjokella May 6, 2025
6911edd
doc: additional information on namelist files / history files
jjokella May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/users_guide/case_examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Runnning example cases
# Running example cases

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

Expand Down
14 changes: 11 additions & 3 deletions docs/users_guide/running_eCLM/case_customization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Case customization

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.
eCLM uses various **namelist files** that handle different settings and configurations for running a case.
Namelist files are text files, where the user can provide values for various input fields, called **namelist items**.
Namelist items are parsed by eCLM and connected internal variables are set according to their values.
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.

The eCLM namelist files are:
- 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)
Expand Down Expand Up @@ -61,7 +64,12 @@ Important namelist parameter in the `drv_in` are:

## 3. Customizing case output

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:
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 called history
files.
History files are in NetCDF format.
The field options to customize are:

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

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