Changeset f20342a in flex_extract.git for For_developers/Sphinx/source/Documentation/Input/control.rst

Timestamp:

May 27, 2020, 8:01:54 PM (4 years ago)

Author:

Petra Seibert <petra.seibert [at) univie.ac.at>

Branches:

master, ctbto, dev

Children:

550435b

Parents:

a14839a

Message:

Language corrections for the Sections Developers, Support, Changelog, and the home directory (index.html)

further improvment of documentation, close to final

File:

• For_developers/Sphinx/source/Documentation/Input/control.rst (modified) (4 diffs)

For_developers/Sphinx/source/Documentation/Input/control.rst

@@ -10 +10 @@
  
 This file is an input file for :literal:`flex_extract's` main script :literal:`submit.py`.
-It contains the controlling parameters :literal:`flex_extract` needs to decide on dataset specifications,
-handling of the retrieved data and general bahaviour. The naming convention is usually (but not necessary):
+It contains the controlling parameters which :literal:`flex_extract` needs to decide on data set specifications,
+handling of the  data retrieved, and general behaviour. The naming convention is usually (but not necessarily):
 
    :literal:`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.
+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.
+The optional indications for the re-analysis data sets mark the files for *public users* 
+and *global* domain. For the operational data sets (*OD*), the file names contain also information of
+the stream, the field type for forecasts, the method for extracting the vertical wind, and other information such as temporal or horizontal resolution.
 
 
@@ -24 +24 @@
 ----------------------------------
 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. 
+The parameters can be listed 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 :literal:`submit.py` script. 
-All parameters have default values. Only those parameters which have to be changed
-must be listed in the :literal:`CONTROL` files. 
+All parameters have default values; only those parameters which deviate from default
+have be listed in the :literal:`CONTROL` files. 
 
 
@@ -35 +35 @@
 
 A number of example files can be found in the directory :literal:`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. 
+They can be used as a template for adaptation, and to understand what can be 
+retrievee from ECMWF's archives.
+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. 
 
 
@@ -45 +45 @@
 ------------
 The file :literal:`CONTROL.documentation` documents the available parameters
-in grouped sections with their default values. In :doc:`control_params` you can find a more
-detailed description with additional hints, possible values and some useful information about
+in grouped sections together with their default values. 
+In :doc:`control_params`, you can find a more
+detailed description with additional hints, possible values, and further information about
 the setting of these parameters.