Changeset 5920b7f in flex_extract.git for Documentation/html/_modules/install.html


Ignore:
Timestamp:
May 30, 2020, 9:35:50 AM (4 years ago)
Author:
anphi <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
a9d33f6
Parents:
550435b
Message:

New compilation of Sphinx after extensive review in language/content/understanding

File:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/_modules/install.html

    rb1674ed r5920b7f  
    208208
    209209<span class="sd">Depending on the selected installation environment (locally or on the</span>
    210 <span class="sd">ECMWF server ecgate or cca) the program extracts the commandline</span>
     210<span class="sd">ECMWF server ecgate or cca) the program extracts the command line</span>
    211211<span class="sd">arguments and the CONTROL file parameter and prepares the corresponding</span>
    212212<span class="sd">environment.</span>
    213 <span class="sd">The necessary files are collected in a tar-ball and placed</span>
    214 <span class="sd">at the target location. There its untared, the environment variables will</span>
    215 <span class="sd">be set and the Fortran code will be compiled.</span>
    216 <span class="sd">If the ECMWF environment is selected a job script is prepared and submitted</span>
    217 <span class="sd">for the remaining configurations after putting the tar-ball to the</span>
     213<span class="sd">The necessary files are collected in a tar ball and placed</span>
     214<span class="sd">at the target location. There, is is untared, the environment variables are</span>
     215<span class="sd">set, and the Fortran code is compiled.</span>
     216<span class="sd">If the ECMWF environment is selected, a job script is prepared and submitted</span>
     217<span class="sd">for the remaining configurations after putting the tar ball on the</span>
    218218<span class="sd">target ECMWF server.</span>
    219219
    … …  
    269269<div class="viewcode-block" id="get_install_cmdline_args"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.get_install_cmdline_args">[docs]</a><span class="k">def</span> <span class="nf">get_install_cmdline_args</span><span class="p">():</span>
    270270    <span class="sd">&#39;&#39;&#39;Decomposes the command line arguments and assigns them to variables.</span>
    271 <span class="sd">    Apply default values for non mentioned arguments.</span>
     271<span class="sd">    Apply default values for arguments not present.</span>
    272272
    273273<span class="sd">    Parameters</span>
    … …  
    289289    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--makefile&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;makefile&quot;</span><span class="p">,</span>
    290290                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    291                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Name of Makefile to use for compiling the &#39;</span>
     291                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Name of makefile for compiling the &#39;</span>
    292292                        <span class="s1">&#39;Fortran program&#39;</span><span class="p">)</span>
    293293    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--ecuid&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;ecuid&quot;</span><span class="p">,</span>
    294294                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    295                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The user id at ECMWF.&#39;</span><span class="p">)</span>
     295                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;User id at ECMWF&#39;</span><span class="p">)</span>
    296296    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--ecgid&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;ecgid&quot;</span><span class="p">,</span>
    297297                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    298                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The group id at ECMWF.&#39;</span><span class="p">)</span>
     298                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Group id at ECMWF&#39;</span><span class="p">)</span>
    299299    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--gateway&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;gateway&quot;</span><span class="p">,</span>
    300300                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    301                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The name of the local gateway server.&#39;</span><span class="p">)</span>
     301                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Name of the local gateway server&#39;</span><span class="p">)</span>
    302302    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--destination&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;destination&quot;</span><span class="p">,</span>
    303303                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    304                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The ecaccess association, e.g. &#39;</span>
     304                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;ecaccess association, e.g. &#39;</span>
    305305                        <span class="s1">&#39;myUser@genericSftp&#39;</span><span class="p">)</span>
    306306
    307307    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--installdir&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;installdir&quot;</span><span class="p">,</span>
    308308                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
    309                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Root directory where &#39;</span>
    310                         <span class="s1">&#39;flex_extract will be installed to.&#39;</span><span class="p">)</span>
     309                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Root directory of the &#39;</span>
     310                        <span class="s1">&#39;flex_extract installation&#39;</span><span class="p">)</span>
    311311
    312312    <span class="c1"># arguments for job submission to ECMWF, only needed by submit.py</span>
    313313    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--job_template&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">&#39;job_template&#39;</span><span class="p">,</span>
    314314                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;job.template&quot;</span><span class="p">,</span>
    315                         <span class="n">help</span><span class="o">=</span><span class="s1">&#39;The rudimentary template file to create a batch &#39;</span>
    316                         <span class="s1">&#39;job template for submission to ECMWF servers.&#39;</span><span class="p">)</span>
     315                        <span class="n">help</span><span class="o">=</span><span class="s1">&#39;Rudimentary template file to create a batch &#39;</span>
     316                        <span class="s1">&#39;job template for submission to ECMWF servers&#39;</span><span class="p">)</span>
    317317
    318318    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--controlfile&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;controlfile&quot;</span><span class="p">,</span>
    319319                        <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;CONTROL_EA5&#39;</span><span class="p">,</span>
    320                         <span class="n">help</span><span class="o">=</span><span class="s2">&quot;The file with all CONTROL parameters.&quot;</span><span class="p">)</span>
     320                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;A file that contains all CONTROL parameters.&quot;</span><span class="p">)</span>
    321321
    322322    <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
    … …  
    326326
    327327<div class="viewcode-block" id="install_via_gateway"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.install_via_gateway">[docs]</a><span class="k">def</span> <span class="nf">install_via_gateway</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
    328     <span class="sd">&#39;&#39;&#39;Prepare data transfer to remote gate and submit a job script which will</span>
    329 <span class="sd">    install everything on the remote gate.</span>
     328    <span class="sd">&#39;&#39;&#39;Prepare data transfer to remote gateway and submit a job script which will</span>
     329<span class="sd">    install everything on the remote gateway.</span>
    330330
    331331<span class="sd">    Parameters</span>
    … …  
    421421
    422422<div class="viewcode-block" id="check_install_conditions"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.check_install_conditions">[docs]</a><span class="k">def</span> <span class="nf">check_install_conditions</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
    423     <span class="sd">&#39;&#39;&#39;Checks a couple of necessary attributes and conditions</span>
    424 <span class="sd">    for the installation such as if they exist and contain values.</span>
     423    <span class="sd">&#39;&#39;&#39;Checks necessary attributes and conditions</span>
     424<span class="sd">    for the installation, e.g. whether they exist and contain values.</span>
    425425<span class="sd">    Otherwise set default values.</span>
    426426
    … …  
    472472    <span class="sd">&#39;&#39;&#39;Creates a tarball with all necessary files which need to be sent to the</span>
    473473<span class="sd">    installation directory.</span>
    474 <span class="sd">    It does not matter if this is local or remote.</span>
    475 <span class="sd">    Collects all python files, the Fortran source and makefiles,</span>
     474<span class="sd">    It does not matter whether this is local or remote.</span>
     475<span class="sd">    Collects all Python files, the Fortran source and makefiles,</span>
    476476<span class="sd">    the ECMWF_ENV file, the CONTROL files as well as the</span>
    477477<span class="sd">    template files.</span>
    … …  
    659659<span class="sd">    ----------</span>
    660660<span class="sd">    makefile : str</span>
    661 <span class="sd">        Name of the makefile which should be used to compile FORTRAN</span>
    662 <span class="sd">        CONVERT2 program.</span>
     661<span class="sd">        Name of the makefile which should be used to compile the Fortran</span>
     662<span class="sd">        program.</span>
    663663
    664664<span class="sd">    ecuid : str</span>
    … …  
    848848            <span class="nb">print</span><span class="p">(</span><span class="n">perr</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
    849849            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Please edit &#39;</span> <span class="o">+</span> <span class="n">makefile</span> <span class="o">+</span>
    850                   <span class="s1">&#39; or try another Makefile in the src directory.&#39;</span><span class="p">)</span>
     850                  <span class="s1">&#39; or try another makefile in the src directory.&#39;</span><span class="p">)</span>
    851851            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Most likely GRIB_API_INCLUDE_DIR, GRIB_API_LIB &#39;</span>
    852852                  <span class="s1">&#39;and EMOSLIB must be adapted.&#39;</span><span class="p">)</span>
    853             <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Available Makefiles:&#39;</span><span class="p">)</span>
    854             <span class="nb">print</span><span class="p">(</span><span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="s1">&#39;Makefile*&#39;</span><span class="p">))</span>
     853            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Available makefiles:&#39;</span><span class="p">)</span>
     854            <span class="nb">print</span><span class="p">(</span><span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="s1">&#39;makefile*&#39;</span><span class="p">))</span>
    855855            <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">&#39;Compilation failed!&#39;</span><span class="p">)</span>
    856856    <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
    857         <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;ERROR: Makefile call failed:&#39;</span><span class="p">)</span>
     857        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;ERROR: make of Fortran code failed:&#39;</span><span class="p">)</span>
    858858        <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
    859859    <span class="k">else</span><span class="p">:</span>
    860         <span class="n">execute_subprocess</span><span class="p">([</span><span class="s1">&#39;ls&#39;</span><span class="p">,</span> <span class="s1">&#39;-l&#39;</span><span class="p">,</span>
     860        <span class="n">execute_subprocess</span><span class="p">([</span><span class="s1">&#39;ls&#39;</span><span class="p">,</span> <span class="s1">&#39;-l&#39;</span><span class="p">,</span> 
    861861                            <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="n">_config</span><span class="o">.</span><span class="n">FORTRAN_EXECUTABLE</span><span class="p">)],</span>
    862862                           <span class="n">error_msg</span><span class="o">=</span><span class="s1">&#39;FORTRAN EXECUTABLE COULD NOT BE FOUND!&#39;</span><span class="p">)</span>
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG