v3.16.0 documentation

Author: davidhassell

docs/_images/cfdm_field.svg

@@ -14,6 +14,8 @@
 
 ----
 
+Version |release| for version |version| of the CF conventions.
+
 The CF (Climate and Forecast) metadata conventions
 (http://cfconventions.org) provide a description of the physical
 meaning of data and of their spatial and temporal properties and are
@@ -90,11 +92,19 @@ all of its metadata. It is defined as follows:
       cell measure constructs
         corresponding to CF-netCDF cell measure variables
 
+      domain topology constructs
+        corresponding to CF-netCDF UGRID mesh topology variables
+
+      cell connectivity constructs
+        corresponding to CF-netCDF UGRID connectivity variables
+
 ----
 
+
 |
 
 .. figure:: images/cfdm_field.svg
-   :scale: 8 %
 
    *The constructs of the CF data model described using UML. The field construct corresponds to a CF-netCDF data variable. The domain construct provides the linkage between the field construct and the constructs which describe measurement locations and cell properties. It is useful to define an abstract generic coordinate construct that can be used to refer to coordinates when the their type (dimension or auxiliary coordinate construct) is not an issue.*
+
+----

docs/_sources/cf_data_model.rst.txt

@@ -130,6 +130,7 @@ <h3>Related Topics</h3>
   <style> .small {font-size:small} </style><section id="cf-data-model">
 <span id="id1"></span><h1><strong>CF data model</strong><a class="headerlink" href="#cf-data-model" title="Permalink to this headline">¶</a></h1>
 <hr class="docutils" />
+<p>Version 3.16.0 for version 1.11 of the CF conventions.</p>
 <p>The CF (Climate and Forecast) metadata conventions
 (<a class="reference external" href="http://cfconventions.org">http://cfconventions.org</a>) provide a description of the physical
 meaning of data and of their spatial and temporal properties and are
@@ -188,6 +189,10 @@ <h3>Related Topics</h3>
 </dd>
 <dt id="term-cell-measure-constructs">cell measure constructs</dt><dd><p>corresponding to CF-netCDF cell measure variables</p>
 </dd>
+<dt id="term-domain-topology-constructs">domain topology constructs</dt><dd><p>corresponding to CF-netCDF UGRID mesh topology variables</p>
+</dd>
+<dt id="term-cell-connectivity-constructs">cell connectivity constructs</dt><dd><p>corresponding to CF-netCDF UGRID connectivity variables</p>
+</dd>
 </dl>
 </dd>
 </dl>
@@ -196,11 +201,11 @@ <h3>Related Topics</h3>
 <div class="line"><br /></div>
 </div>
 <figure class="align-default" id="id2">
-<a class="reference internal image-reference" href="_images/cfdm_field.svg"><img alt="_images/cfdm_field.svg" height="810.24" src="_images/cfdm_field.svg" width="606.72" /></a>
-<figcaption>
+<img alt="_images/cfdm_field.svg" src="_images/cfdm_field.svg" /><figcaption>
 <p><span class="caption-text"><em>The constructs of the CF data model described using UML. The field construct corresponds to a CF-netCDF data variable. The domain construct provides the linkage between the field construct and the constructs which describe measurement locations and cell properties. It is useful to define an abstract generic coordinate construct that can be used to refer to coordinates when the their type (dimension or auxiliary coordinate construct) is not an issue.</em></span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
 </figcaption>
 </figure>
+<hr class="docutils" />
 </section>
 
 

docs/cf_data_model.html

@@ -2465,6 +2465,8 @@ <h2 id="C">C</h2>
         <li><a href="method/cf.List.ceil.html#cf.List.ceil">(cf.List method)</a>
 </li>
       </ul></li>
+      <li><a href="cf_data_model.html#term-cell-connectivity-constructs"><strong>cell connectivity constructs</strong></a>
+</li>
       <li><a href="cf_data_model.html#term-cell-measure-constructs"><strong>cell measure constructs</strong></a>
 </li>
       <li><a href="cf_data_model.html#term-cell-method-constructs"><strong>cell method constructs</strong></a>
@@ -3814,6 +3816,8 @@ <h2 id="D">D</h2>
       <li><a href="cf_data_model.html#term-domain-axis-constructs"><strong>domain axis constructs</strong></a>
 </li>
       <li><a href="cf_data_model.html#term-domain-construct"><strong>domain construct</strong></a>
+</li>
+      <li><a href="cf_data_model.html#term-domain-topology-constructs"><strong>domain topology constructs</strong></a>
 </li>
       <li><a href="method/cf.Domain.domain_anc.html#cf.Domain.domain_anc">domain_anc() (cf.Domain method)</a>
 

docs/genindex.html

@@ -8,6 +8,21 @@
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 

docs/objects.inv

@@ -148,8 +148,8 @@ <h3>Related Topics</h3>
 <ol class="arabic simple" start="2">
 <li><p>Read the field constructs:</p></li>
 </ol>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a> <span class="o">=</span> <a href="../function/cf.read.html#cf.read" title="cf.read" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-function"><span class="n">cf</span><span class="o">.</span><span class="n">read</span></a><span class="p">(</span><span class="s2">&quot;~/recipes/cru_ts4.06.1901.2021.tmp.dat.nc&quot;</span><span class="p">)</span>
-<span class="nb">print</span><span class="p">(</span><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a></a> <span class="o">=</span> <a href="../function/cf.read.html#cf.read" title="cf.read" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-function"><a href="../function/cf.read.html#cf.read" title="cf.read" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-function"><span class="n">cf</span><span class="o">.</span><span class="n">read</span></a></a><span class="p">(</span><span class="s2">&quot;~/recipes/cru_ts4.06.1901.2021.tmp.dat.nc&quot;</span><span class="p">)</span>
+<span class="nb">print</span><span class="p">(</span><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a></a><span class="p">)</span>
 </pre></div>
 </div>
 <div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>[&lt;CF Field: ncvar%stn(long_name=time(1452), long_name=latitude(360), long_name=longitude(720))&gt;,
@@ -159,8 +159,8 @@ <h3>Related Topics</h3>
 <ol class="arabic simple" start="3">
 <li><p>Select near surface temperature by index and look at its contents:</p></li>
 </ol>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">temp</span></a> <span class="o">=</span> <a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
-<span class="nb">print</span><span class="p">(</span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">temp</span></a><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">temp</span></a></a> <span class="o">=</span> <a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.FieldList.html#cf.FieldList" title="cf.FieldList" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">f</span></a></a><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
+<span class="nb">print</span><span class="p">(</span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">temp</span></a></a><span class="p">)</span>
 </pre></div>
 </div>
 <div class="sphx-glr-script-out highlight-none notranslate"><div class="highlight"><pre><span></span>Field: long_name=near-surface temperature (ncvar%tmp)
@@ -174,13 +174,13 @@ <h3>Related Topics</h3>
 <ol class="arabic simple" start="4">
 <li><p>Average the monthly mean surface temperature values by the time axis using the collapse method:</p></li>
 </ol>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">global_avg</span></a> <span class="o">=</span> <a href="../method/cf.Field.collapse.html#cf.Field.collapse" title="cf.Field.collapse" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-method"><span class="n">temp</span><span class="o">.</span><span class="n">collapse</span></a><span class="p">(</span><span class="s2">&quot;mean&quot;</span><span class="p">,</span> <span class="n">axes</span><span class="o">=</span><span class="s2">&quot;long_name=time&quot;</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">global_avg</span></a></a> <span class="o">=</span> <a href="../method/cf.Field.collapse.html#cf.Field.collapse" title="cf.Field.collapse" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-method"><a href="../method/cf.Field.collapse.html#cf.Field.collapse" title="cf.Field.collapse" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-method"><span class="n">temp</span><span class="o">.</span><span class="n">collapse</span></a></a><span class="p">(</span><span class="s2">&quot;mean&quot;</span><span class="p">,</span> <span class="n">axes</span><span class="o">=</span><span class="s2">&quot;long_name=time&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <ol class="arabic simple" start="5">
 <li><p>Plot the global mean surface temperatures:</p></li>
 </ol>
-<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="https://ajheaps.github.io/cf-plot/con.html#cfplot.con" title="cfplot.con" class="sphx-glr-backref-module-cfplot sphx-glr-backref-type-py-function"><span class="n">cfp</span><span class="o">.</span><span class="n">con</span></a><span class="p">(</span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">global_avg</span></a><span class="p">,</span> <span class="n">lines</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s2">&quot;Global mean surface temperature&quot;</span><span class="p">)</span>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><a href="https://ajheaps.github.io/cf-plot/con.html#cfplot.con" title="cfplot.con" class="sphx-glr-backref-module-cfplot sphx-glr-backref-type-py-function"><a href="https://ajheaps.github.io/cf-plot/con.html#cfplot.con" title="cfplot.con" class="sphx-glr-backref-module-cfplot sphx-glr-backref-type-py-function"><span class="n">cfp</span><span class="o">.</span><span class="n">con</span></a></a><span class="p">(</span><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><a href="../class/cf.Field.html#cf.Field" title="cf.Field" class="sphx-glr-backref-module-cf sphx-glr-backref-type-py-class sphx-glr-backref-instance"><span class="n">global_avg</span></a></a><span class="p">,</span> <span class="n">lines</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">title</span><span class="o">=</span><span class="s2">&quot;Global mean surface temperature&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
 <img src="../_images/sphx_glr_plot_03_recipe_001.png" srcset="../_images/sphx_glr_plot_03_recipe_001.png" alt="plot 03 recipe" class = "sphx-glr-single-img"/><p class="sphx-glr-timing"><strong>Total running time of the script:</strong> ( 0 minutes  8.465 seconds)</p>