v3.17.0 documentation

Author: sadielbartholomew

docs/2_to_3_changes.html

@@ -44,7 +44,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.16.2</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.17.0</a></h1>
 
 
 
@@ -75,12 +75,10 @@ <h3 id="searchlabel">Quick search</h3>
 <script>$('#searchbox').show(0);</script>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="introduction.html"><strong>Introduction</strong></a></li>
-<li class="toctree-l1"><a class="reference internal" href="cf_data_model.html"><strong>CF data model</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html"><strong>Installation</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="cheat_sheet.html"><strong>Cheat Sheet</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="recipes/index.html"><strong>Recipes using cf</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="tutorial.html"><strong>Tutorial</strong></a></li>
-<li class="toctree-l1"><a class="reference internal" href="analysis.html"><strong>Analysis</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="api_reference.html"><strong>API reference</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="aggregation_rules.html"><strong>Aggregation rules</strong></a></li>
 <li class="toctree-l1"><a class="reference internal" href="performance.html"><strong>Performance</strong></a></li>
@@ -142,7 +140,7 @@ <h2>Python<a class="headerlink" href="#python" title="Permalink to this headline
 </section>
 <section id="in-place-operations">
 <h2>In-place operations<a class="headerlink" href="#in-place-operations" title="Permalink to this headline">¶</a></h2>
-<p>At version 3.x, in-place operations return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, rather than the
+<p>At version 3.x, in-place operations return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>, rather than the
 modified construct. The keyword that defines the operation to be
 in-place is now <em>inplace</em> (rather than <em>i</em>).</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">g</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">tranpose</span><span class="p">()</span>
@@ -491,7 +489,7 @@ <h2>Changes to the  API of existing methods<a class="headerlink" href="#changes-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2024, NCAS | Page built on 2024-04-26.
+      &copy;2025, NCAS | Page built on 2025-04-02.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/Changelog.html

@@ -146,17 +146,8 @@
 c = a.regridc([time], axes='T', method='linear')
 v = cf.read('vertical.nc')[0]
 print(v)
-z_p = v.construct('Z')
-print(z_p.array)
-z_ln_p = z_p.log()
-z_ln_p.axis = 'Z'
-print(z_ln_p.array)
-_ = v.replace_construct('Z', new=z_ln_p)
-new_z_p = cf.DimensionCoordinate(data=cf.Data([800, 705, 632, 510, 320.], 'hPa'))
-new_z_ln_p = new_z_p.log()
-new_z_ln_p.axis = 'Z'
-new_v = v.regridc([new_z_ln_p], axes='Z', method='linear')
-new_v.replace_construct('Z', new=new_z_p)
+new_z = cf.DimensionCoordinate(data=cf.Data([800, 705, 632, 510, 320.], 'hPa'))
+new_v = v.regridc([new_z], axes='Z', method='linear', z='Z', ln_z=True)
 print(new_v)
 q, t = cf.read('file.nc')
 t.data.stats()

docs/_downloads/cf_tutorial_files.zip

@@ -11,7 +11,7 @@
     y = cf.read('$PWD')  # Raises Exception
 except Exception:
     pass
-y = cf.read('$PWD', ignore_read_error=True)
+y = cf.read('$PWD', file_type='netCDF')
 len(y)
 x = cf.read('file.nc')
 x
@@ -35,7 +35,7 @@
 len(y * 4)
 for f in y:
     print('field:', repr(f))
-q, t = cf.read('file.nc')
+t = cf.read('file.nc')[1]
 t.properties()
 t.has_property('standard_name')
 t.get_property('standard_name')
@@ -347,6 +347,8 @@
 lon.get_geometry()
 print(lon.bounds.data.array)
 print(lon.get_interior_ring().data.array)
+f = cf.example_field(8)
+print(f)
 a = t.constructs.get('domainancillary0')
 print(a.array)
 bounds = a.bounds
@@ -763,8 +765,8 @@
 import netCDF4
 nc = netCDF4.Dataset('file.nc', 'r')
 v = nc.variables['ta']
-netcdf_array = cf.NetCDFArray(filename='file.nc', address='ta',
-                               dtype=v.dtype, shape=v.shape)
+netcdf_array = cf.NetCDF4Array(filename='file.nc', address='ta',
+                              dtype=v.dtype, shape=v.shape)
 data_disk = cf.Data(netcdf_array)
 numpy_array = v[...]
 data_memory = cf.Data(numpy_array)