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 dataset to be retrieved. They are initialized by ``flex_extract`` with their default values and can be overwritten with definitions set in the so called :doc:`Input/control`. |
---|
8 | |
---|
9 | To be able to successfully retrieve data from the ECMWF Mars archive it is necessary to understand these parameters and set them to proper and consistent values. They are described in :doc:`Input/control_params` section. |
---|
10 | |
---|
11 | We also have some :doc:`Input/examples` and description of :doc:`Input/changes` changes to previous versions and downward compatibilities. |
---|
12 | |
---|
13 | - :doc:`Input/ecmwf_env` |
---|
14 | For ``flex_extract`` it is necessary 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 jobscripts regarding its settings for the batch jobs. |
---|
18 | |
---|
19 | |
---|
20 | |
---|
21 | |
---|
22 | |
---|
23 | .. _setup : Input/setup.html |
---|
24 | .. _run : Input/run.html |
---|
25 | .. _install : Input/setup.html#ref-install-script |
---|
26 | .. _submit : Input/submit.html#ref-submit-script |
---|
27 | |
---|
28 | .. _ref-controlling: |
---|
29 | |
---|
30 | Controlling |
---|
31 | The main tasks and behaviour of ``flex_extract`` are controlled by its Python scripts. There are two top-level scripts, one for installation called install_ and one for execution called submit_. |
---|
32 | They can 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: |
---|
33 | |
---|
34 | .. code-block:: bash |
---|
35 | |
---|
36 | cd flex_extract_vX.X |
---|
37 | python3 source/python/install.py --help |
---|
38 | python3 source/python/submit.py --help |
---|
39 | |
---|
40 | In this new version we provide also the wrapping Shell scripts setup_ and run_, which sets the command line parameters, do some checks and execute the corresponing Python scripts ``install.py`` and ``submit.py`` respectivley. |
---|
41 | |
---|
42 | It might be faster and easier for beginners. See :doc:`../quick_start` for information on how to use them. |
---|
43 | |
---|
44 | Additionally, ``flex_extract`` creates the Korn Shell scripts :doc:`Input/compilejob` and :doc:`Input/jobscript` which will be send to the ECMWF serves in the **remote mode** and the **gateway mode** for starting batch jobs. |
---|
45 | |
---|
46 | The Fortran program will be compiled during the installation process by the :doc:`Input/fortran_makefile`. |
---|
47 | |
---|
48 | To sum up, the following scripts controls ``flex_extract``: |
---|
49 | |
---|
50 | Installation |
---|
51 | - :doc:`Input/setup` |
---|
52 | - :doc:`Input/compilejob` |
---|
53 | - :doc:`Input/fortran_makefile` |
---|
54 | |
---|
55 | Execution |
---|
56 | - :doc:`Input/run` |
---|
57 | - :doc:`Input/jobscript` |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | |
---|
62 | |
---|
63 | |
---|
64 | |
---|
65 | |
---|
66 | |
---|
67 | |
---|
68 | .. toctree:: |
---|
69 | :hidden: |
---|
70 | :maxdepth: 2 |
---|
71 | |
---|
72 | Input/setup |
---|
73 | Input/compilejob |
---|
74 | Input/fortran_makefile |
---|
75 | Input/run |
---|
76 | Input/jobscript |
---|
77 | Input/control |
---|
78 | Input/control_params |
---|
79 | Input/examples |
---|
80 | Input/changes |
---|
81 | Input/ecmwf_env |
---|
82 | Input/templates |
---|