@@ -22,3 +22,167 @@ Start simulation
2222``` bash
2323./control_tsmp2.sh
2424```
25+
26+ ## master.conf
27+
28+ The ` master.conf ` file contains general configuration settings for the
29+ workflow engine. It is located in ` ctl/master.conf ` .
30+
31+ ### Main Settings
32+
33+ #### MODEL_ID
34+ Specifies which model components to use. Options include but are not
35+ restriced to:
36+ - ` ParFlow ` - ParFlow only
37+ - ` ICON-eCLM ` - ICON atmosphere with eCLM land surface
38+ - ` ICON-eCLM-ParFlow ` - Fully coupled system
39+ - ` ICON ` - ICON atmosphere only
40+
41+ #### EXP_ID
42+ Experiment identifier (e.g., ` "eur-11u" ` ). Used for naming and
43+ organizing simulation outputs.
44+
45+ #### CASE_ID
46+ Optional identifier for specific cases within an experiment.
47+
48+ #### conf_file
49+ Path to case-specific configuration file. If left empty, the system
50+ will look for ` ${ctl_dir}/expid.conf ` .
51+
52+ ### Main Switches
53+
54+ Each workflow stage has three boolean flags: ` config ` , ` run ` ,
55+ ` cleanup ` .
56+
57+ #### lpre
58+ Preprocessing stage switches: ` ( config run cleanup ) `
59+ - ` config ` : Configure preprocessing
60+ - ` run ` : Execute preprocessing
61+ - ` cleanup ` : Clean up preprocessing files
62+
63+ #### lsim
64+ Simulation stage switches: ` ( config run cleanup ) `
65+ - ` config ` : Configure simulation
66+ - ` run ` : Execute simulation
67+ - ` cleanup ` : Clean up simulation files
68+
69+ #### lpos
70+ Post-processing stage switches: ` ( config run cleanup ) `
71+ - ` config ` : Configure post-processing
72+ - ` run ` : Execute post-processing
73+ - ` cleanup ` : Clean up post-processing files
74+
75+ #### lvis
76+ Visualization stage switches: ` ( config run cleanup ) `
77+ - ` config ` : Configure visualization
78+ - ` run ` : Execute visualization
79+ - ` cleanup ` : Clean up visualization files
80+
81+ ### Time Information
82+
83+ #### cpltsp_atmsfc
84+ Coupling time step between atmosphere and surface (eCLM timestep) in
85+ seconds. Default: ` 900 ` .
86+
87+ #### cpltsp_sfcss
88+ Coupling time step between surface and subsurface (ParFlow timestep)
89+ in seconds. Default: ` 900 ` .
90+
91+ #### simlength
92+ Length of each simulation step (e.g., ` "1 day" ` , ` "23 hours" ` ).
93+
94+ #### startdate
95+ Start date of the simulation in ISO 8601 format (e.g.,
96+ ` "2017-07-01T00:00Z" ` ).
97+
98+ #### inidate
99+ Initial date for the entire simulation in ISO 8601 format. Default:
100+ same as ` startdate ` .
101+
102+ #### numsimstep
103+ Number of simulation steps.
104+
105+ Total simulation time = ` numsimstep * simlength ` .
106+
107+ Each simulation step is a queued job on the machine. The next job is
108+ only executed once the previous is done.
109+
110+ ### Mail Notification
111+
112+ #### mailtype
113+ Email notification trigger for SLURM jobs. Options: ` NONE ` , ` BEGIN ` ,
114+ ` END ` , ` FAIL ` , ` REQUEUE ` , ` ALL ` .
115+
116+ #### mailaddress
117+ Email address for job notifications. Leave empty if ` mailtype=NONE ` .
118+
119+ ### User Settings
120+
121+ #### prevjobid
122+ Previous job ID for job chaining. Leave empty by default; system will
123+ manage this automatically.
124+
125+ #### npnode
126+ Number of cores per node. Leave empty to use machine defaults.
127+
128+ #### partition
129+ Compute partition to use. Leave empty to use machine defaults.
130+
131+ #### account
132+ Compute account for billing. If not set, ` $BUDGET_ACCOUNTS ` or ` slts `
133+ will be used.
134+
135+ ### Wallclock Times
136+
137+ Wallclock time limits for each workflow stage in ` hh:mm:ss ` format.
138+
139+ #### pre_wallclock
140+ Time limit for preprocessing jobs (e.g., ` 00:35:00 ` ).
141+
142+ #### sim_wallclock
143+ Time limit for simulation jobs (e.g., ` 00:25:00 ` ).
144+
145+ #### pos_wallclock
146+ Time limit for post-processing jobs (e.g., ` 00:05:00 ` ).
147+
148+ #### vis_wallclock
149+ Time limit for visualization jobs (e.g., ` 00:05:00 ` ).
150+
151+ ### File/Directory Paths
152+
153+ #### tsmp2_dir
154+ Path to TSMP2 directory. Uses ` $TSMP2_DIR ` environment variable.
155+
156+ #### tsmp2_install_dir
157+ Path to TSMP2 installation directory. Leave empty to use default.
158+
159+ #### tsmp2_env
160+ Path to TSMP2 environment file. Leave empty to use default.
161+
162+ ### Node Allocation
163+
164+ Number of nodes allocated to each model component. Components not
165+ indicated in ` MODEL_ID ` will have their node count set to zero.
166+
167+ #### ico_node
168+ Number of nodes for ICON atmosphere component. Default: ` 3 ` .
169+
170+ #### clm_node
171+ Number of nodes for eCLM land surface component. Default: ` 1 ` .
172+
173+ #### pfl_node
174+ Number of nodes for ParFlow subsurface component. Default: ` 2 ` .
175+
176+ ### Debug and Logging
177+
178+ #### debugmode
179+ If set to ` true ` , no job submission is carried out. Works only for
180+ ` config ` steps.
181+
182+ Useful for testing configuration without running jobs.
183+
184+ Useful for running single tasks, e.g. namelist creation.
185+
186+ #### joblog
187+ If set to ` true ` , job status will be logged. Default: ` true ` .
188+
0 commit comments