Changeset eca358d in flex_extract.git for Documentation/html/_modules/GribUtil.html


Ignore:
Timestamp:
Feb 1, 2020, 9:32:17 PM (4 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
072cbea
Parents:
53d3b2a
Message:

updated online documentation with links on index page

File:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/_modules/GribUtil.html

    r30f7911 reca358d  
    230230
    231231
    232 <div class="viewcode-block" id="GribUtil.get_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.get_keys">[docs]</a>    <span class="k">def</span> <span class="nf">get_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="o">=</span><span class="p">[],</span> <span class="n">wherekeyvalues</span><span class="o">=</span><span class="p">[]):</span>
     232<div class="viewcode-block" id="GribUtil.get_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.get_keys">[docs]</a>    <span class="k">def</span> <span class="nf">get_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="p">,</span> <span class="n">wherekeyvalues</span><span class="p">):</span>
    233233        <span class="sd">&#39;&#39;&#39;Get keyvalues for a given list of keynames a where statement</span>
    234234<span class="sd">        can be given (list of key and list of values)</span>
    … …  
    239239<span class="sd">            List of keynames.</span>
    240240
    241 <span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
    242 <span class="sd">            Default value is an empty list.</span>
    243 
    244 <span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
    245 <span class="sd">            Default value is an empty list.</span>
     241<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`</span>
     242<span class="sd">            List of key names for indexing grib message parameter.</span>
     243
     244<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`</span>
     245<span class="sd">            List of key values corresponding the key names.</span>
    246246
    247247<span class="sd">        Return</span>
    … …  
    284284
    285285
    286 <div class="viewcode-block" id="GribUtil.set_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.set_keys">[docs]</a>    <span class="k">def</span> <span class="nf">set_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fromfile</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="o">=</span><span class="p">[],</span>
    287                  <span class="n">wherekeyvalues</span><span class="o">=</span><span class="p">[],</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;wb&#39;</span><span class="p">):</span>
     286<div class="viewcode-block" id="GribUtil.set_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.set_keys">[docs]</a>    <span class="k">def</span> <span class="nf">set_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fromfile</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="p">,</span>
     287                 <span class="n">wherekeyvalues</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;wb&#39;</span><span class="p">):</span>
    288288        <span class="sd">&#39;&#39;&#39;Opens the file to read the grib messages and then write</span>
    289289<span class="sd">        the selected messages (with wherekeys) to a new output file.</span>
    … …  
    303303<span class="sd">            Default is an empty list.</span>
    304304
    305 <span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
     305<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`</span>
    306306<span class="sd">            List of keynames to select correct message.</span>
    307 <span class="sd">            Default value is an empty list.</span>
    308 
    309 <span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
     307
     308<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`</span>
    310309<span class="sd">            List of keyvalues for keynames to select correct message.</span>
    311 <span class="sd">            Default value is an empty list.</span>
    312 
    313 <span class="sd">        strict : :obj:`boolean`, optional</span>
    314 <span class="sd">            Decides if everything from keynames and keyvalues</span>
    315 <span class="sd">            is written out the grib file (False) or only those</span>
    316 <span class="sd">            meeting the where statement (True). Default is False.</span>
    317310
    318311<span class="sd">        filemode : :obj:`string`, optional</span>
    … …  
    362355        <span class="k">return</span></div>
    363356
    364 <div class="viewcode-block" id="GribUtil.copy_dummy_msg"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.copy_dummy_msg">[docs]</a>    <span class="k">def</span> <span class="nf">copy_dummy_msg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_in</span><span class="p">,</span> <span class="n">selectWhere</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
    365                  <span class="n">keynames</span><span class="o">=</span><span class="p">[],</span> <span class="n">keyvalues</span><span class="o">=</span><span class="p">[],</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;wb&#39;</span><span class="p">):</span>
     357<div class="viewcode-block" id="GribUtil.copy_dummy_msg"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.copy_dummy_msg">[docs]</a>    <span class="k">def</span> <span class="nf">copy_dummy_msg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_in</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">,</span>
     358                       <span class="n">selectwhere</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;wb&#39;</span><span class="p">):</span>
    366359        <span class="sd">&#39;&#39;&#39;Add the content of another input grib file to the objects file but</span>
    367360<span class="sd">        only messages corresponding to keys/values passed to the function.</span>
    … …  
    374367<span class="sd">            Filename of the input file to read the grib messages from.</span>
    375368
    376 <span class="sd">        selectWhere : :obj:`boolean`, optional</span>
     369<span class="sd">        selectwhere : :obj:`boolean`, optional</span>
    377370<span class="sd">            Decides if to copy the keynames and values equal to (True) or</span>
    378371<span class="sd">            different to (False) the keynames/keyvalues list passed to the</span>
    379372<span class="sd">            function. Default is True.</span>
    380373
    381 <span class="sd">        keynames : :obj:`list` of :obj:`string`, optional</span>
    382 <span class="sd">            List of keynames. Default is an empty list.</span>
    383 
    384 <span class="sd">        keyvalues : :obj:`list` of :obj:`string`, optional</span>
    385 <span class="sd">            List of keyvalues. Default is an empty list.</span>
     374<span class="sd">        keynames : :obj:`list` of :obj:`string`</span>
     375<span class="sd">            List of keynames.</span>
     376
     377<span class="sd">        keyvalues : :obj:`list` of :obj:`string`</span>
     378<span class="sd">            List of keyvalues.</span>
    386379
    387380<span class="sd">        filemode : :obj:`string`, optional</span>
    … …  
    416409                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Key was not defined&quot;</span><span class="p">)</span>
    417410
    418                 <span class="k">if</span> <span class="n">selectWhere</span><span class="p">:</span>
     411                <span class="k">if</span> <span class="n">selectwhere</span><span class="p">:</span>
    419412                    <span class="n">select</span> <span class="o">=</span> <span class="p">(</span><span class="n">select</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">keyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">==</span>
    420413                                          <span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))))</span>
    … …  
    434427        <span class="k">return</span></div>
    435428
    436 <div class="viewcode-block" id="GribUtil.index"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.index">[docs]</a>    <span class="k">def</span> <span class="nf">index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index_keys</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;mars&quot;</span><span class="p">],</span> <span class="n">index_file</span><span class="o">=</span><span class="s2">&quot;my.idx&quot;</span><span class="p">):</span>
     429<div class="viewcode-block" id="GribUtil.index"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.index">[docs]</a>    <span class="k">def</span> <span class="nf">index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index_keys</span><span class="p">,</span> <span class="n">index_file</span><span class="o">=</span><span class="s2">&quot;my.idx&quot;</span><span class="p">):</span>
    437430        <span class="sd">&#39;&#39;&#39;Create index file from a list of files if it does not exist or</span>
    438431<span class="sd">        read an index file.</span>
    … …  
    440433<span class="sd">        Parameters</span>
    441434<span class="sd">        ----------</span>
    442 <span class="sd">        index_keys: :obj:`list` of :obj:`string`, optional</span>
     435<span class="sd">        index_keys: :obj:`list` of :obj:`string`</span>
    443436<span class="sd">            Contains the list of key parameter names from</span>
    444437<span class="sd">            which the index is to be created.</span>
    445 <span class="sd">            Default is a list with a single entry string &quot;mars&quot;.</span>
    446438
    447439<span class="sd">        index_file: :obj:`string`, optional</span>
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG