TNO Intern

Commit de25f0fe authored by Arjo Segers's avatar Arjo Segers
Browse files

Updates for processing S5p/HCHO.

parent 6a2899d1

doc/build/html/pymod-cso_file.html

+3 −3
Original line number Diff line number Diff line
@@ -67,7 +67,7 @@ 
<dl class="py class">

<dt class="sig sig-object py" id="cso_file.CSO_File">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cso_file.</span></span><span class="sig-name descname"><span class="pre">CSO_File</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cso_file.CSO_File" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Storage for satelite data extract.</p>

<p>If optional <code class="docutils literal notranslate"><span class="pre">filename</span></code> is provided, the <code class="xref py py-meth docutils literal notranslate"><span class="pre">Read()</span></code> method is

called to read data from a file. If the optional <code class="docutils literal notranslate"><span class="pre">varname</span></code> list
@@ -192,7 +192,7 @@ unless <code class="docutils literal notranslate"><span class="pre">quiet=True</ 
<dl class="py class">

<dt class="sig sig-object py" id="cso_file.CSO_Listing">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cso_file.</span></span><span class="sig-name descname"><span class="pre">CSO_Listing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renew</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cso_file.CSO_Listing" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Storage for table with file properties.

The records describe properties of <a class="reference internal" href="#cso_file.CSO_File" title="cso_file.CSO_File"><code class="xref py py-class docutils literal notranslate"><span class="pre">CSO_File</span></code></a> files,

for example the time range of the pixels included.
@@ -228,7 +228,7 @@ with pixels within a requested interval.</p> 
<dd><p>Add record (or replace) for <code class="docutils literal notranslate"><span class="pre">filename</span></code> with information

from the <code class="docutils literal notranslate"><span class="pre">csf</span></code> <a class="reference internal" href="#cso_file.CSO_File" title="cso_file.CSO_File"><code class="xref py py-class docutils literal notranslate"><span class="pre">CSO_File</span></code></a> object.</p>

<p>The time range of pixels is read from the <code class="docutils literal notranslate"><span class="pre">csf</span></code> object,

unless the <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> tupple <code class="docutils literal notranslate"><span class="pre">tr=(t1,t2)</span></code> is supplied.</p>

unless the <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> tupple <code class="docutils literal notranslate"><span class="pre">tr=(t1,t2)</span></code> is supplied.</p>

<p>The optional <code class="docutils literal notranslate"><span class="pre">xcolumns</span></code> specify a list of global attributes 

to be added as extra columns.</p>

</dd></dl>

doc/build/html/pymod-cso_plot.html

+1 −1
Original line number Diff line number Diff line
@@ -74,7 +74,7 @@ 
<dl class="py class">

<dt class="sig sig-object py" id="cso_plot.Figure">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cso_plot.</span></span><span class="sig-name descname"><span class="pre">Figure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">figsize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cso_plot.Figure" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Base class for figures.</p>

<dl class="py method">

<dt class="sig sig-object py" id="cso_plot.Figure.Close">

doc/build/html/pymod-cso_s5p.html

+28 −6
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ into a CSO format.</p> 
<dl class="py class">

<dt class="sig sig-object py" id="cso_s5p.S5p_File">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cso_s5p.</span></span><span class="sig-name descname"><span class="pre">S5p_File</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cso_s5p.S5p_File" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Base class to access data in S5p file.</p>

<p>Example of variables:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">PRODUCT</span><span class="o">/</span>
@@ -263,6 +263,9 @@ correct conversion. The following specials are currently implemented:</p> 
<li><p><code class="docutils literal notranslate"><span class="pre">track_latitude</span></code>           : latiudes  at centers of original 2D track; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">track_longitude_bounds</span></code>   : longiude bounds at centers of original 2D track; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">track_latitude_bounds</span></code>    : latiude  bounds at centers of original 2D track; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">ground_pixel</span></code>             : index of ground pixel in original 2D track; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">sum</span></code> : create a variable as the sum over over layers; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">square</span></code> : create a variable as the square of the input; requires a <code class="docutils literal notranslate"><span class="pre">.from</span></code> setting</p></li>

<li><p><code class="docutils literal notranslate"><span class="pre">time</span></code> : create time stamps per pixel from a reference time and a time delta; requires settings:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">time</span><span class="o">.</span><span class="n">tref</span>      <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">time</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">time</span><span class="o">.</span><span class="n">dt</span>        <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">delta_time</span>
@@ -270,7 +273,7 @@ correct conversion. The following specials are currently implemented:</p> 
</div>

</li>

<li><p><code class="docutils literal notranslate"><span class="pre">hybounds_to_pressure</span></code> : form pressure from hybride sigma pressure coordinate,

where the available hybride coefficients have shape <code class="docutils literal notranslate"><span class="pre">('layer','vertices')</span></code>;

where the available hybride coefficients have shape <code class="docutils literal notranslate"><span class="pre">('layer',2)</span></code>;

requires settings:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">sp</span>       <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">surface_pressure</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">hyab</span>     <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">tm5_constant_a</span>
@@ -279,6 +282,25 @@ requires settings:</p> 
</pre></div>

</div>

</li>

<li><p><code class="docutils literal notranslate"><span class="pre">hymid_to_pressure</span></code> : form pressure from hybride sigma pressure coordinate,

where the available hybride coefficients are valid for the middle of the layers and 

therefore have shape <code class="docutils literal notranslate"><span class="pre">('layer')</span></code>;

requires settings:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">sp</span>       <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">surface_pressure</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">hyam</span>     <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">hyam</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">hybm</span>     <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">hybm</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">units</span>    <span class="p">:</span>   <span class="n">Pa</span>

</pre></div>

</div>

</li>

<li><p><code class="docutils literal notranslate"><span class="pre">sp_dp_to_pressure</span></code> : form pressure from surface pressure and a constant pressure step per layer 

(top at zero); requires settings:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">sp</span>       <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">surface_pressure</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">dp</span>       <span class="p">:</span>   <span class="n">PRODUCT</span><span class="o">/</span><span class="n">SUPPORT_DATA</span><span class="o">/</span><span class="n">INPUT_DATA</span><span class="o">/</span><span class="n">pressure_interval</span>

<span class="o">&lt;</span><span class="n">rcbase</span><span class="o">&gt;.</span><span class="n">output</span><span class="o">.</span><span class="n">var</span><span class="o">.</span><span class="n">pressure</span><span class="o">.</span><span class="n">units</span>    <span class="p">:</span>   <span class="n">Pa</span>

</pre></div>

</div>

</li>

<li><p><code class="docutils literal notranslate"><span class="pre">kernel_trop</span></code> : create averaging kernel for tropospheric column as the original kernel times

the ratio between total-air-mass-factor and tropospheric-air-mass-factor:</p>

<div class="math notranslate nohighlight">
@@ -306,10 +328,10 @@ the data is converted to the provided units:</p> 
<p>Optionally provide a dictionairy with attributes to be added.

If the attribute value is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the attribute is removed if present from the input;

this is sometimes needed if the CF compliance checker complains:</p>

<blockquote>

<div><p>!~ skip some attributes, cf-checker complains …

&lt;rcbase&gt;.output.var.qa_value.attrs         :   { ‘valid_min’ : None, ‘valid_max’ : None }</p>

</div></blockquote>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>!~ skip some attributes, cf-checker complains ...

&lt;rcbase&gt;.output.var.qa_value.attrs         :   { &#39;valid_min&#39; : None, &#39;valid_max&#39; : None }

</pre></div>

</div>

</dd></dl>



</dd></dl>

doc/build/html/pymod-rc.html

+2 −2
Original line number Diff line number Diff line
@@ -452,7 +452,7 @@ and rcfile values, and resolve using recursive calls.</div> 
<dl class="py class">

<dt class="sig sig-object py" id="rc.RcFile">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">rc.</span></span><span class="sig-name descname"><span class="pre">RcFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marks</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('${',</span> <span class="pre">'}')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">env</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#rc.RcFile" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Class to store settings read from a rcfile. 

The filename of the rcfile to be read should be passed as first argument.</p>

<p>Variable substitutions are applied and special lines are evaluated,
@@ -503,7 +503,7 @@ system on which value is returned for the given key.</p> 
</ul>

</li>

<li><p>If ‘totype’ is set to ‘datetime’, the content is read into a

<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> object.</p></li>

<a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime.datetime</span></code></a> object.</p></li>

</ul>

<p>For other values, an exception will be raised.</p>

</dd></dl>

doc/build/html/pymod-utopya_base.html

+1 −1
Original line number Diff line number Diff line
@@ -58,7 +58,7 @@ 
<dl class="py class">

<dt class="sig sig-object py" id="utopya_base.UtopyaBase">

<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">utopya_base.</span></span><span class="sig-name descname"><span class="pre">UtopyaBase</span></span><a class="headerlink" href="#utopya_base.UtopyaBase" title="Permalink to this definition"></a></dt>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>

<p>Base class for UTOPyA objects.</p>

</dd></dl>