[41c9dbc] | 1 | ================ |
---|
| 2 | The CONTROL file |
---|
| 3 | ================ |
---|
| 4 | |
---|
| 5 | |
---|
| 6 | |
---|
[d9abaac] | 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 |
---|
[41c9dbc] | 9 | |
---|
| 10 | |
---|
| 11 | This file is an input file for :literal:`flex_extract's` main script :literal:`submit.py`. |
---|
[f20342a] | 12 | It contains the controlling parameters which :literal:`flex_extract` needs to decide on data set specifications, |
---|
| 13 | handling of the data retrieved, and general behaviour. The naming convention is usually (but not necessarily): |
---|
[41c9dbc] | 14 | |
---|
| 15 | :literal:`CONTROL_<Dataset>[.optionalIndications]` |
---|
| 16 | |
---|
[f20342a] | 17 | There are a number of data sets for which the procedures have been tested, the operational data and the re-analysis datasets CERA-20C, ERA5, and ERA-Interim. |
---|
| 18 | The optional indications for the re-analysis data sets mark the files for *public users* |
---|
| 19 | and *global* domain. For the operational data sets (*OD*), the file names contain also information of |
---|
| 20 | the stream, the field type for forecasts, the method for extracting the vertical wind, and other information such as temporal or horizontal resolution. |
---|
[41c9dbc] | 21 | |
---|
| 22 | |
---|
| 23 | Format of CONTROL files |
---|
| 24 | ---------------------------------- |
---|
[0b00607] | 25 | The first string of each line is the parameter name, the following string(s) (separated by spaces) is (are) the parameter values. |
---|
[f20342a] | 26 | The parameters can be listed in any order with one parameter per line. |
---|
[41c9dbc] | 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. |
---|
[f20342a] | 29 | All parameters have default values; only those parameters which deviate from default |
---|
| 30 | have be listed in the :literal:`CONTROL` files. |
---|
[41c9dbc] | 31 | |
---|
[0b00607] | 32 | |
---|
[41c9dbc] | 33 | Example CONTROL files |
---|
| 34 | -------------------------------- |
---|
| 35 | |
---|
[b1674ed] | 36 | A number of example files can be found in the directory :literal:`flex_extract_vX.X/Run/Control/`. |
---|
[f20342a] | 37 | They can be used as a template for adaptation, and to understand what can be |
---|
| 38 | retrievee from ECMWF's archives. |
---|
| 39 | There is an example for each main data set, and in addition, some more varied with respect to resolution, type of field, or way of retrieving the vertical wind. |
---|
[41c9dbc] | 40 | |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | |
---|
| 44 | CONTROL file |
---|
| 45 | ------------ |
---|
| 46 | The file :literal:`CONTROL.documentation` documents the available parameters |
---|
[f20342a] | 47 | in grouped sections together with their default values. |
---|
| 48 | In :doc:`control_params`, you can find a more |
---|
| 49 | detailed description with additional hints, possible values, and further information about |
---|
[41c9dbc] | 50 | the setting of these parameters. |
---|
| 51 | |
---|
[0b00607] | 52 | .. literalinclude:: ../../../../../Run/Control/CONTROL.documentation |
---|
[41c9dbc] | 53 | :language: bash |
---|
| 54 | :caption: CONTROL.documentation |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | |
---|
| 59 | |
---|
| 60 | .. toctree:: |
---|
| 61 | :hidden: |
---|
| 62 | :maxdepth: 2 |
---|
| 63 | |
---|