v3.16.1 documentation

NCAS-CMS · Mar 1, 2024 · 8d5beef · 8d5beef
1 parent bdc6225
commit 8d5beef
Show file tree

Hide file tree

Showing 3,859 changed files with 14,163 additions and 11,710 deletions.
diff --git a/docs/2_to_3_changes.html b/docs/2_to_3_changes.html
@@ -44,7 +44,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.16.1</a></h1>
 
 
 
@@ -491,7 +491,7 @@ <h2>Changes to the  API of existing methods<a class="headerlink" href="#changes-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/Changelog.html b/docs/Changelog.html
diff --git a/docs/_downloads/cf_tutorial_files.zip b/docs/_downloads/cf_tutorial_files.zip
diff --git a/docs/_downloads/plot_15_recipe.ipynb b/docs/_downloads/plot_15_recipe.ipynb
@@ -51,7 +51,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "2. Read and select land use data by index and see properties of all constructs:\n\n"
+        "2. Read and select land use data by index and see properties of all construcs:\n\n"
       ]
     },
     {
@@ -154,7 +154,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.10"
+      "version": "3.10.13"
     }
   },
   "nbformat": 4,

diff --git a/docs/_downloads/plot_15_recipe.py b/docs/_downloads/plot_15_recipe.py
@@ -31,7 +31,7 @@
 import cf
 
 # %%
-# 2. Read and select land use data by index and see properties of all constructs:
+# 2. Read and select land use data by index and see properties of all construcs:
 f = cf.read("~/recipes/output.tif.nc")[0]
 f.dump()
 

diff --git a/docs/_downloads/recipes_jupyter.zip b/docs/_downloads/recipes_jupyter.zip
diff --git a/docs/_downloads/recipes_python.zip b/docs/_downloads/recipes_python.zip
diff --git a/docs/_downloads/tutorial.py b/docs/_downloads/tutorial.py
@@ -347,8 +347,6 @@
 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

diff --git a/docs/_images/sphx_glr_plot_15_recipe_001.png b/docs/_images/sphx_glr_plot_15_recipe_001.png
diff --git a/docs/_images/sphx_glr_plot_15_recipe_thumb.png b/docs/_images/sphx_glr_plot_15_recipe_thumb.png
diff --git a/docs/_sources/class/cf.Count.rst.txt b/docs/_sources/class/cf.Count.rst.txt
@@ -165,6 +165,15 @@ Data
    ~cf.Count.swapaxes
    ~cf.Count.transpose
 
+.. rubric:: *Expanding the data*
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Count.pad_missing
+
 .. rubric:: *Data array mask*
 
 .. autosummary::

diff --git a/docs/_sources/class/cf.Index.rst.txt b/docs/_sources/class/cf.Index.rst.txt
@@ -165,6 +165,16 @@ Data
    ~cf.Index.swapaxes
    ~cf.Index.transpose
 
+.. rubric:: *Expanding the data*
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Index.halo
+   ~cf.Index.pad_missing
+
 .. rubric:: *Data array mask*
 
 .. autosummary::
@@ -200,7 +210,6 @@ Data
    :template: method.rst
 
    ~cf.Index.__setitem__
-   ~cf.Index.halo
    ~cf.Index.masked_invalid
    ~cf.Index.subspace
    ~cf.Index.where

diff --git a/docs/_sources/class/cf.List.rst.txt b/docs/_sources/class/cf.List.rst.txt
@@ -165,6 +165,16 @@ Data
    ~cf.List.swapaxes
    ~cf.List.transpose
 
+.. rubric:: *Expanding the data*
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.List.halo
+   ~cf.List.pad_missing
+
 .. rubric:: *Data array mask*
 
 .. autosummary::
@@ -200,7 +210,6 @@ Data
    :template: method.rst
 
    ~cf.List.__setitem__
-   ~cf.List.halo
    ~cf.List.masked_invalid
    ~cf.List.subspace
    ~cf.List.where

diff --git a/docs/_sources/installation.rst.txt b/docs/_sources/installation.rst.txt
@@ -108,7 +108,7 @@ visualisation package <http://ajheaps.github.io/cf-plot>`_, run:
    :caption: *Install with conda.*
 
    $ conda install -c conda-forge cf-python cf-plot udunits2
-   $ conda install -c conda-forge esmpy>=8.0.0
+   $ conda install -c conda-forge "esmpy>=8.0.0"
 
 The second of the two ``conda`` commands is required for
 :ref:`regridding <Regridding>` to work.
@@ -129,7 +129,7 @@ To install from source (without any dependencies):
 1. Download the cf package from https://pypi.org/project/cf-python
 
 2. Unpack the library (replacing ``<version>`` with the version that
-   you want to install, e.g. ``3.16.0``):
+   you want to install, e.g. ``3.16.1``):
 
    .. code-block:: console
 
@@ -203,8 +203,8 @@ Required
 
 * `scipy <https://pypi.org/project/scipy>`_, version 1.10.0 or newer.
 
-* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.11.0.0 or up to,
-  but not including, 1.11.1.0.
+* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.11.1.0 or up to,
+  but not including, 1.11.2.0.
 
 * `cfunits <https://pypi.org/project/cfunits/>`_, version 3.3.6 or newer.
 
@@ -251,7 +251,7 @@ environments for which these features are not required.
 
   .. code-block:: console
 
-     $ conda install -c conda-forge esmpy>=8.0.0
+     $ conda install -c conda-forge "esmpy>=8.0.0"
 
   or may be installed from source.
 

diff --git a/docs/_sources/recipes/sg_execution_times.rst.txt b/docs/_sources/recipes/sg_execution_times.rst.txt
@@ -5,10 +5,10 @@
 
 Computation times
 =================
-**07:52.733** total execution time for **recipes** files:
+**14:33.977** total execution time for **recipes** files:
 
 +-------------------------------------------------------------------+-----------+--------+
-| :ref:`sphx_glr_recipes_plot_15_recipe.py` (``plot_15_recipe.py``) | 07:52.733 | 0.0 MB |
+| :ref:`sphx_glr_recipes_plot_15_recipe.py` (``plot_15_recipe.py``) | 14:33.977 | 0.0 MB |
 +-------------------------------------------------------------------+-----------+--------+
 | :ref:`sphx_glr_recipes_plot_01_recipe.py` (``plot_01_recipe.py``) | 00:00.000 | 0.0 MB |
 +-------------------------------------------------------------------+-----------+--------+

diff --git a/docs/_sources/releases.rst.txt b/docs/_sources/releases.rst.txt
@@ -16,8 +16,11 @@ Documentation for all versions of cf.
 **CF-1.11**
 -----------
 
+* `Version 3.16.1 <https://ncas-cms.github.io/cf-python-docs/3.16.1>`_ (2024-03-01)
 * `Version 3.16.0 <https://ncas-cms.github.io/cf-python-docs/3.16.0>`_ (2023-12-06)
 
+----
+
 **CF-1.10**
 -----------
 
@@ -104,7 +107,7 @@ Documentation for all versions of cf.
 * `version 0.9.8.3    <http://cfpython.bitbucket.io/docs/0.9.8.3/index.html>`_ (2014-07-14)
 * `version 0.9.8     <http://cfpython.bitbucket.io/docs/0.9.8/index.html>`_ (2013-12-06)
 * `version 0.9.6     <http://cfpython.bitbucket.io/docs/0.9.6/build/index.html>`_ (2012-11-27)
-* `version 0.9.5     <http://cfpython.bitbucket.io/docs/0.9.5/build/index.html>`_ (2012-10-01)
+* `version 0.9.5     <http://cfpython.bitbucket.io/docs/0.9.5/build/index.html>`_ (2012-10-01 *first LAMA release*)
 * `version 0.9.5.dev <http://cfpython.bitbucket.io/docs/0.9.5.dev/build/index.html>`_ (2012-09-19)
 * `version 0.9.4.2   <http://cfpython.bitbucket.io/docs/0.9.4.2/build/index.html>`_ (2012-04-17)
 * `version 0.9.4.1   <http://cfpython.bitbucket.io/docs/0.9.4.1/build/index.html>`_
@@ -169,6 +172,8 @@ e.g. ``3.13.1``.
 
     * support for new releases to the CF conventions (e.g. upgrading
       from ``CF-1.8`` to ``CF-1.9``);
+    * the introduction of significant new areas of functionality (such
+      as UGRID);
     * limited backwards-incompatible changes to the API, such as
        * changing the name of an existing function or method;
        * changing the behaviour of an existing function or method;

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.16.0',
+    VERSION: '3.16.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/aggregation_rules.html b/docs/aggregation_rules.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.16.1</a></h1>
 
 
 
@@ -130,7 +130,7 @@ <h3>Related Topics</h3>
   <section id="aggregation-rules">
 <span id="id1"></span><h1><strong>Aggregation rules</strong><a class="headerlink" href="#aggregation-rules" 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>Version 3.16.1 for version 1.11 of the CF conventions.</p>
 <p><em>David Hassell and Jonathan Gregory (2012)</em></p>
 <p><a class="reference external" href="https://cf-trac.llnl.gov/trac/ticket/78">https://cf-trac.llnl.gov/trac/ticket/78</a></p>
 <p>Aggregation is the combination of two field constructs <a class="reference internal" href="cf_data_model.html#term-field-construct"><span class="xref std std-term">field
@@ -347,7 +347,7 @@ <h3>Related Topics</h3>
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/analysis.html b/docs/analysis.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.16.1</a></h1>
 
 
 
@@ -130,7 +130,7 @@ <h3>Related Topics</h3>
   <section id="analysis">
 <span id="id1"></span><h1><strong>Analysis</strong><a class="headerlink" href="#analysis" 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>Version 3.16.1 for version 1.11 of the CF conventions.</p>
 <p>All of the Python code in this tutorial is available in an executable
 script (<a class="reference download internal" download="" href="_downloads/field_analysis.py"><code class="xref download docutils literal notranslate"><span class="pre">download</span></code></a>, 8kB).</p>
 <p>Note that this page is duplicated in the <a class="reference internal" href="tutorial.html#tutorial"><span class="std std-ref">tutorial</span></a>.</p>
@@ -2668,7 +2668,7 @@ <h3><a class="toc-backref" href="#id111">Convolution filters</a><a class="header
 border, and</p></li>
 <li><p>Control the placement position of the filter window.</p></li>
 </ul>
-<p>Note that the <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.11.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.windows</span></code></a> package has suite of window
+<p>Note that the <a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.12.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.windows</span></code></a> package has suite of window
 functions for creating window weights for filtering:</p>
 <div class="literal-block-wrapper docutils container" id="id80">
 <div class="code-block-caption"><span class="caption-text"><em>Calculate a 3-point exponential filter of the ‘Y’
@@ -2695,7 +2695,7 @@ <h3><a class="toc-backref" href="#id111">Convolution filters</a><a class="header
 <span class="pre">0.2]</span></code> will produce a non-weighted 5-point running mean; and window
 weights of <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">1,</span> <span class="pre">1,</span> <span class="pre">1,</span> <span class="pre">1]</span></code> will produce a 5-point running
 sum. Note that the window weights returned by functions of the
-<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.11.4)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.windows</span></code></a> package do not necessarily sum to 1.</p>
+<a class="reference external" href="https://docs.scipy.org/doc/scipy/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.12.0)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">scipy.signal.windows</span></code></a> package do not necessarily sum to 1.</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>The <a class="reference internal" href="method/cf.Field.moving_window.html#cf.Field.moving_window" title="cf.Field.moving_window"><code class="xref py py-obj docutils literal notranslate"><span class="pre">moving_window</span></code></a> method can not, in general, be
@@ -2848,7 +2848,7 @@ <h3><a class="toc-backref" href="#id116">Curl</a><a class="headerlink" href="#cu
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/api_reference.html b/docs/api_reference.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="index.html">cf 3.16.1</a></h1>
 
 
 
@@ -130,7 +130,7 @@ <h3>Related Topics</h3>
   <section id="api-reference">
 <h1><strong>API reference</strong><a class="headerlink" href="#api-reference" 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>Version 3.16.1 for version 1.11 of the CF conventions.</p>
 <ul class="simple">
 <li><p><strong>Construct classes</strong></p>
 <ul>
@@ -185,7 +185,7 @@ <h1><strong>API reference</strong><a class="headerlink" href="#api-reference" ti
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/attribute/cf.AuxiliaryCoordinate.Data.html b/docs/attribute/cf.AuxiliaryCoordinate.Data.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="../index.html">cf 3.16.1</a></h1>
 
 
 
@@ -152,7 +152,7 @@ <h1>cf.AuxiliaryCoordinate.Data<a class="headerlink" href="#cf-auxiliarycoordina
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/attribute/cf.AuxiliaryCoordinate.T.html b/docs/attribute/cf.AuxiliaryCoordinate.T.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="../index.html">cf 3.16.1</a></h1>
 
 
 
@@ -171,7 +171,7 @@ <h1>cf.AuxiliaryCoordinate.T<a class="headerlink" href="#cf-auxiliarycoordinate-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/attribute/cf.AuxiliaryCoordinate.Units.html b/docs/attribute/cf.AuxiliaryCoordinate.Units.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="../index.html">cf 3.16.1</a></h1>
 
 
 
@@ -163,7 +163,7 @@ <h1>cf.AuxiliaryCoordinate.Units<a class="headerlink" href="#cf-auxiliarycoordin
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/attribute/cf.AuxiliaryCoordinate.X.html b/docs/attribute/cf.AuxiliaryCoordinate.X.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="../index.html">cf 3.16.1</a></h1>
 
 
 
@@ -192,7 +192,7 @@ <h1>cf.AuxiliaryCoordinate.X<a class="headerlink" href="#cf-auxiliarycoordinate-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

diff --git a/docs/attribute/cf.AuxiliaryCoordinate.Y.html b/docs/attribute/cf.AuxiliaryCoordinate.Y.html
@@ -46,7 +46,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cf 3.16.0</a></h1>
+<h1 class="logo"><a href="../index.html">cf 3.16.1</a></h1>
 
 
 
@@ -178,7 +178,7 @@ <h1>cf.AuxiliaryCoordinate.Y<a class="headerlink" href="#cf-auxiliarycoordinate-
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-12-06.
+      &copy;2024, NCAS | Page built on 2024-03-01.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>