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

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:

• Documentation/html/_modules/get_mars_data.html (modified) (4 diffs)

Documentation/html/_modules/get_mars_data.html

@@ -232 +232 @@
 <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span>
     <span class="n">inspect</span><span class="o">.</span><span class="n">getfile</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">currentframe</span><span class="p">())))</span> <span class="o">+</span> <span class="s1">&#39;/../&#39;</span><span class="p">)</span>
+<span class="c1"># pylint: disable=wrong-import-position</span>
 <span class="kn">import</span> <span class="nn">_config</span>
-<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="p">(</span><span class="n">setup_controldata</span><span class="p">,</span> <span class="n">my_error</span><span class="p">,</span> <span class="n">normal_exit</span><span class="p">,</span> <span class="n">get_cmdline_args</span><span class="p">,</span>
-                   <span class="n">read_ecenv</span><span class="p">,</span> <span class="n">make_dir</span><span class="p">)</span>
+<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="p">(</span><span class="n">setup_controldata</span><span class="p">,</span> <span class="n">my_error</span><span class="p">,</span> <span class="n">normal_exit</span><span class="p">,</span> <span class="n">make_dir</span><span class="p">)</span>
 <span class="kn">from</span> <span class="nn">Classes.EcFlexpart</span> <span class="k">import</span> <span class="n">EcFlexpart</span>
 <span class="kn">from</span> <span class="nn">Classes.UioFiles</span> <span class="k">import</span> <span class="n">UioFiles</span>
 <span class="kn">from</span> <span class="nn">Classes.MarsRetrieval</span> <span class="k">import</span> <span class="n">MarsRetrieval</span>
-
+<span class="c1"># pylint: enable=wrong-import-position</span>
+<span class="c1"># pylint: disable=invalid-name</span>
 <span class="k">try</span><span class="p">:</span>
     <span class="n">ec_api</span> <span class="o">=</span> <span class="kc">True</span>
@@ -250 +251 @@
 <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
     <span class="n">cds_api</span> <span class="o">=</span> <span class="kc">False</span>
+<span class="c1"># pylint: enable=invalid-name</span>
 <span class="c1"># ------------------------------------------------------------------------------</span>
 <span class="c1"># FUNCTION</span>
@@ -385 +387 @@
 
 <div class="viewcode-block" id="check_dates_for_nonflux_fc_times"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.check_dates_for_nonflux_fc_times">[docs]</a><span class="k">def</span> <span class="nf">check_dates_for_nonflux_fc_times</span><span class="p">(</span><span class="n">types</span><span class="p">,</span> <span class="n">times</span><span class="p">):</span>
-    <span class="sd">&#39;&#39;&#39;</span>
-<span class="sd">    &#39;&#39;&#39;</span>
-    <span class="k">for</span> <span class="n">ty</span><span class="p">,</span> <span class="n">ti</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">types</span><span class="p">,</span><span class="n">times</span><span class="p">):</span>
+    <span class="sd">&#39;&#39;&#39;Checks if the time 18UTC corresponds to forecast field.</span>
+
+<span class="sd">    Parameters</span>
+<span class="sd">    ----------</span>
+<span class="sd">    types : list of str</span>
+<span class="sd">        List of field types.</span>
+
+<span class="sd">    times : list of str or str</span>
+<span class="sd">        The time in hours of the field.</span>
+
+<span class="sd">    Return</span>
+<span class="sd">    ------</span>
+<span class="sd">    True or False</span>
+
+<span class="sd">    &#39;&#39;&#39;</span>
+    <span class="k">for</span> <span class="n">ty</span><span class="p">,</span> <span class="n">ti</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">types</span><span class="p">,</span> <span class="n">times</span><span class="p">):</span>
         <span class="k">if</span> <span class="n">ty</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;FC&#39;</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">ti</span><span class="p">)</span> <span class="o">==</span> <span class="mi">18</span><span class="p">:</span>
             <span class="k">return</span> <span class="kc">True</span>
@@ -407 +422 @@
 
 <span class="sd">    Since for basetime the extraction contains the 12 hours upfront,</span>
-<span class="sd">    if basetime is 0, the starting date has to be the day before and</span>
+<span class="sd">    if basetime is 0, the starting date has to be the day before</span>
 
 <span class="sd">    Parameters</span>