The CONTROL file

This file is an input file for flex_extract's main script submit.py. It contains the controlling parameters flex_extract needs to decide on dataset specifications, handling of the retrieved data and general bahaviour. The naming convention is usually (but not necessary):

CONTROL_<Dataset>[.optionalIndications]

The tested datasets are the operational dataset and the re-analysis datasets CERA-20C, ERA5 and ERA-Interim. The optional extra indications for the re-analysis datasets mark the files for public users and global domain. For the operational datasets (OD) the file names contain also information of the stream, the field type for forecasts, the method for extracting the vertical coordinate and other things like time or horizontal resolution.

Format of CONTROL files

The first string of each line is the parameter name, the following string(s) (separated by spaces) is (are) the parameter values. The parameters can be sorted in any order with one parameter per line. Comments are started with a ‘#’ - sign. Some of these parameters can be overruled by the command line parameters given to the submit.py script. All parameters have default values. Only those parameters which have to be changed must be listed in the CONTROL files.

Example CONTROL files

A number of example files can be found in the directory flex_extract_vX.X/run/control/. They can be used as a template for adaptations and understand what’s possible to retrieve from ECMWF’s archive. For each main dataset there is an example and additionally some variances in resolution, type of field or type of retrieving the vertical coordinate.

CONTROL file

The file CONTROL.documentation documents the available parameters in grouped sections with their default values. In The CONTROL parameters you can find a more detailed description with additional hints, possible values and some useful information about the setting of these parameters.

CONTROL.documentation

################################################################################
# Comprehensive list of relevant CONTROL file parameters with
# short descriptions and default values. 
#
# For more details on how to select and define parameters 
# please see Table of CONTROLparameters. 
#
# AUTHOR: Anne Philipp
# DATE:   05. February 2019
################################################################################

#===============================================================================
# USER SECTION:
# User specific information for ECMWF server.
# Information are needed for storage or data transfer to local gateway server.
# (OPTIONAL: INFORMATION ARE KNOWN THROUGH EXTRA FILE AFTER INSTALLATION)
#-------------------------------------------------------------------------------
ECUID None
ECGID None
DESTINATION None
GATEWAY None

#===============================================================================
# GENERAL SECTION:
# Specific storage, notification and data transfer settings.
# Selection of ECMWF access interface and extra output options. 
#-------------------------------------------------------------------------------
DEBUG 0
REQUEST 0
PUBLIC 0
OPER 0
ECSTORAGE 0
ECTRANS 0
PREFIX 'EN'
ECFSDIR 'ectmp:/${USER}/econdemand/'
MAILFAIL ['${USER}']
MAILOPS ['${USER}']

#===============================================================================
# TIME SECTION:
# Selection of time period and temporal resolution for extraction period.
#-------------------------------------------------------------------------------
START_DATE 
END_DATE
DATE_CHUNK 3
DTIME None
BASETIME None

#===============================================================================
# DATA SECTION:
# General description of data set.
#-------------------------------------------------------------------------------
CLASS None
DATASET None
STREAM None
NUMBER 'OFF'
EXPVER '1'
FORMAT 'GRIB1'

#===============================================================================
# DATA FIELDS SECTION:
# Specific selection of field composition regarding type, analysis or forecast 
# time and the forecast time step.
#-------------------------------------------------------------------------------
TYPE None
TIME None
STEP None
MAXSTEP None

#===============================================================================
# FLUX DATA FIELDS SECTION:
# Specific selection of flux field composition regarding forecast field type
# the forecast start times and the maximum forecast step per start time.
# Specification of disaggregation method of precipitation data.
#-------------------------------------------------------------------------------
ACCTYPE None
ACCTIME None
ACCMAXSTEP None
RRINT 0

#===============================================================================
# DOMAIN SECTION: 
# Definition of horizontal area, spatial resolution and vertical levels. 
#-------------------------------------------------------------------------------
GRID None
RESOL None
SMOOTH 0
LEFT None
LOWER None
UPPER None
RIGHT None
LEVEL None
LEVELIST None

#===============================================================================
# VERTICAL WIND SECTION:
# Selection of vertical wind calculation method.
#-------------------------------------------------------------------------------
GAUSS 0
ACCURACY 24
OMEGA 0
OMEGADIFF 0
ETA 0
ETADIFF 0
DPDETA 1
ETAPAR 77

#===============================================================================
# ADDITIONAL DATA SECTION:
# Specification of extra data fields to be extracted.
#-------------------------------------------------------------------------------
CWC 0
WRF 0
DOUBLEELDA 0 
ADDPAR None