Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

  • For_developers/Sphinx/source/Documentation/Input/setup.rst

    rb1674ed rf20342a  
    11**************************************
    2 The Installation Script - ``setup.sh``
     2The installation script - ``setup.sh``
    33**************************************
    44
    5 
    6 The installation of ``flex_extract`` is done by the Shell script ``setup.sh`` which is located in the root directory of ``flex_extract``.
    7 It calls the top-level Python script ``install.py`` which does all necessary operations to prepare the selected application environment. This includes:
    8 
    9 - preparing the file ``ECMWF_ENV`` with the user credentials for member state access to ECMWF servers (in **remote** and **gateway** mode)
     5The installation of ``flex_extract`` is done by the shell script ``setup.sh`` located in the root directory of ``flex_extract``.
     6It calls the top-level Python script ``install.py`` which does all the necessary operations to prepare the  application environment selected. This includes:
     7
     8- preparing the file ``ECMWF_ENV`` with the user credentials for member-state access to ECMWF servers (in **remote** and **gateway** mode)
    109- preparation of a compilation Korn-shell script (in **remote** and **gateway** mode)
    1110- preparation of a job template with user credentials (in **remote** and **gateway** mode)
    12 - create a tar-ball of all necessary files
    13 - copying tar-ball to target location (depending on application mode and installation path)
    14 - submit compilation script to batch queue at ECMWF servers (in **remote** and **gateway** mode) or just untar tar-ball at target location (**local mode**)
    15 - compilation of the FORTRAN90 program ``calc_etadot``
    16 
    17 
    18 The Python installation script ``install.py`` has a couple of command line arguments which are defined in ``setup.sh`` in the section labelled with "*AVAILABLE COMMANDLINE ARGUMENTS TO SET*". The user has to adapt these parameters for his personal use. The parameters are listed and described in :ref:`ref-instparams`. The script also does some checks to guarantee necessary parameters were set.
     11- create a tarball of all necessary files
     12- copying the tarball to the target location (depending on application mode and installation path)
     13- submit the compilation script to the batch queue at ECMWF servers (in **remote** and **gateway** mode) or just untar the tarball at target location (**local mode**)
     14- compilation of the Fortran program ``calc_etadot``
     15
     16
     17The Python installation script ``install.py`` has several command line arguments defined in ``setup.sh``, in the section labelled "*AVAILABLE COMMANDLINE ARGUMENTS TO SET*". The user has to adapt these parameters according to his/her personal needs. The parameters are listed and described in :ref:`ref-instparams`. The script also does some checks to guarantee that the necessary parameters were set.
    1918   
    2019After the installation process, some tests can be conducted. They are described in section :ref:`ref-testinstallfe`.
    2120
    22 The following diagram sketches the involved files and scripts in the installation process:
     21The following diagram sketches the files and scripts involved in the installation process:
    2322
    2423.. _ref-install-blockdiag:
    … …  
    115114
    116115.. blockdiag::
    117    :caption: Diagram of data flow during the installation process. The trapezoids are input files with the light blue area being the template files. The edge-rounded, orange boxes are the executable files which start the installation process and reads the input files. The rectangular, green boxes are the output files. The light green files are files which are only needed in the remota and gateway mode.
     116   :caption: Diagram of data flow during the installation process. Trapezoids are input files with the light blue area being the template files. Round-edge orange boxes are executable files which start the installation process and read the input files. Rectangular green boxes are  output files. Light green files are  needed only in the remota and gateway mode.
    118117
    119118   blockdiag {
    … …  
    133132.. _ref-instparams:
    134133
    135 Installation Parameter
    136 ----------------------
     134Installation parameters
     135-----------------------
    137136   
    138137.. exceltable:: Parameter for Installation
    … …  
    155154----------------------------------
    156155
    157 It is also possible to start the installation process of ``flex_extract`` directly from command line by using the ``install.py`` script instead of the wrapping Shell script ``setup.sh``.  This top-level script is located in
    158 ``flex_extract_vX.X/Source/Python`` and is executable. With the ``help`` parameter we see again all possible
    159 command line parameter.
     156It is also possible to start the installation process of ``flex_extract`` directly from the command line by using the ``install.py`` script instead of the wrapper shell script ``setup.sh``.  This top-level script is located in
     157``flex_extract_vX.X/Source/Python`` and is executable. With the ``--help`` parameter,
     158we see again all possible command line parameters.
    160159
    161160.. code-block:: bash
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG