forked from ESCOMP/CTSM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
124 lines (103 loc) · 6.84 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
README 02/05/2018
Community Land Surface Model (CLM) science version 5.0.0 series -- source code, tools,
offline-build and test scripts. This gives you everything you need
to run CLM with CESM with datm8 to provide CRU NCEP or GSWP3 forcing data in
place of a modeled atmosphere.
General directory structure:
doc --------------- Documentation of CLM.
bld --------------- Template, configure and build-namelist scripts for clm.
src --------------- CLM Source code.
test -------------- CLM Testing scripts for CLM offline tools.
tools ------------- CLM Offline tools to prepare input datasets and process output.
cime_config ------- Configuration files of cime for compsets and CLM settings
manage_externals -- Script to manage the external source directories
cime/scripts --------------- CPL7 scripts
cime/src/drivers/mct/main ----------- CESM top level driver source code.
cime/src/drivers/mct/shr ------------ CESM top level driver shared code.
cime/src/components/data_comps/datm - CESM Data model version 8 source code.
components/cism --------------------- CESM Community land Ice Sheet Model.
components/mosart ------------------- Model for Scale Adaptive River Transport
components/rtm ---------------------- CESM River Transport Model.
cime/src/components/stub_comps/sice - CESM stub sea-ice model source code.
cime/src/components/stub_comps/socn - CESM stub ocean model source code.
cime/src/components/stub_comps/sglc - CESM stub glacier model source code.
cime/src/externals ------------------ CESM external utility codes
(Model Coupling Toolkit (MCT)
(Earth System Model Framework)
(timing -- code timing utility)
(pio -- Parallel Input/Output)
Top level documentation:
README ------------------- This file
README_EXTERNALS.rst ----- Information on how to work with subversion externals for clm
Copyright ---------------- CESM Copyright file
doc/UpdateChangeLog.pl ------- Script to add documentation on a tag to the
ChangeLog/ChangeSum files
doc/ChangeLog ---------------- Documents different CLM versions
doc/ChangeSum ---------------- Summary documentation of different CLM versions
Documentation of Namelist Items: (view the following in a web browser)
components/clm/bld/namelist_files/namelist_definition.xml --- Definition of all namelist items
components/clm/bld/namelist_files/namelist_defaults_clm4_5.xml - Default values for CLM4.5/CLM5.0
=============================================================================================
Important files in main directories:
=============================================================================================
Externals.cfg --------------- File for management of the main high level externals
Externals_CLM.cfg ----------- File for management of the CLM specific externals (i.e. FATES)
parse_cime.cs.status -------- Script to parse test status files cs.status.* created by create_test
doc/Quickstart.GUIDE -------- Quick guide to using cpl7 scripts.
doc/Quickstart.userdatasets - Quick guide to using your own datasets.
doc/IMPORTANT_NOTES --------- Some important notes about this version of
clm, configuration modes and namelist items
that are not validated or functional.
doc/KnownBugs --------------- List of known bugs.
doc/KnownLimitations -------- List of known limitations and workarounds.
doc/ChangeLog --------------- Detailed list of changes for each model version.
doc/ChangeSum --------------- Summary one-line list of changes for each
model version.
doc/README ------------------ Documentation similar to this file
doc/UsersGuide -------------- CLM Users Guide
doc/CodeReference ----------- CLM Code Reference Guide
bld/configure --------------- Script to prepare CLM to be built.
test/tools/test_driver.sh -- Script for general software testing of
CLM's offline tools.
tools/clm4_5/mksurfdata_map --- Directory to build program to create surface dataset
at any resolution.
tools/clm4_5/interpinic ------- Directory to build program to interpolate initial
conditions to any resolution.
tools/shared/mkdatadomain ----- Directory to build program to create datm7 or docn7
domain files from clm files.
tools/shared/mkprocdata_map --- Process history data from unstructed grids to a gridded
format.
tools/shared/ncl_scripts ----- Directory of NCL and perl scripts to do various
tasks. Most notably to plot perturbation error growth
testing and to extract regional information from
global datasets for single-point/regional simulations.
bld/README ------------- Description of how to use the configure and
build-namelist scripts.
=============================================================================================
Source code directory structure:
=============================================================================================
src/biogeochem -- Biogeochemisty
src/main -------- Main control and high level code
src/cpl --------- Land model high level MCT and ESMF drivers
src/biogeophys -- Biogeophysics (Hydrology)
src/dyn_subgrid - Dynamic land unit change
src/init_interp - Online interpolation
scr/fates ------- FATES model and sub-directories
Functionally Assembled Terrestrial Ecosystem Simulator (FATES)
Experimental Ecosystem Demography model
src/utils ------- Utility codes
scr_clm40 ------- CLM4.0 source code directory
=============================================================================================
QUICKSTART: using the CPL7 scripts:
=============================================================================================
cd cime/scripts
./create_newcase # get help on how to run create_newcase
./create_newcase --case testI --res f19_g16 --compset I2000Clm50BgcCrop --mach cheyenne
# create new "I" case for cheyenne_intel at 1.9x2.5_gx1v7 res
# "I2000Clm50BgcCrop" case is clm5_0 active, datm8, and inactive ice/ocn
cd testI
./case.setup # create the $CASE.run file
./case.build # build model and create namelists
./case.submit # submit script
# (NOTE: ./xmlchange RESUBMIT=10 to set RESUBMIT to number
# # of times to automatically resubmit -- 10 in this example)