Changeset 6931f61 in flex_extract.git for Documentation/html/quick_start.html


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/quick_start.html

    r5bee29a r6931f61  
    99  <meta name="viewport" content="width=device-width, initial-scale=1.0">
    1010 
    11   <title>Usage &mdash; flex_extract 7.1.1 documentation</title>
     11  <title>Usage &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           
    … …  
    227227</div>
    228228<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># On ECMWF server</span>
    229 <span class="o">[</span>&lt;ecuid&gt;@ecgb11 ~<span class="o">]</span>$ module load python3
    230229<span class="o">[</span>&lt;ecuid&gt;@ecgb11 ~<span class="o">]</span>$ <span class="nb">cd</span> flex_extract_vX.X/Run
    231230</pre></div>
    … …  
    260259<span class="nv">OUTPUTDIR</span><span class="o">=</span>None
    261260<span class="nv">PP_ID</span><span class="o">=</span>None
    262 <span class="nv">JOB_TEMPLATE</span><span class="o">=</span><span class="s1">&#39;job.temp&#39;</span>
     261<span class="nv">JOB_TEMPLATE</span><span class="o">=</span><span class="s1">&#39;jobscript.template&#39;</span>
    263262<span class="nv">CONTROLFILE</span><span class="o">=</span><span class="s1">&#39;CONTROL_CERA&#39;</span>
    264263<span class="nv">DEBUG</span><span class="o">=</span><span class="m">0</span>
    … …  
    285284</pre></div>
    286285</div>
    287 <p>The last command lists the most recent logs and temporary retrieval directories (usually <code class="docutils literal notranslate"><span class="pre">pythonXXXXX</span></code>, where XXXXX is the process id). Under <code class="docutils literal notranslate"><span class="pre">pythonXXXXX</span></code> a copy of the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> file is stored under the name <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code>, the protocol is stored in the file <code class="docutils literal notranslate"><span class="pre">prot</span></code> and the temporary files as well as the resulting files are stored in a directory <code class="docutils literal notranslate"><span class="pre">work</span></code>. The original name of the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> file is stored in this new file under parameter <code class="docutils literal notranslate"><span class="pre">controlfile</span></code>.</p>
    288 <div class="literal-block-wrapper docutils container" id="id5">
    289 <div class="code-block-caption"><span class="caption-text">“Example structure of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> output directory on ECMWF servers.”</span><a class="headerlink" href="#id5" title="Permalink to this code">¶</a></div>
    290 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pythonXXXXX
     286<p>The last command lists the most recent logs and temporary retrieval directories (usually <code class="docutils literal notranslate"><span class="pre">extractXXXXX</span></code>, where XXXXX is the process id). Under <code class="docutils literal notranslate"><span class="pre">extractXXXXX</span></code> a copy of the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> file is stored under the name <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code>, the protocol is stored in the file <code class="docutils literal notranslate"><span class="pre">prot</span></code> and the temporary files as well as the resulting files are stored in a directory <code class="docutils literal notranslate"><span class="pre">work</span></code>. The original name of the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> file is stored in this new file under parameter <code class="docutils literal notranslate"><span class="pre">controlfile</span></code>.</p>
     287<div class="literal-block-wrapper docutils container" id="id2">
     288<div class="code-block-caption"><span class="caption-text">“Example structure of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> output directory on ECMWF servers.”</span><a class="headerlink" href="#id2" title="Permalink to this code">¶</a></div>
     289<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>extractXXXXX
    291290├── CONTROL
    292291├── prot
    … …  
    399398<p><code class="docutils literal notranslate"><span class="pre">Flex_extract</span></code> is specialised to retrieve a limited number of datasets, namely <em>ERA-Interim</em>, <em>CERA-20C</em>, <em>ERA5</em> and <em>HRES (operational data)</em> as well as the <em>ENS (operational data, 15-day forecast)</em>. The limitation relates mainly to the dataset itself, the stream (what kind of forecast or what subset of dataset) and the experiment number. Mostly, the experiment number is equal to <code class="docutils literal notranslate"><span class="pre">1</span></code> to signal that the actual version should be used.</p>
    400399<p>The next level of differentiation would be the field type, level type and time period. <code class="docutils literal notranslate"><span class="pre">Flex_extract</span></code> currently only supports the main streams for the re-analysis datasets and provides extraction of different streams for the operational dataset. The possibilities of compositions of dataset and stream selection are represented by the current list of example <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> files. You can see this in the naming of the example files:</p>
    401 <div class="literal-block-wrapper docutils container" id="id6">
    402 <div class="code-block-caption"><span class="caption-text">“Current example <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> files distributed with <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>. “</span><a class="headerlink" href="#id6" title="Permalink to this code">¶</a></div>
     400<div class="literal-block-wrapper docutils container" id="id3">
     401<div class="code-block-caption"><span class="caption-text">“Current example <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> files distributed with <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>. “</span><a class="headerlink" href="#id3" title="Permalink to this code">¶</a></div>
    403402<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>CONTROL_CERA
    404403CONTROL_CERA.global
    … …  
    490489</div>
    491490<dl>
    492 <dt>Pure forecast</dt><dd><p>It is possible to retrieve pure forecasts exceeding one day. The forecast period available depends on the date and forecast field type. Please use MARS catalogue to check the availability. Below are some examples for 36 hour forecasts of <em>Forecast (FC)</em>, <em>Control forecast (CF)</em> and <em>Calibration/Validation forecast (CV)</em>.
     491<dt>Long forecast</dt><dd><p>It is possible to retrieve long forecasts exceeding one day. The forecast period available depends on the date and forecast field type. Please use MARS catalogue to check the availability. Below are some examples for 36 hour forecasts of <em>Forecast (FC)</em>, <em>Control forecast (CF)</em> and <em>Calibration/Validation forecast (CV)</em>.
    493492The <em>CV</em> field type was only available 3-hourly from 2006 up to 2016. It is recommended to use the <em>CF</em> type since this is available from 1992 (3-hourly) on up to today (1-hourly). <em>CV</em> and <em>CF</em> field types belong to the <em>Ensemble prediction system (ENFO)</em> which currently works with 50 ensemble members.
    494493Please be aware that in this case it is necessary to set the type for flux fields explicitly, otherwise a default value might be selected, different from what you expect!</p>
    … …  
    541540The time declaration for analysis (AN) fields uses the times of the specific analysis while the (forecast time) step has to be <code class="docutils literal notranslate"><span class="pre">0</span></code>.
    542541The forecast field types (e.g. FC, CF, CV, PF) need to declare a combination of (forescast start) time and the (forecast) step. Together they define the actual time. It is important to know the forecast starting times for the dataset to be retrieved, since they are different. In general, it is sufficient to give information for the exact time steps, but it is also possible to have more time step combinations of <code class="docutils literal notranslate"><span class="pre">TYPE</span></code>, <code class="docutils literal notranslate"><span class="pre">TIME</span></code> and <code class="docutils literal notranslate"><span class="pre">STEP</span></code> because the temporal (hourly) resolution with the <code class="docutils literal notranslate"><span class="pre">DTIME</span></code> parameter will select the correct combinations.</p>
    543 <div class="admonition-todo admonition" id="id2">
    544 <p class="admonition-title">Todo</p>
    545 <p>#PS needs to be rephrased</p>
    546 </div>
    547 <div class="literal-block-wrapper docutils container" id="id7">
    548 <div class="code-block-caption"><span class="caption-text">Example of a setting for the field types and temporal resolution. It will retrieve 3-hourly fields, with analyses at 00 and 12 UTC and the corresponding forecasts inbetween.</span><a class="headerlink" href="#id7" title="Permalink to this code">¶</a></div>
     542<div class="literal-block-wrapper docutils container" id="id4">
     543<div class="code-block-caption"><span class="caption-text">Example of a setting for the field types and temporal resolution. It will retrieve 3-hourly fields, with analyses at 00 and 12 UTC and the corresponding forecasts inbetween.</span><a class="headerlink" href="#id4" title="Permalink to this code">¶</a></div>
    549544<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span> DTIME <span class="m">3</span>
    550545 TYPE AN FC FC FC AN FC FC FC
    … …  
    558553There are several options for this, and the following parameters are responsible for the selection.                 See <a class="reference internal" href="Documentation/vertco.html"><span class="doc">Vertical wind</span></a> for a detailed explanation. Using <code class="docutils literal notranslate"><span class="pre">ETADIFF</span> <span class="pre">1</span></code>, <code class="docutils literal notranslate"><span class="pre">OMEGA</span> <span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">OMEGADIFF</span> <span class="pre">1</span></code> is recommended for debugging and testing only.
    559554Usually, one has to decide between <code class="docutils literal notranslate"><span class="pre">GAUSS</span> <span class="pre">1</span></code> and <code class="docutils literal notranslate"><span class="pre">ETA</span> <span class="pre">1</span></code>. <code class="docutils literal notranslate"><span class="pre">GAUSS</span> <span class="pre">1</span></code> means that spectral fields of the horizontal wind fields and the divergence are retrieved and that the vertical velocity is calculate using the continuity equation. <code class="docutils literal notranslate"><span class="pre">ETA</span> <span class="pre">1</span></code> means that horizontal wind fields etadot are retrieved on a regular lat-lon grid. It is recommended to use <code class="docutils literal notranslate"><span class="pre">ETA</span> <span class="pre">1</span></code> where possible, as there is a substantial computational overhead for solving the continuity equation.</p>
    560 <div class="literal-block-wrapper docutils container" id="id8">
    561 <div class="code-block-caption"><span class="caption-text">Example setting for the vertical coordinate retrieval (recommended if etadot fields are available).</span><a class="headerlink" href="#id8" title="Permalink to this code">¶</a></div>
     555<div class="literal-block-wrapper docutils container" id="id5">
     556<div class="code-block-caption"><span class="caption-text">Example setting for the vertical coordinate retrieval (recommended if etadot fields are available).</span><a class="headerlink" href="#id5" title="Permalink to this code">¶</a></div>
    562557<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>GAUSS <span class="m">0</span>
    563558ETA <span class="m">1</span>
    … …  
    572567<dt>Grid resolution and domain</dt><dd><p>The grid and domain parameters depends on each other. <code class="docutils literal notranslate"><span class="pre">grid</span></code> refers to the grid resolution. It can be given as decimal values (e.g., <code class="docutils literal notranslate"><span class="pre">1.</span></code> meaning 1.0°), or as in previous versions of flex_extract, as integer values refering to 1/1000 degrees (e.g., <code class="docutils literal notranslate"><span class="pre">1000</span></code> means also 1°). The code applies common sense to determine what format is to be assumed.
    573568After selecting grid, the <code class="docutils literal notranslate"><span class="pre">domain</span></code> has to be defined. The extension in longitude or latitude direction must be an integer multiple of <code class="docutils literal notranslate"><span class="pre">grid</span></code>.</p>
    574 <blockquote>
    575 <div><div class="admonition-todo admonition" id="id3">
    576 <p class="admonition-title">Todo</p>
    577 <p>#PS shouldn’t we explain how to define a domain??</p>
    578 </div>
    579 </div></blockquote>
    580569<p>The horizontal resolution for spectral fields is set by the parameter <code class="docutils literal notranslate"><span class="pre">RESOL</span></code>. For information about how to select an appropriate value please read the explanation of the MARS keyword RESOL as found <a class="reference external" href="https://confluence.ecmwf.int/display/UDOC/Post-processing+keywords#Post-processingkeywords-resol">in this entry of the ECMWF on-line documentation</a> and  <a class="reference external" href="https://confluence.ecmwf.int/display/UDOC/Retrieve#Retrieve-Truncationbeforeinterpolation">this table (also ECMWF documentation)</a>.</p>
    581 <div class="literal-block-wrapper docutils container" id="id9">
    582 <div class="code-block-caption"><span class="caption-text">Example setting for a domain covering the northern hemisphere domain with a grid resolution of <code class="docutils literal notranslate"><span class="pre">0.25°</span></code>.</span><a class="headerlink" href="#id9" title="Permalink to this code">¶</a></div>
     570<div class="literal-block-wrapper docutils container" id="id6">
     571<div class="code-block-caption"><span class="caption-text">Example setting for a domain covering the northern hemisphere domain with a grid resolution of <code class="docutils literal notranslate"><span class="pre">0.25°</span></code>.</span><a class="headerlink" href="#id6" title="Permalink to this code">¶</a></div>
    583572<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>GRID <span class="m">0</span>.25
    584573RESOL <span class="m">799</span>
    … …  
    592581</div>
    593582</dd>
    594 <dt>Flux data</dt><dd><p>Flux fields are always forecast fields and contain values of the fluxes accumulated since the start of the respective forecast. As certain re-analysis dataset cover all time steps with analysis fields, it was necessary to define a new parameter set for the definition of the flux fields. The following parameters are used specifically for flux fields, if provided. <code class="docutils literal notranslate"><span class="pre">ACCTYPE</span></code> is the field type (must be a type of forecast), <code class="docutils literal notranslate"><span class="pre">ACCTIME</span></code>  the forecast starting time, and  <code class="docutils literal notranslate"><span class="pre">ACCMAXSTEP</span></code> the maximum forecast step;``DTIME`` the temporal resolution. ACCTYPE is assumed to be the same during the whole period given by ACCTIME and ACCMAXSTEP.</p>
    595 <blockquote>
    596 <div><div class="admonition-todo admonition" id="id4">
    597 <p class="admonition-title">Todo</p>
    598 <p>#PS for which application would this be typical?</p>
    599 </div>
    600 </div></blockquote>
    601 <div class="literal-block-wrapper docutils container" id="id10">
    602 <div class="code-block-caption"><span class="caption-text">Example setting for the definition of flux fields.</span><a class="headerlink" href="#id10" title="Permalink to this code">¶</a></div>
     583<dt>Flux data</dt><dd><p>Flux fields are always forecast fields and contain values of the fluxes accumulated since the start of the respective forecast. As certain re-analysis dataset cover all time steps with analysis fields, it was necessary to define a new parameter set for the definition of the flux fields. The following parameters are used specifically for flux fields. <code class="docutils literal notranslate"><span class="pre">ACCTYPE</span></code> is the field type (must be a type of forecast), <code class="docutils literal notranslate"><span class="pre">ACCTIME</span></code>  the forecast starting time, and  <code class="docutils literal notranslate"><span class="pre">ACCMAXSTEP</span></code> the maximum forecast step;``DTIME`` the temporal resolution. ACCTYPE is assumed to be the same during the whole period given by ACCTIME and ACCMAXSTEP. These values will be set automatically if not provided in a <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> file.</p>
     584<div class="literal-block-wrapper docutils container" id="id7">
     585<div class="code-block-caption"><span class="caption-text">Example setting for the definition of flux fields.</span><a class="headerlink" href="#id7" title="Permalink to this code">¶</a></div>
    603586<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span> DTIME <span class="m">3</span>
    604587 ACCTYPE FC
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG