forked from ESCOMP/CTSM
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
113 lines (93 loc) · 6.57 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
components/clm/README 04/07/2015
Community Land Surface Model (CLM) science version 4.5.1 series -- source code, tools,
offline-build and test scripts. This gives you everything you need
to run CLM with CESM with datm8 to provide Qian or CRU NCEP forcing data in
place of a modeled atmosphere.
General directory structure:
components/clm/doc ---- Documentation of CLM.
components/clm/bld ---- Template, configure and build-namelist scripts for clm.
components/clm/src ---- CLM Source code.
components/clm/test --- CLM Testing scripts for CLM offline tools.
components/clm/tools -- CLM Offline tools to prepare input datasets and process output.
cime/scripts --------------- CPL7 scripts
cime/driver_cpl/driver ---------- CESM top level driver source code.
cime/driver_cpl/shr ------------- CESM top level driver shared code.
cime/driver_cpl/shr_esmf -------- CESM top level driver shared code for ESMF.
cime/components/data_comps/datm - CESM Data model version 8 source code.
components/cism ----------------- CESM Community land Ice Sheet Model.
components/rtm ------------------ CESM River Transport Model.
cime/components/stub_comps/sice - CESM stub sea-ice model source code.
cime/components/stub_comps/socn - CESM stub ocean model source code.
cime/components/stub_comps/sglc - CESM stub glacier model source code.
cime/external ------------------- 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 --------- Information on how to work with subversion externals for clm
SVN_EXTERNAL_DIRECTORIES - Subversions externals to use
Copyright ---------------- CESM Copyright file
UpDateChangeLog.pl ------- Script to add documentation on a tag to the
ChangeLog/ChangeSum files
ChangeLog ---------------- Documents different CLM versions
ChangeSum ---------------- Summary documentation of different CLM versions
ChangeLog/ChangeSum ------ Also copied to components/lnd/clm/doc
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_clm.xml - Default values
=============================================================================================
Important files in main directories:
=============================================================================================
components/lnd/clm/doc/Quickstart.GUIDE -------- Quick guide to using cpl7 scripts.
components/lnd/clm/doc/Quickstart.userdatasets - Quick guide to using your own datasets.
components/lnd/clm/doc/IMPORTANT_NOTES --------- Some important notes about this version of
clm, configuration modes and namelist items
that are not validated or functional.
components/clm/doc/KnownBugs --------------- List of known bugs.
components/clm/doc/KnownLimitations -------- List of known limitations and workarounds.
components/clm/doc/ChangeLog --------------- Detailed list of changes for each model version.
components/clm/doc/ChangeSum --------------- Summary one-line list of changes for each
model version.
components/clm/doc/README ------------------ Documentation similar to this file
components/clm/doc/UsersGuide -------------- CLM Users Guide
components/clm/doc/CodeReference ----------- CLM Code Reference Guide
components/clm/bld/configure --------------- Script to prepare CLM to be built.
components/clm/test/tools/test_driver.sh -- Script for general software testing of
CLM's offline tools.
components/clm/tools/clm4_5/mksurfdata_map --- Directory to build program to create surface dataset
at any resolution.
components/clm/tools/clm4_5/interpinic ------- Directory to build program to interpolate initial
conditions to any resolution.
components/clm/tools/shared/mkdatadomain ----- Directory to build program to create datm7 or docn7
domain files from clm files.
components/clm/tools/shared/mkprocdata_map --- Process history data from unstructed grids to a gridded
format.
components/clm/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.
components/clm/bld/README ------------- Description of how to use the configure and
build-namelist scripts.
=============================================================================================
Source code directory structure:
=============================================================================================
components/clm/src/biogeochem -- Biogeochemisty
components/clm/src/main -------- Main control and high level code
components/clm/src/cpl --------- Land model high level MCT and ESMF drivers
components/clm/src/biogeophys -- Biogeophysics (Hydrology)
=============================================================================================
QUICKSTART: using the CPL7 scripts:
=============================================================================================
cd cime/scripts
./create_newcase # get help on how to run create_newcase
./create_newcase -case testI -mach bluefire -res f19_g16 -compset I
# create new "I" case for bluefire at 1.9x2.5_gx1v6 res
# "I" case is clm active, datm8, and inactive ice/ocn
cd testI
./cesm_setup # create the $CASE.run file
./testI.bluefire.build # build model and create namelists
./testI.bluefire.submit # submit script
# (NOTE: ./xmlchange RESUBMIT=10 to set RESUBMIT to number
# # of times to automatically resubmit -- 10 in this example)