Skip to content

Commit

Permalink
v3.13.0 latest documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidhassell
davidhassell committed Jun 23, 2022
1 parent cc2bc81 commit 57a7f10
Show file tree
Hide file tree
Showing 3,498 changed files with 11,464 additions and 11,450 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 2 additions & 2 deletions docs/2_to_3_changes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@



<h1 class="logo"><a href="index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -481,7 +481,7 @@ <h2>Changes to the API of existing methods<a class="headerlink" href="#changes-
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
446 changes: 234 additions & 212 deletions docs/Changelog.html
View file

Large diffs are not rendered by default.

Binary file modified docs/_downloads/cf_tutorial_files.zip
View file
Binary file not shown.
4 changes: 3 additions & 1 deletion docs/_sources/installation.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,15 @@ Required
* `cftime <https://pypi.org/project/cftime/>`_, version 1.5.0 or newer
(note that this package may be installed with netCDF4).

* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.9.0.1 or up to,
* `cfdm <https://pypi.org/project/cfdm/>`_, version 1.9.0.3 or up to,
but not including, 1.9.1.0.

* `cfunits <https://pypi.org/project/cfunits/>`_, version 3.3.4 or newer.

* `psutil <https://pypi.org/project/psutil/>`_, version 0.6.0 or newer.

* `packaging <https://pypi.org/project/packaging/>`_, version 20.0 or newer.

.. _UNIDATA-UDUNITS-2-library:

* `UNIDATA UDUNITS-2 library
Expand Down
6 changes: 0 additions & 6 deletions docs/_sources/introduction.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,6 @@ The cf package can:

* create subspaces of field and domain constructs,

* incorporate, and create, metadata stored in external files, and

* read, write, and create data that have been compressed by convention
(i.e. ragged or gathered arrays), whilst presenting a view of the
data in its uncompressed form.

* incorporate, and create, metadata stored in external files,

* read, write, and create data that have been compressed by convention
Expand Down
9 changes: 5 additions & 4 deletions docs/_sources/releases.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Documentation for all versions of cf.
**CF-1.9**
----------

* `Version 3.12.0 <https://ncas-cms.github.io/cf-python/3.12.0>`_ (2022-01-22)
* `Version 3.13.0 <https://ncas-cms.github.io/cf-python/3.13.0>`_ (2022-06-23)
* `Version 3.12.0 <https://ncas-cms.github.io/cf-python/3.12.0>`_ (2022-01-18)
* `Version 3.11.0 <https://ncas-cms.github.io/cf-python/3.11.0>`_ (2021-10-08)

**CF-1.8**
Expand Down Expand Up @@ -79,7 +80,7 @@ Documentation for all versions of cf.
* `version 1.0.2 <http://cfpython.bitbucket.io/docs/1.0.2/index.html>`_ (2015-06-05)
* `version 1.0 <http://cfpython.bitbucket.io/docs/1.0/index.html>`_ (2015-05-27)
* `version 0.9.9 <http://cfpython.bitbucket.io/docs/0.9.9/index.html>`_ (2015-01-05)
* `version .9.8.3 <http://cfpython.bitbucket.io/docs/0.9.8.3/index.html>`_ (2014-07-14)
* `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)
Expand Down Expand Up @@ -112,7 +113,7 @@ be found with the `cf.CF` function:
>>> import cf
>>> cf.CF()
'1.8'
'1.9'
This indicates which version of the CF conventions are represented by
this release of the cf package, and therefore the version can not be
Expand All @@ -125,7 +126,7 @@ version , and is found in the usual manner:
:caption: *Retrieve the version of the cf package.*
>>> cf.__version__
'3.7.0'
'3.13.0'
The next section outlines the scheme used to set version identifiers.

Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/tutorial.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2334,7 +2334,7 @@ Date-time ranges that span the time duration can also be created:
Time duration constructors
^^^^^^^^^^^^^^^^^^^^^^^^^^

For convenience, `cf.TtimeDuration` instances can be created with the
For convenience, `cf.TimeDuration` instances can be created with the
following constructors:

=========== ===========================================================
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '3.12.0',
VERSION: '3.13.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
6 changes: 3 additions & 3 deletions docs/aggregation_rules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -120,7 +120,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.12.0 for version 1.9 of the CF conventions.</p>
<p>Version 3.13.0 for version 1.9 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
Expand Down Expand Up @@ -334,7 +334,7 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
16 changes: 8 additions & 8 deletions docs/analysis.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -120,7 +120,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.12.0 for version 1.9 of the CF conventions.</p>
<p>Version 3.13.0 for version 1.9 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>
Expand Down Expand Up @@ -2054,16 +2054,16 @@ <h2><a class="toc-backref" href="#id92"><strong>Other statistical operations</st
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Care must be taken when combining a construct with a
<a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.22)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a> array or a <a class="reference internal" href="class/cf.Data.html#cf.Data" title="cf.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a> instance, due to the ways in
<a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.23)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a> array or a <a class="reference internal" href="class/cf.Data.html#cf.Data" title="cf.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a> instance, due to the ways in
which both of these objects allow themselves to be
combined with other types:</p>
<ul class="simple">
<li><p>If the construct is on the left hand side (LHS) of the
operation then, as expected, a construct is returned
whose data is the combination of the original
construct’s data and the <a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.22)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a> array or <a class="reference internal" href="class/cf.Data.html#cf.Data" title="cf.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>
construct’s data and the <a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.23)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a> array or <a class="reference internal" href="class/cf.Data.html#cf.Data" title="cf.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>
instance on the right hand side (RHS).</p></li>
<li><p>If, however, the construct is on the RHS then a <a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.22)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a>
<li><p>If, however, the construct is on the RHS then a <a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.23)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a>
array or <a class="reference internal" href="class/cf.Data.html#cf.Data" title="cf.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a> instance (which ever type is on the
LHS) is returned, containing the same data as in the
first case.</p></li>
Expand Down Expand Up @@ -2616,7 +2616,7 @@ <h3><a class="toc-backref" href="#id113">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/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.7.1)"><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.8.1)"><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="id81">
<div class="code-block-caption"><span class="caption-text"><em>Calculate a 3-point exponential filter of the ‘Y’
Expand All @@ -2643,7 +2643,7 @@ <h3><a class="toc-backref" href="#id113">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/reference/signal.windows.html#module-scipy.signal.windows" title="(in SciPy v1.7.1)"><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.8.1)"><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
Expand Down Expand Up @@ -2856,7 +2856,7 @@ <h3><a class="toc-backref" href="#id119">Relative vorticity</a><a class="headerl
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/api_reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -120,7 +120,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.12.0 for version 1.9 of the CF conventions.</p>
<p>Version 3.13.0 for version 1.9 of the CF conventions.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p><strong>This version of cf is for Python 3 only</strong> and there are
Expand Down Expand Up @@ -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;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
4 changes: 2 additions & 2 deletions docs/attribute/cf.AuxiliaryCoordinate.Data.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="../index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -142,7 +142,7 @@ <h1>cf.AuxiliaryCoordinate.Data<a class="headerlink" href="#cf-auxiliarycoordina
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/attribute/cf.AuxiliaryCoordinate.T.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="../index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -142,7 +142,7 @@ <h1>cf.AuxiliaryCoordinate.T<a class="headerlink" href="#cf-auxiliarycoordinate-
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="cf.AuxiliaryCoordinate.ctype.html#cf.AuxiliaryCoordinate.ctype" title="cf.AuxiliaryCoordinate.ctype"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ctype</span></code></a>, <a class="reference internal" href="cf.AuxiliaryCoordinate.X.html#cf.AuxiliaryCoordinate.X" title="cf.AuxiliaryCoordinate.X"><code class="xref py py-obj docutils literal notranslate"><span class="pre">X</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Y</span></code>, <a class="reference internal" href="cf.AuxiliaryCoordinate.Z.html#cf.AuxiliaryCoordinate.Z" title="cf.AuxiliaryCoordinate.Z"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Z</span></code></a></p>
</div>
<p><strong>Examples:</strong></p>
<p><strong>Examples</strong></p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">c</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">AuxiliaryCoordinate</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">Units</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">Units</span><span class="p">(</span><span class="s1">&#39;seconds since 1992-10-08&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">c</span><span class="o">.</span><span class="n">T</span>
Expand All @@ -161,7 +161,7 @@ <h1>cf.AuxiliaryCoordinate.T<a class="headerlink" href="#cf-auxiliarycoordinate-
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/attribute/cf.AuxiliaryCoordinate.Units.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="../index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -132,7 +132,7 @@ <h1>cf.AuxiliaryCoordinate.Units<a class="headerlink" href="#cf-auxiliarycoordin
<p>Stores the units and calendar CF properties in an internally
consistent manner. These are mirrored by the <a class="reference internal" href="cf.AuxiliaryCoordinate.units.html#cf.AuxiliaryCoordinate.units" title="cf.AuxiliaryCoordinate.units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">units</span></code></a> and
<a class="reference internal" href="cf.AuxiliaryCoordinate.calendar.html#cf.AuxiliaryCoordinate.calendar" title="cf.AuxiliaryCoordinate.calendar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">calendar</span></code></a> CF properties respectively.</p>
<p><strong>Examples:</strong></p>
<p><strong>Examples</strong></p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span><span class="o">.</span><span class="n">Units</span>
<span class="go">&lt;Units: K&gt;</span>
</pre></div>
Expand All @@ -153,7 +153,7 @@ <h1>cf.AuxiliaryCoordinate.Units<a class="headerlink" href="#cf-auxiliarycoordin
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/attribute/cf.AuxiliaryCoordinate.X.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@



<h1 class="logo"><a href="../index.html">cf 3.12.0</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.13.0</a></h1>



Expand Down Expand Up @@ -144,7 +144,7 @@ <h1>cf.AuxiliaryCoordinate.X<a class="headerlink" href="#cf-auxiliarycoordinate-
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="cf.AuxiliaryCoordinate.ctype.html#cf.AuxiliaryCoordinate.ctype" title="cf.AuxiliaryCoordinate.ctype"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ctype</span></code></a>, <a class="reference internal" href="cf.AuxiliaryCoordinate.T.html#cf.AuxiliaryCoordinate.T" title="cf.AuxiliaryCoordinate.T"><code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code></a>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Y</span></code>, <a class="reference internal" href="cf.AuxiliaryCoordinate.Z.html#cf.AuxiliaryCoordinate.Z" title="cf.AuxiliaryCoordinate.Z"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Z</span></code></a></p>
</div>
<p><strong>Examples:</strong></p>
<p><strong>Examples</strong></p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">f</span> <span class="o">=</span> <span class="n">cf</span><span class="o">.</span><span class="n">example_field</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
<span class="go">Field: specific_humidity (ncvar%q)</span>
Expand Down Expand Up @@ -182,7 +182,7 @@ <h1>cf.AuxiliaryCoordinate.X<a class="headerlink" href="#cf-auxiliarycoordinate-
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2022, NCAS | Page built on 2022-01-17.
&copy;2022, NCAS | Page built on 2022-06-23.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>
Expand Down
Loading

0 comments on commit 57a7f10

Please sign in to comment.