Skip to content

Commit

Permalink
v3.15.4 documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@davidhassell
davidhassell committed Oct 10, 2023
1 parent ccae428 commit af65855
Show file tree
Hide file tree
Showing 3,888 changed files with 16,895 additions and 17,167 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion cf/mixin/propertiesdata.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3282,7 +3282,7 @@ def equivalent(self, other, rtol=None, atol=None, traceback=False):
return True

# Check that each instance is the same type
if type(self) != type(other):
if type(self) is not type(other):
print(
f"{self.__class__.__name__}: Different types: "
f"{self.__class__.__name__}, {other.__class__.__name__}"
Expand Down
2 changes: 1 addition & 1 deletion cf/mixin/propertiesdatabounds.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1734,7 +1734,7 @@ def equivalent(self, other, rtol=None, atol=None, traceback=False):
return True

# Check that each instance is the same type
if type(self) != type(other):
if type(self) is not type(other):
print(
f"{self.__class__.__name__}: Different types: "
f"{self.__class__.__name__}, {other.__class__.__name__}"
Expand Down
6 changes: 3 additions & 3 deletions docs/2_to_3_changes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@



<h1 class="logo"><a href="index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -142,7 +142,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.11)"><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.12)"><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>
Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>
Expand Down
495 changes: 256 additions & 239 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.
14 changes: 0 additions & 14 deletions docs/_sources/recipes/sg_execution_times.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,10 @@

Computation times
=================
<<<<<<< HEAD
**07:52.733** total execution time for **recipes** files:

+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_15_recipe.py` (``plot_15_recipe.py``) | 07:52.733 | 0.0 MB |
=======
**60:33.053** total execution time for **recipes** files:

+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_15_recipe.py` (``plot_15_recipe.py``) | 54:12.592 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_13_recipe.py` (``plot_13_recipe.py``) | 05:17.754 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_12_recipe.py` (``plot_12_recipe.py``) | 01:02.707 | 0.0 MB |
>>>>>>> 972cdaadceecfaa123a4956c50333c6bc1f0f56f
+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_01_recipe.py` (``plot_01_recipe.py``) | 00:00.000 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
Expand All @@ -43,12 +32,9 @@ Computation times
+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_11_recipe.py` (``plot_11_recipe.py``) | 00:00.000 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
<<<<<<< HEAD
| :ref:`sphx_glr_recipes_plot_12_recipe.py` (``plot_12_recipe.py``) | 00:00.000 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
| :ref:`sphx_glr_recipes_plot_13_recipe.py` (``plot_13_recipe.py``) | 00:00.000 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
=======
>>>>>>> 972cdaadceecfaa123a4956c50333c6bc1f0f56f
| :ref:`sphx_glr_recipes_plot_14_recipe.py` (``plot_14_recipe.py``) | 00:00.000 | 0.0 MB |
+-------------------------------------------------------------------+-----------+--------+
1 change: 1 addition & 0 deletions docs/_sources/releases.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Documentation for all versions of cf.
**CF-1.10**
-----------

* `Version 3.15.4 <https://ncas-cms.github.io/cf-python-docs/3.15.4>`_ (2023-10-10)
* `Version 3.15.3 <https://ncas-cms.github.io/cf-python-docs/3.15.3>`_ (2023-08-31)
* `Version 3.15.2 <https://ncas-cms.github.io/cf-python-docs/3.15.2>`_ (2023-07-21)
* `Version 3.15.1 <https://ncas-cms.github.io/cf-python-docs/3.15.1>`_ (2023-06-09)
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.15.3',
VERSION: '3.15.4',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
1 change: 0 additions & 1 deletion docs/_static/pygments.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #a40000 } /* Generic.Deleted */
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
.highlight .ges { color: #000000 } /* Generic.EmphStrong */
.highlight .gr { color: #ef2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
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 @@ -46,7 +46,7 @@



<h1 class="logo"><a href="index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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.15.3 for version 1.10 of the CF conventions.</p>
<p>Version 3.15.4 for version 1.10 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 @@ -347,7 +347,7 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2023, NCAS | Page built on 2023-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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.15.3 for version 1.10 of the CF conventions.</p>
<p>Version 3.15.4 for version 1.10 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 @@ -2079,16 +2079,16 @@ <h2><a class="toc-backref" href="#id90"><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.25)"><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.26)"><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.25)"><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.26)"><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.25)"><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.26)"><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 @@ -2272,7 +2272,7 @@ <h2><a class="toc-backref" href="#id90"><strong>Other statistical operations</st
<code class="xref py py-obj docutils literal notranslate"><span class="pre">standard_name</span></code> properties (or <code class="xref py py-obj docutils literal notranslate"><span class="pre">id</span></code> attributes) on metadata
constructs that are known to correspond, then setting “relaxed
identities” with the <a class="reference internal" href="function/cf.relaxed_identities.html#cf.relaxed_identities" title="cf.relaxed_identities"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cf.relaxed_identities</span></code></a> function may
help. Setting relaxed identities to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> allows the <code class="xref py py-obj docutils literal notranslate"><span class="pre">long_name</span></code>
help. Setting relaxed identities to <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">True</span></code></a> allows the <code class="xref py py-obj docutils literal notranslate"><span class="pre">long_name</span></code>
property and netCDF variable name (see the <a class="reference internal" href="tutorial.html#netcdf-interface"><span class="std std-ref">netCDF interface</span></a>), to also be considered when identifying
constructs.</p></li>
<li><p><strong>Option 3:</strong> Add more metadata to the field and metadata constructs.</p></li>
Expand Down Expand Up @@ -2641,7 +2641,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.2)"><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.11.3)"><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’
Expand All @@ -2668,7 +2668,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.2)"><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.11.3)"><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 @@ -2821,7 +2821,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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</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 @@ -46,7 +46,7 @@



<h1 class="logo"><a href="index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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.15.3 for version 1.10 of the CF conventions.</p>
<p>Version 3.15.4 for version 1.10 of the CF conventions.</p>
<ul class="simple">
<li><p><strong>Construct classes</strong></p>
<ul>
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;2023, NCAS | Page built on 2023-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</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 @@ -46,7 +46,7 @@



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -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-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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



<h1 class="logo"><a href="../index.html">cf 3.15.3</a></h1>
<h1 class="logo"><a href="../index.html">cf 3.15.4</a></h1>



Expand Down Expand Up @@ -204,7 +204,7 @@ <h1>cf.AuxiliaryCoordinate.Z<a class="headerlink" href="#cf-auxiliarycoordinate-
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2023, NCAS | Page built on 2023-08-31.
&copy;2023, NCAS | Page built on 2023-10-10.

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

0 comments on commit af65855

Please sign in to comment.