Ignore:
Timestamp:
Dec 19, 2019, 8:12:11 PM (4 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
e70c85f
Parents:
76c37a9
Message:

updated online docu

File:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/_sources/Installation/gateway.rst.txt

    r30f7911 rd720895  
    88.. toctree::
    99    :hidden:
    10     :maxdepth: 3
     10    :maxdepth: 2
    1111   
    1212.. _Python 3: https://docs.python.org/3/
    … …  
    4343.. _ref-req-gateway:
    4444 
    45 Gateway environment requirements
    46 ================================
     45Gateway mode - dependencies
     46===========================
    4747
    48 The environment on your local system has to provide these software packages
    49 and libraries, since ``flex_extract`` does only prepare the job script and send
    50 it to the ECMWF servers:
    51    
    52 * `Python3`_ or `Anaconda Python3`_
     48* `Python3`_
    5349* `numpy`_
    5450* `genshi`_
    … …  
    6056===========================
    6157
    62 The easiest way to install all required packages is to use the package management system of your Linux distribution. To do so, it is necessary to use a user with admin rights.
    63 The installation was tested on a *GNU/Linux Debian buster* and an *Ubuntu 18.04 Bionic Beaver* system.
     58In this mode, access to the ECMWF computing and archiving facilities is enabled through an ECaccess gateway server on a local member state server. The ECaccess framework is necessary to interactively submit jobs to the ECMWF batch system and to transfer files between ECMWF and local gateway server.
     59
     60Please see `ECMWF's instructions on gateway server`_ to establish the gateway server if not already in place. Additionally, to be able to use the ECaccess file transfer service **ectrans** it is necessary to create a so-called association. The easiest way is to visit the ECaccess Member State Gateway website (e.g. https://msgatway.ecmwf.int) and follow the instructions in the short `ECaccess Presentation`_ (page 17 ff.). Additional documentation can be found on the `ECMWF ectrans site`_.
     61
     62The next step is to create an *ecaccess certificate* to be able to send and receive files from and to the ECMWF server. You can do this by using the ``ecaccess-certificate-create`` command on the gateway server. You will be prompted for your ECMWF member state user name and a password (generated by a token). This certificate has to be renewed periodically (every 7 days).
     63
     64
     65.. code-block:: bash
     66   
     67   $ ecaccess-certificate-create
     68   Please enter your user-id: example_username
     69   Your passcode: ***
     70   
     71   
     72   
     73The easiest way to install all required packages is to use the package management system of your Linux distribution which required admin rights.
     74The installation was tested under *GNU/Linux Debian buster* and *Ubuntu 18.04 Bionic Beaver*.
    6475
    6576.. code-block:: sh
    6677
    67    # On a Linux Debian or Ubuntu system do
     78
     79   # On a Debian or Debian-derived sytem (e. g. Ubuntu) system you may use the following commands (or equivalent commands of your preferred package manager):
    6880   # (if not already available):
    6981   apt-get install python3
    70    apt-get install pip
    71    apt-get install genshi
    72    apt-get install numpy
    73 
     82   apt-get install python3-genshi
     83   apt-get install python3-numpy
     84   
    7485
    7586.. _ref-test-gateway:
    … …  
    7788Test gateway environment
    7889========================
    79  
     90
    8091Check the availability of the python packages by typing ``python3`` in
    8192a terminal window and run the ``import`` commands in the python shell.
    8293If there are no error messages, you succeeded in setting up the environment.
    83 
     94 
    8495.. code-block:: python
    8596   
    … …  
    95106====================
    96107
    97 In this mode, access to the ECMWF computing and archiving facilities is enabled through an ECaccess gateway server on a local member state server. The ECaccess framework is necessary to interactively submit jobs to the ECMWF batch system and to transfer files between ECMWF and local gateway server.
    98 
    99 Please see `ECMWF's instructions on gateway server`_ to establish the gateway server if not already in place.
    100 Additionally, to be able to use the Ecaccess file transfer service **ectrans** please also create an association.
    101 The easiest way is to visit the ECaccess Member State Gateway website (e.g. msgatway.ecmwf.int) and follow the instructions in the short `ECaccess Presentation`_ (page 17 ff.). Additional documentation can be found on the `ECMWF ectrans site`_.
    102 
    103 After everything is set up you have to create an *ecaccess certificate* to be able to send and receive files from and to the ECMWF server. You can do this by using the ``ecaccess-certificate-create`` command on the gateway server. You will be prompted for your ECMWF member state user name and a password (which will be usually generated by a Token). This certificate has to be re-newed periodically (every 7 days).
    104 
    105 .. code-block:: bash
     108``Flex_extract`` will be run on an ECMWF server which makes the setup the same as for the **remote mode**. In the ``setup.sh`` script `[ref] <Documentation/Input/setup.html>`_, select the ``makefile.gfortran`` for the ``CONVERT2`` Fortran program and the ECMWF server (*target*) you would like to use.
     109The job script, send to the job queue via the ECaccess software, loads the required modules from the module system. For enabling the file transfer via the gateway, you have to set the *ECUID*, *ECGID*, *GATEWAY* and *DESTINATION* parameter values.
    106110   
    107    $ ecaccess-certificate-create
    108    Please enter your user-id: example_username
    109    Your passcode: ***
    110    
    111 ``Flex_extract`` will be run on an ECMWF server which makes the setup the same as for the **remote mode**. In the ``setup.sh`` script `[ref] <Documentation/Input/setup.html>`_, select the ``Makefile.gfortran`` for the ``CONVERT2`` Fortran program and the ECMWF server (*target*) you would like to use.
    112 The job script, send to the job queue via the ECaccess software, selects again automatically the correct libraries from the module system. For enableing the file transfer you have to set the *ECUID*, *ECGID*, *GATEWAY* and *DESTINATION* parameter values.
    113  
    114111
    115112.. code-block:: bash
    … …  
    123120    #
    124121    TARGET='ecgate'
    125     MAKEFILE='Makefile.gfortran'
     122    MAKEFILE='makefile.gfortran'
    126123    ECUID='uid'
    127124    ECGID='gid'
    128     GATEWAY='server.example.edu'
    129     DESTINATION='example@genericSftp'
     125    GATEWAY='localserver.tld'
     126    DESTINATION='association_name@genericSftp'
    130127    INSTALLDIR=None
    131128    JOB_TEMPLATE='job.template'
    … …  
    139136   $ ./setup.sh
    140137   
    141 to start the installation. You should see the following output at the command line.
     138to start the installation. You should see the following on standard output.
    142139   
    143140   
    … …  
    149146   You should get an email with subject "flexcompile" within the next few minutes!
    150147
    151    
    152 The email content should look like this with a "SUCCESS" statement in the last line:
     148``Flex_extract`` uses the email address connectd to the user account on ECMWF servers. The email content should look like this with a "SUCCESS" statement in the last line:
    153149
    154150.. code-block:: bash
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG