Time Series¶
The [timeSeries]
section of a configuration file contains options used to
determine the start and end years of time series plots and the reference years
for anomalies:
[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.
# anomalyRefYear = 249
# 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
Start and End Year¶
A custom config file should specify a start and end year for time series.
If the end year is beyond the range of the simulation (typically true for the
default endYear = 9999
), the range will be reduced to those dates with
available data and a warning message will be displayed.
Anomaly Reference Year¶
Anomalies between a moving average of a time series and the average over a reference year are used in several analysis tasks. By default, the reference year is not specified in the configuration file and it taken to be the start of the simulation (determined from the contents of a restart file). Under certain circumstances (e.g. repetition of forcing data for several cycles, as in the Common Ocean Reference Experiments, CORE), it may be desirable to specify a different year to use for computing anomalies:
anomalyRefYear = 249