1 | ================ |
---|
2 | The CONTROL file |
---|
3 | ================ |
---|
4 | |
---|
5 | |
---|
6 | |
---|
7 | .. MARS user documentation https://confluence.ecmwf.int/display/UDOC/MARS+user+documentation |
---|
8 | .. MARS keywords and explanation https://confluence.ecmwf.int/display/UDOC/MARS+keywords |
---|
9 | |
---|
10 | |
---|
11 | This file is an input file for :literal:`flex_extract's` main script :literal:`submit.py`. |
---|
12 | It contains the controlling parameters :literal:`flex_extract` needs to decide on dataset specifications, |
---|
13 | handling of the retrieved data and general bahaviour. The naming convention is usually (but not necessary): |
---|
14 | |
---|
15 | :literal:`CONTROL_<Dataset>[.optionalIndications]` |
---|
16 | |
---|
17 | The tested datasets are the operational dataset and the re-analysis datasets CERA-20C, ERA5 and ERA-Interim. |
---|
18 | The optional extra indications for the re-analysis datasets mark the files for *public users* |
---|
19 | and *global* domain. For the operational datasets (*OD*) the file names contain also information of |
---|
20 | the stream, the field type for forecasts, the method for extracting the vertical coordinate and other things like time or horizontal resolution. |
---|
21 | |
---|
22 | |
---|
23 | Format of CONTROL files |
---|
24 | ---------------------------------- |
---|
25 | The first string of each line is the parameter name, the following string(s) (separated by spaces) is (are) the parameter values. |
---|
26 | The parameters can be sorted in any order with one parameter per line. |
---|
27 | Comments are started with a '#' - sign. Some of these parameters can be overruled by the command line |
---|
28 | parameters given to the :literal:`submit.py` script. |
---|
29 | All parameters have default values. Only those parameters which have to be changed |
---|
30 | must be listed in the :literal:`CONTROL` files. |
---|
31 | |
---|
32 | |
---|
33 | Example CONTROL files |
---|
34 | -------------------------------- |
---|
35 | |
---|
36 | A number of example files can be found in the directory :literal:`flex_extract_vX.X/run/control/`. |
---|
37 | They can be used as a template for adaptations and understand what's possible to |
---|
38 | retrieve from ECMWF's archive. |
---|
39 | For each main dataset there is an example and additionally some variances in resolution, type of field or type of retrieving the vertical coordinate. |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | |
---|
44 | CONTROL file |
---|
45 | ------------ |
---|
46 | The file :literal:`CONTROL.documentation` documents the available parameters |
---|
47 | in grouped sections with their default values. In :doc:`control_params` you can find a more |
---|
48 | detailed description with additional hints, possible values and some useful information about |
---|
49 | the setting of these parameters. |
---|
50 | |
---|
51 | .. literalinclude:: ../../../../../Run/Control/CONTROL.documentation |
---|
52 | :language: bash |
---|
53 | :caption: CONTROL.documentation |
---|
54 | |
---|
55 | |
---|
56 | |
---|
57 | |
---|
58 | |
---|
59 | .. toctree:: |
---|
60 | :hidden: |
---|
61 | :maxdepth: 2 |
---|
62 | |
---|