| 1 | ******************** |
|---|
| 2 | Control & input data |
|---|
| 3 | ******************** |
|---|
| 4 | |
|---|
| 5 | Input data |
|---|
| 6 | - :doc:`Input/control` |
|---|
| 7 | ``Flex_extract`` needs a number of controlling parameters to decide on the behaviour and the actual data set to be retrieved. They are initialised by ``flex_extract`` with certain default values which can be overwritten with definitions set in the so-called :doc:`Input/control`. |
|---|
| 8 | |
|---|
| 9 | For a successfull retrieval of data from the ECMWF MARS archive it is necessary to understand these parameters and to set them to proper and consistent values. They are described in :doc:`Input/control_params` section. |
|---|
| 10 | |
|---|
| 11 | Furthermore, some :doc:`Input/examples` are provided, and in :doc:`Input/changes` changes to previous versions and downward compatibilities are described. |
|---|
| 12 | |
|---|
| 13 | - :doc:`Input/ecmwf_env` |
|---|
| 14 | ``flex_extract`` needs to be able to reach ECMWF servers in the **remote mode** and the **gateway mode**. Therefore a :doc:`Input/ecmwf_env` is created during the installation process. |
|---|
| 15 | |
|---|
| 16 | - :doc:`Input/templates` |
|---|
| 17 | A number of files which are created by ``flex_extract`` are taken from templates. This makes it easy to adapt, for example, the job scripts with regard to the settings for the batch jobs. |
|---|
| 18 | |
|---|
| 19 | |
|---|
| 20 | |
|---|
| 21 | .. _setup : Input/setup.html |
|---|
| 22 | .. _run : Input/run.html |
|---|
| 23 | .. _install : Input/setup.html#ref-install-script |
|---|
| 24 | .. _submit : Input/submit.html#ref-submit-script |
|---|
| 25 | |
|---|
| 26 | .. _ref-controlling: |
|---|
| 27 | |
|---|
| 28 | Controlling |
|---|
| 29 | The main tasks and the behaviour of ``flex_extract`` are controlled by the Python scripts. There are two top-level scripts, one for installation called install_, and one for execution called submit_. |
|---|
| 30 | They interpret a number of command-line arguments which can be seen by typing ``--help`` after the script call. Go to the root directory of ``flex_extract`` to type: |
|---|
| 31 | |
|---|
| 32 | .. code-block:: bash |
|---|
| 33 | |
|---|
| 34 | cd flex_extract_vX.X |
|---|
| 35 | python3 Source/Python/install.py --help |
|---|
| 36 | python3 Source/Python/submit.py --help |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | With version 7.1, we provide also wrapper shell scripts setup_ and run_ which set the command-line parameters, do some checks, and execute the corresponing Python scripts ``install.py`` and ``submit.py``, respectively. It might be faster and easier for beginners if they are used. See :doc:`../quick_start` for information on how to use them. |
|---|
| 40 | |
|---|
| 41 | ``flex_extract`` also creates the Korn shell scripts :doc:`Input/compilejob` and :doc:`Input/jobscript` which will be sent to the ECMWF servers in the **remote mode** and the **gateway mode** for starting batch jobs. |
|---|
| 42 | |
|---|
| 43 | The Fortran program is compiled during the installation process using the :doc:`Input/fortran_makefile`. |
|---|
| 44 | |
|---|
| 45 | To sum up, the following scripts control ``flex_extract``: |
|---|
| 46 | |
|---|
| 47 | Installation |
|---|
| 48 | - :doc:`Input/setup` |
|---|
| 49 | - :doc:`Input/compilejob` |
|---|
| 50 | - :doc:`Input/fortran_makefile` |
|---|
| 51 | |
|---|
| 52 | Execution |
|---|
| 53 | - :doc:`Input/run` |
|---|
| 54 | - :doc:`Input/jobscript` |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | .. toctree:: |
|---|
| 66 | :hidden: |
|---|
| 67 | :maxdepth: 2 |
|---|
| 68 | |
|---|
| 69 | Input/setup |
|---|
| 70 | Input/compilejob |
|---|
| 71 | Input/fortran_makefile |
|---|
| 72 | Input/run |
|---|
| 73 | Input/jobscript |
|---|
| 74 | Input/control |
|---|
| 75 | Input/control_params |
|---|
| 76 | Input/examples |
|---|
| 77 | Input/changes |
|---|
| 78 | Input/ecmwf_env |
|---|
| 79 | Input/templates |
|---|
