-
Notifications
You must be signed in to change notification settings - Fork 52
/
Copy pathexample.cfg
226 lines (185 loc) · 9.35 KB
/
example.cfg
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
## This file contains the most common config options that a user might want
## to customize. The values are mostly the same as in
## mpas_analysis/default.cfg, the default config file, which has nearly all of
## the available config options.
## Usage:
## 1. Copy this file to a new name for a specific run (say myrun.cfg).
##
## 2. Modify any config options you want to change in your new config file.
## At a minimum, you need to specify:
## * [runs]/mainRunName -- A name for the run to be included plot titles
## and legends
## * [diagnostics]/baseDirectory -- The base directory for observations,
## mapping files and region masks
## * [input]/baseDirectory -- The directory for the simulation results
## to analyze
## * [input]/mpasMeshName -- The name of the MPAS ocean/sea ice mesh
## * [output]/baseDirectory -- The directory for the analysis results
##
## 3. run:
##
## $ mpas_analysis myrun.cfg
##
## This will read the configuration first from mpas_analysis/default.cfg
## and then replace that configuration with any changes from from myrun.cfg
##
## 4. If you want to run a subset of the analysis, you can either set
## [output]/generate in your config file or use the --generate flag on the
## command line. See the comments for [output]/generate below for more
## details on this option.
[runs]
## options related to the run to be analyzed and control runs to be
## compared against
# mainRunName is a name that identifies the simulation being analyzed.
mainRunName = runName
# config file for a control run to which this run will be compared. The
# analysis should have already been run to completion once with this config
# file, so that the relevant MPAS climatologies already exist and have been
# remapped to the comparison grid. Leave this option commented out if no
# control run is desired.
# controlRunConfigFile = /path/to/config/file
# config file for a main run on which the analysis was already run to
# completion. The relevant MPAS climatologies already exist and have been
# remapped to the comparison grid and time series have been extracted.
# Leave this option commented out if the analysis for the main run should be
# performed.
# mainRunConfigFile = /path/to/config/file
[execute]
## options related to executing parallel tasks
# the number of parallel tasks (1 means tasks run in serial, the default)
parallelTaskCount = 1
# the parallelism mode in ncclimo ("serial", "bck" or "mpi")
# Set this to "bck" (background parallelism) if running on a machine that can
# handle 12 simultaneous processes, one for each monthly climatology.
# Set to "mpi" to run one MPI task on each node and however many threads per
# node to reach 12 total threads.
ncclimoParallelMode = serial
# the number of MPI tasks to use in creating mapping files (1 means tasks run in
# serial, the default)
mapMpiTasks = 1
# "None" if ESMF should perform mapping file generation in serial without a
# command, or one of "srun" or "mpirun" if it should be run in parallel (or in
# serial but with a command).
mapParallelExec = None
# Typically, use this instead if running E3SM-Unified on a compute node
# mapParallelExec = srun
# "None" if ncremap should perform remapping without a command, or "srun"
# possibly with some flags if it should be run with that command
ncremapParallelExec = None
# Use this if running E3SM-Unified on a compute node on Chrysalis or Anvil
# ncremapParallelExec = srun
[diagnostics]
## config options related to observations, mapping files and region files used
## by MPAS-Analysis in diagnostics computations.
# The base path to the diagnostics directory. Typically, this will be a shared
# directory on each E3SM supported machine (see the example config files for
# its location). For other machines, this would be the directory pointed to
# when running "download_analysis_data.py" to get the public observations,
# mapping files and region files.
base_path = /path/to/diagnostics
[input]
## options related to reading in the results to be analyzed
# directory containing model results
baseDirectory = /dir/for/model/output
# NOTE: an absolute path can be supplied for any of these subdirectories.
# A relative path is assumed to be relative to baseDirectory.
# In this example, results are assumed to be in <baseDirecory>/run
# subdirectory containing restart files
runSubdirectory = run
# subdirectory for ocean history files
oceanHistorySubdirectory = run
# subdirectory for sea ice history files
seaIceHistorySubdirectory = run
# names of namelist and streams files, either a path relative to baseDirectory
# or an absolute path.
oceanNamelistFileName = run/mpaso_in
oceanStreamsFileName = run/streams.ocean
seaIceNamelistFileName = run/mpassi_in
seaIceStreamsFileName = run/streams.seaice
# name of the ocean and sea-ice mesh (e.g. EC30to60E2r2, WC14to60E2r3,
# ECwISC30to60E2r1, SOwISC12to60E2r4, oQU240, etc.)
mpasMeshName = mesh
[output]
## options related to writing out plots, intermediate cached data sets, logs,
## etc.
# directory where analysis should be written
# NOTE: This directory path must be specific to each test case.
baseDirectory = /dir/for/analysis/output
# provide an absolute path to put HTML in an alternative location (e.g. a web
# portal)
htmlSubdirectory = html
# On and E3SM supported machine, this may be helpful:
# htmlSubdirectory = ${web_portal:base_path}/${web_portal:username}/dir/for/web/output
# a list of analyses to generate. Valid names can be seen by running:
# mpas_analysis --list
# This command also lists tags for each analysis.
# Shortcuts exist to generate (or not generate) several types of analysis.
# These include:
# 'all' -- all analyses will be run
# 'all_publicObs' -- all analyses for which observations are available on the
# public server (the default)
# 'all_<tag>' -- all analysis with a particular tag will be run
# 'all_<component>' -- all analyses from a given component (either 'ocean'
# or 'seaIce') will be run
# 'only_<component>', 'only_<tag>' -- all analysis from this component or
# with this tag will be run, and all
# analysis for other components or
# without the tag will be skipped
# 'no_<task_name>' -- skip the given task
# 'no_<component>', 'no_<tag>' -- in analogy to 'all_*', skip all analysis
# tasks from the given component or with
# the given tag. Do
# mpas_analysis --list
# to list all task names and their tags
# an equivalent syntax can be used on the command line to override this
# option:
# mpas_analysis config.analysis --generate \
# only_ocean,no_timeSeries,timeSeriesSST
#
# NOTE: if an appropriate reference year isn't available for computing
# anomalies, include 'no_anomaly' in the generate list
generate = ['all_publicObs']
[climatology]
## options related to producing climatologies, typically to compare against
## observations and previous runs
# the year from which to compute anomalies if not the start year of the
# simulation. This might be useful if a long spin-up cycle is performed and
# only the anomaly over a later span of years is of interest.
# NOTE: Simulations that branch from another run should use the start year of
# the branch, not the start year of the simulation that was branched
# from, since MPAS-Analysis will not be able to find data from the
# original run.
# anomalyRefYear = 249
# the first year over which to average climatalogies
startYear = 11
# the last year over which to average climatalogies
endYear = 20
[timeSeries]
## options related to producing time series plots, often to compare against
## observations and previous runs
# the year from which to compute anomalies if not the start year of the
# simulation. This might be useful if a long spin-up cycle is performed and
# only the anomaly over a later span of years is of interest.
# NOTE: Simulations that branch from another run should use the start year of
# the branch, not the start year of the simulation that was branched
# from, since MPAS-Analysis will not be able to find data from the
# original run.
# anomalyRefYear = 249
# start and end years for timeseries analysis. Use endYear = end to indicate
# that the full range of the data should be used. If errorOnMissing = False,
# the start and end year will be clipped to the valid range. Otherwise, out
# of bounds values will lead to an error. In a "control" config file used in
# a "main vs. control" analysis run, the range of years must be valid and
# cannot include "end" because the original data may not be available.
startYear = 1
endYear = end
[index]
## options related to producing nino index.
# start and end years for El Nino 3.4 analysis. Use endYear = end to indicate
# that the full range of the data should be used. If errorOnMissing = False,
# the start and end year will be clipped to the valid range. Otherwise, out
# of bounds values will lead to an error. In a "control" config file used in
# a "main vs. control" analysis run, the range of years must be valid and
# cannot include "end" because the original data may not be available.
startYear = 1
endYear = end