Ignore:
Timestamp:
Jul 8, 2020, 10:00:37 PM (4 years ago)
Author:
anphi <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
e0005c9
Parents:
8a53342
Message:

Update Onlinedocumentation after review of language editing

File:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/Documentation/Input/templates.html

    r5bee29a r6931f61  
    99  <meta name="viewport" content="width=device-width, initial-scale=1.0">
    1010 
    11   <title>Templates &mdash; flex_extract 7.1.1 documentation</title>
     11  <title>Templates &mdash; flex_extract 7.1.2 documentation</title>
    1212 
    1313
    … …  
    6464           
    6565              <div class="version">
    66                 7.1.1
     66                7.1.2
    6767              </div>
    6868           
    … …  
    107107<li class="toctree-l3"><a class="reference internal" href="ecmwf_env.html">ECMWF user credential file <code class="docutils literal notranslate"><span class="pre">ECMWF_ENV</span></code></a></li>
    108108<li class="toctree-l3 current"><a class="current reference internal" href="#">Templates</a><ul>
    109 <li class="toctree-l4"><a class="reference internal" href="#convert-nl">convert.nl</a></li>
    110 <li class="toctree-l4"><a class="reference internal" href="#ecmwf-env-template">ecmwf_env.template</a></li>
    111 <li class="toctree-l4"><a class="reference internal" href="#compilejob-template">compilejob.template</a></li>
    112 <li class="toctree-l4"><a class="reference internal" href="#job-temp">job.temp</a></li>
    113 <li class="toctree-l4"><a class="reference internal" href="#job-template">job.template</a></li>
     109<li class="toctree-l4"><a class="reference internal" href="#calc-etadot-nml-template">calc_etadot_nml.template</a></li>
     110<li class="toctree-l4"><a class="reference internal" href="#ecmwf-env-template">ECMWF_ENV.template</a></li>
     111<li class="toctree-l4"><a class="reference internal" href="#installscript-template">installscript.template</a></li>
     112<li class="toctree-l4"><a class="reference internal" href="#submitscript-template">submitscript.template</a></li>
     113<li class="toctree-l4"><a class="reference internal" href="#jobscript-template">jobscript.template</a></li>
    114114</ul>
    115115</li>
    … …  
    203203<p>Do not change anything in these files unless you understand the effects!</p>
    204204</div>
    205 <p>Each template file has its content framework and keeps so-called placeholder variables in the positions where the values need to be substituted at run time. These placeholders are marked by a leading <code class="docutils literal notranslate"><span class="pre">$</span></code> sign. In case of the Kornshell job scripts, where (environment) variables are used, the <code class="docutils literal notranslate"><span class="pre">$</span></code> sign needs to be doubled for <cite>escaping</cite>.</p>
     205<p>Each template file has its content framework and keeps so-called placeholder variables in the positions where the values need to be substituted at run time. These placeholders are marked by a leading <code class="docutils literal notranslate"><span class="pre">$</span></code> sign. In case of the Korn shell job scripts, where (environment) variables are used, the <code class="docutils literal notranslate"><span class="pre">$</span></code> sign needs to be doubled for <cite>escaping</cite>.</p>
    206206<p>The following templates are used; they can be found in the directory <code class="docutils literal notranslate"><span class="pre">flex_extract_vX.X/Templates</span></code>:</p>
    207 <div class="section" id="convert-nl">
    208 <h2>convert.nl<a class="headerlink" href="#convert-nl" title="Permalink to this headline">¶</a></h2>
     207<div class="section" id="calc-etadot-nml-template">
     208<h2>calc_etadot_nml.template<a class="headerlink" href="#calc-etadot-nml-template" title="Permalink to this headline">¶</a></h2>
    209209<blockquote>
    210210<div><p>This is the template for a Fortran namelist file called <code class="docutils literal notranslate"><span class="pre">fort.4</span></code> read by <code class="docutils literal notranslate"><span class="pre">calc_etadot</span></code>.
    … …  
    234234</div>
    235235<div class="section" id="ecmwf-env-template">
    236 <h2>ecmwf_env.template<a class="headerlink" href="#ecmwf-env-template" title="Permalink to this headline">¶</a></h2>
     236<h2>ECMWF_ENV.template<a class="headerlink" href="#ecmwf-env-template" title="Permalink to this headline">¶</a></h2>
    237237<blockquote>
    238238<div><p>This template is used to create the <code class="docutils literal notranslate"><span class="pre">ECMWF_ENV</span></code> file in the application modes <strong>gateway</strong> and <strong>remote</strong>. It contains the user credentials and gateway server settings for the file transfers.</p>
    … …  
    245245</div></blockquote>
    246246</div>
    247 <div class="section" id="compilejob-template">
    248 <h2>compilejob.template<a class="headerlink" href="#compilejob-template" title="Permalink to this headline">¶</a></h2>
     247<div class="section" id="installscript-template">
     248<h2>installscript.template<a class="headerlink" href="#installscript-template" title="Permalink to this headline">¶</a></h2>
    249249<blockquote>
    250250<div><p>This template is used to create the job script file called <code class="docutils literal notranslate"><span class="pre">compilejob.ksh</span></code> during the installation process for the application modes <strong>remote</strong> and <strong>gateway</strong>.</p>
    … …  
    284284  *ecg*<span class="o">)</span>
    285285  module unload grib_api
    286   module unload eccodes
    287   module unload python
    288286  module unload emos
    289287  module load python3
    290   module load eccodes/2.12.0
     288  module load eccodes
    291289  module load emos/455-r64
    292290  <span class="nb">export</span> <span class="nv">FLEXPART_ROOT_SCRIPTS</span><span class="o">=</span><span class="nv">$fp_root_scripts</span>
    … …  
    294292  <span class="p">;;</span>
    295293  *cca*<span class="o">)</span>
    296   module unload python
    297294  module switch PrgEnv-cray PrgEnv-intel
    298295  module load python3
    299   module load eccodes/2.12.0
    300   module load emos
     296  module load eccodes
     297  module load emos/455-r64
    301298  <span class="nb">echo</span> <span class="nv">$$</span><span class="o">{</span>GROUP<span class="o">}</span>
    302299  <span class="nb">echo</span> <span class="nv">$$</span><span class="o">{</span>HOME<span class="o">}</span>
    … …  
    329326</div></blockquote>
    330327</div>
    331 <div class="section" id="job-temp">
    332 <h2>job.temp<a class="headerlink" href="#job-temp" title="Permalink to this headline">¶</a></h2>
     328<div class="section" id="submitscript-template">
     329<h2>submitscript.template<a class="headerlink" href="#submitscript-template" title="Permalink to this headline">¶</a></h2>
    333330<blockquote>
    334331<div><p>This template is used to create the actual job script file called <code class="docutils literal notranslate"><span class="pre">job.ksh</span></code> for the execution of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> in the application modes <strong>remote</strong> and <strong>gateway</strong>.</p>
    … …  
    368365<span class="k">case</span> <span class="nv">$$</span><span class="o">{</span>HOST<span class="o">}</span> in
    369366  *ecg*<span class="o">)</span>
    370   module unload grib_api
    371   module unload eccodes
    372   module unload python
    373   module unload emos
    374   module load python3
    375   module load eccodes/2.12.0
    376   module load emos/455-r64
    377   <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$$</span><span class="o">{</span>PATH<span class="o">}</span>:<span class="nv">$$</span><span class="o">{</span>HOME<span class="o">}</span>/flex_extract_v7.1/Source/Python
    378   <span class="p">;;</span>
    379   *cca*<span class="o">)</span>
    380   module unload python
    381   module switch PrgEnv-cray PrgEnv-intel
    382   module load python3
    383   module load eccodes/2.12.0
    384   module load emos
    385   <span class="nb">export</span> <span class="nv">SCRATCH</span><span class="o">=</span><span class="nv">$$</span><span class="o">{</span>TMPDIR<span class="o">}</span>
    386   <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$$</span><span class="o">{</span>PATH<span class="o">}</span>:<span class="nv">$$</span><span class="o">{</span>HOME<span class="o">}</span>/flex_extract_v7.1/Source/Python
     367          module unload grib_api
     368          module unload emos
     369          module load python3
     370          module load eccodes
     371          module load emos/455-r64
     372          <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="si">${</span><span class="nv">PATH</span><span class="si">}</span>:<span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/flex_extract_v7.1/Source/Python
     373          <span class="p">;;</span>
     374          *cca*<span class="o">)</span>
     375          module switch PrgEnv-cray PrgEnv-intel
     376          module load python3
     377          module load eccodes
     378          module load emos/455-r64
     379          <span class="nb">export</span> <span class="nv">SCRATCH</span><span class="o">=</span><span class="si">${</span><span class="nv">TMPDIR</span><span class="si">}</span>
     380          <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="si">${</span><span class="nv">PATH</span><span class="si">}</span>:<span class="si">${</span><span class="nv">HOME</span><span class="si">}</span>/flex_extract_v7.1/Source/Python
    387381  <span class="p">;;</span>
    388382<span class="k">esac</span>
    … …  
    422416</div></blockquote>
    423417</div>
    424 <div class="section" id="job-template">
    425 <h2>job.template<a class="headerlink" href="#job-template" title="Permalink to this headline">¶</a></h2>
     418<div class="section" id="jobscript-template">
     419<h2>jobscript.template<a class="headerlink" href="#jobscript-template" title="Permalink to this headline">¶</a></h2>
    426420<blockquote>
    427 <div><p>This template is used to create the template for the execution job script <code class="docutils literal notranslate"><span class="pre">job.temp</span></code> for <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> in the installation process. A description of the file can be found under <code class="docutils literal notranslate"><span class="pre">job.temp</span></code>. Several parameters are set in this process, such as the user credentials and the <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> version number.</p>
     421<div><p>This template is used to create the template for the execution job script <code class="docutils literal notranslate"><span class="pre">submitscript.template</span></code> for <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> in the installation process. A description of the file can be found under <code class="docutils literal notranslate"><span class="pre">submitscript.template</span></code>. Several parameters are set in this process, such as the user credentials and the <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> version number.</p>
    428422<div class="highlight-ksh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/ksh</span>
    429423
    … …  
    455449<span class="k">case</span> <span class="nv">$$$$</span><span class="o">{</span>HOST<span class="o">}</span> in
    456450  *ecg*<span class="o">)</span>
    457   module unload grib_api
    458   module unload eccodes
    459   module unload python
    460   module unload emos
    461   module load python3
    462   module load eccodes/2.12.0
    463   module load emos/455-r64
     451          module unload grib_api
     452          module unload emos
     453          module load python3
     454          module load eccodes
     455          module load emos/455-r64
    464456  <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$$$$</span><span class="o">{</span>PATH<span class="o">}</span>:<span class="nv">$fp_root_path</span>
    465457  <span class="p">;;</span>
    466458  *cca*<span class="o">)</span>
    467   module unload python
    468   module switch PrgEnv-cray PrgEnv-intel
    469   module load python3
    470   module load eccodes/2.12.0
    471   module load emos
     459          module switch PrgEnv-cray PrgEnv-intel
     460          module load python3
     461          module load eccodes
     462          module load emos/455-r64
    472463  <span class="nb">export</span> <span class="nv">SCRATCH</span><span class="o">=</span><span class="nv">$$$$</span><span class="o">{</span>TMPDIR<span class="o">}</span>
    473464  <span class="nb">export</span> <span class="nv">PATH</span><span class="o">=</span><span class="nv">$$$$</span><span class="o">{</span>PATH<span class="o">}</span>:<span class="nv">$fp_root_path</span>
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG