forked from MPAS-Dev/MPAS-Analysis
-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.example
201 lines (165 loc) · 8.25 KB
/
config.example
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
## This file contains the most common config options that a user might want
## to customize. The values are the same as in mpas_analysis/config.default,
## the default config file, which has all possible configuration options.
## Usage:
## 1. Copy this file to a new name for a specific run (say config.myrun).
## 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
## * [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
## * [oceanObservations]/baseDirectory -- The directory for the analysis
## ocean observations
## * [seaIceObservations]/baseDirectory -- The directory for the analysis
## sea ice observations
## * [regions]/regionMaskDirectory -- a directory containing MOC and
## ice shelf region masks
## 3. run: ./run_mpas_analysis config.myrun. This will read the configuraiton
## first from config.default and then replace that configuraiton with any
## changes from from config.myrun
## 4. If you want to run a subset of the analysis, you can either set the
## generate option under [output] in your config file or use the
## --generate flag on the command line. See the comments for 'generate'
## in the '[output]' section below for more details on this option.
[runs]
## options related to the run to be analyzed and reference runs to be
## compared against
# mainRunName is a name that identifies the simulation being analyzed.
mainRunName = runName
# preprocessedReferenceRunName is the name of a reference run that has been
# preprocessed to compare against (or None to turn off comparison). Reference
# runs of this type would have preprocessed results because they were not
# performed with MPAS components (so they cannot be easily ingested by
# MPAS-Analysis)
preprocessedReferenceRunName = None
# config file for a reference 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
# reference run is desired.
# referenceRunConfigFile = /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" or "bck")
# Set this to "bck" (background parallelism) if running on a machine that can
# handle 12 simultaneous processes, one for each monthly climatology.
ncclimoParallelMode = serial
[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.
# By default, results are assumed to be directly in baseDirectory,
# i.e. <baseDirecory>/./
# subdirectory containing restart files
runSubdirectory = .
# subdirectory for ocean history files
oceanHistorySubdirectory = .
# subdirectory for sea ice history files
seaIceHistorySubdirectory = .
# names of namelist and streams files, either a path relative to baseDirectory
# or an absolute path.
oceanNamelistFileName = mpaso_in
oceanStreamsFileName = streams.ocean
seaIceNamelistFileName = mpassi_in
seaIceStreamsFileName = streams.seaice
# names of ocean and sea ice meshes (e.g. oEC60to30, oQU240, oRRS30to10, etc.)
mpasMeshName = mesh
# Directory for mapping files (if they have been generated already). If mapping
# files needed by the analysis are not found here, they will be generated and
# placed in the output mappingSubdirectory
# mappingDirectory = /dir/for/mapping/files
[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
# subdirectories within baseDirectory for analysis output
scratchSubdirectory = scratch
plotsSubdirectory = plots
logsSubdirectory = logs
mpasClimatologySubdirectory = clim/mpas
mappingSubdirectory = mapping
timeSeriesSubdirectory = timeseries
# provide an absolute path to put HTML in an alternative location (e.g. a web
# portal)
htmlSubdirectory = html
# a list of analyses to generate. Valid names can be seen by running:
# ./run_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 availabe 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 compoonent or with
# the given tag. Do
# ./run_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:
# ./run_mpas_analysis config.analysis --generate \
# only_ocean,no_timeSeries,timeSeriesSST
generate = ['all_publicObs']
[climatology]
## options related to producing climatologies, typically to compare against
## observations and previous runs
# 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
# start and end years for timeseries analysis. Using out-of-bounds values
# like start_year = 1 and end_year = 9999 will be clipped to the valid range
# of years, and is a good way of insuring that all values are used.
startYear = 1
endYear = 9999
[index]
## options related to producing nino index.
# start and end years for the nino 3.4 analysis. Using out-of-bounds values
# like start_year = 1 and end_year = 9999 will be clipped to the valid range
# of years, and is a good way of insuring that all values are used.
# For valid statistics, index times should include at least 30 years
startYear = 1
endYear = 9999
[oceanObservations]
## options related to ocean observations with which the results will be compared
# directory where ocean observations are stored
baseDirectory = /dir/to/ocean/observations
[oceanPreprocessedReference]
## options related to preprocessed ocean reference run with which the results
## will be compared (e.g. a POP, CESM or ACME v0 run)
# directory where ocean reference simulation results are stored
baseDirectory = /dir/to/ocean/reference
[seaIceObservations]
## options related to sea ice observations with which the results will be
## compared
# directory where sea ice observations are stored
baseDirectory = /dir/to/seaice/observations
[seaIcePreprocessedReference]
## options related to preprocessed sea ice reference run with which the results
## will be compared (e.g. a CICE, CESM or ACME v0 run)
# directory where ocean reference simulation results are stored
baseDirectory = /dir/to/seaice/reference
[regions]
## options related to ocean regions used in several analysis modules
# Directory for region mask files
regionMaskDirectory = /path/to/masks/