v3.3.7 latest documentation

Author: davidhassell

docs/Changelog.html

@@ -37,7 +37,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -114,6 +114,15 @@ <h3>Related Topics</h3>
   <section id="change-log">
 <h1><strong>Change log</strong><a class="headerlink" href="#change-log" title="Permalink to this headline">¶</a></h1>
 <hr class="docutils" />
+<section id="version-3-3-7">
+<h2>Version 3.3.7<a class="headerlink" href="#version-3-3-7" title="Permalink to this headline">¶</a></h2>
+<p><strong>2024-04-23</strong></p>
+<ul class="simple">
+<li><p>Allow units to be defined by <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bytes</span></code></a>
+(<a class="reference external" href="https://github.com/NCAS-CMS/cfunits/issues/54">https://github.com/NCAS-CMS/cfunits/issues/54</a>)</p></li>
+</ul>
+</section>
+<hr class="docutils" />
 <section id="version-3-3-6">
 <h2>Version 3.3.6<a class="headerlink" href="#version-3-3-6" title="Permalink to this headline">¶</a></h2>
 <p><strong>2023-05-03</strong></p>
@@ -198,10 +207,10 @@ <h2>Version 3.2.9<a class="headerlink" href="#version-3-2-9" title="Permalink to
 <h2>Version 3.2.8<a class="headerlink" href="#version-3-2-8" title="Permalink to this headline">¶</a></h2>
 <p><strong>2020-07-02</strong></p>
 <ul class="simple">
-<li><p>Fixed bug that caused failure when an <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></a> was input to
+<li><p>Fixed bug that caused failure when an <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a> or <a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></a> was input to
 <a class="reference internal" href="generated/cfunits.Units.conform.html#cfunits.Units.conform" title="cfunits.Units.conform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cfunits.Units.conform</span></code></a>
 (<a class="reference external" href="https://github.com/NCAS-CMS/cfunits/issues/9">https://github.com/NCAS-CMS/cfunits/issues/9</a>).</p></li>
-<li><p>Allowed <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></a> to be input to <a class="reference internal" href="generated/cfunits.Units.conform.html#cfunits.Units.conform" title="cfunits.Units.conform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cfunits.Units.conform</span></code></a>
+<li><p>Allowed <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></a> to be input to <a class="reference internal" href="generated/cfunits.Units.conform.html#cfunits.Units.conform" title="cfunits.Units.conform"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cfunits.Units.conform</span></code></a>
 (<a class="reference external" href="https://github.com/NCAS-CMS/cfunits/issues/9">https://github.com/NCAS-CMS/cfunits/issues/9</a>).</p></li>
 </ul>
 </section>
@@ -375,7 +384,7 @@ <h2>Version 1.0<a class="headerlink" href="#version-1-0" title="Permalink to thi
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.3.6',
+    VERSION: '3.3.7',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/_static/pygments.css

@@ -22,6 +22,7 @@ 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 */

docs/api_reference.html

@@ -37,7 +37,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -114,7 +114,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.3.6 for CF-1.10</p>
+<p>Version 3.3.7 for CF-1.11</p>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="cfunits.Units.html"><strong>cfunits.Units</strong></a><ul>
@@ -135,7 +135,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-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/cfunits.Units.html

@@ -37,7 +37,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -117,8 +117,8 @@ <h3>Related Topics</h3>
 <h1><strong>cfunits.Units</strong><a class="headerlink" href="#cfunits-units" title="Permalink to this headline">¶</a></h1>
 <dl class="class">
 <dt id="cfunits.Units">
-<em class="property">class </em><code class="sig-prename descclassname">cfunits.</code><code class="sig-name descname">Units</code><span class="sig-paren">(</span><em class="sig-param">units=None</em>, <em class="sig-param">calendar=None</em>, <em class="sig-param">formatted=False</em>, <em class="sig-param">names=False</em>, <em class="sig-param">definition=False</em>, <em class="sig-param">_ut_unit=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.6/cfunits/units.py#L467"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units" title="Permalink to this definition">¶</a></dt>
-<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
+<em class="property">class </em><code class="sig-prename descclassname">cfunits.</code><code class="sig-name descname">Units</code><span class="sig-paren">(</span><em class="sig-param">units=None</em>, <em class="sig-param">calendar=None</em>, <em class="sig-param">formatted=False</em>, <em class="sig-param">names=False</em>, <em class="sig-param">definition=False</em>, <em class="sig-param">_ut_unit=None</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.7/cfunits/units.py#L467"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Utilities for working with physical units.</p>
 <p>Store, combine and compare physical units and convert numeric
 values to different units.</p>
@@ -267,7 +267,7 @@ <h1><strong>cfunits.Units</strong><a class="headerlink" href="#cfunits-units" ti
 <span class="gp">&gt;&gt;&gt; </span><span class="n">u</span><span class="o">.</span><span class="n">calendar</span>
 <span class="gt">Traceback (most recent call last):</span>
 <span class="w">    </span><span class="o">...</span>
-<span class="gr">AttributeError</span>: <span class="n">Units has no attribute &#39;calendar&#39;</span>
+<span class="gr">AttributeError</span>: <span class="n">Units has no attribute &#39;calendar&#39;...</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">v</span> <span class="o">=</span> <span class="n">Units</span><span class="p">(</span><span class="s1">&#39;days since 2000-1-1&#39;</span><span class="p">,</span> <span class="s1">&#39;standard&#39;</span><span class="p">)</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">v</span><span class="o">.</span><span class="n">calendar</span>
 <span class="go">&#39;standard&#39;</span>
@@ -357,20 +357,20 @@ <h1><strong>cfunits.Units</strong><a class="headerlink" href="#cfunits-units" ti
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><dl class="simple">
-<dt>units: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference internal" href="#cfunits.Units" title="cfunits.Units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Units</span></code></a>, optional</dt><dd><p>Set the new units from this string.</p>
+<dt>units: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a> or <a class="reference internal" href="#cfunits.Units" title="cfunits.Units"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Units</span></code></a>, optional</dt><dd><p>Set the new units from this string.</p>
 </dd>
-<dt>calendar: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional</dt><dd><p>Set the calendar for reference time units.</p>
+<dt>calendar: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code></a>, optional</dt><dd><p>Set the calendar for reference time units.</p>
 </dd>
-<dt>formatted: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units in a
+<dt>formatted: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units in a
 standardized manner. See the <a class="reference internal" href="generated/cfunits.Units.formatted.html#cfunits.Units.formatted" title="cfunits.Units.formatted"><code class="xref py py-obj docutils literal notranslate"><span class="pre">formatted</span></code></a> method.</p>
 </dd>
-<dt>names: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units using names
+<dt>names: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units using names
 instead of symbols. See the <a class="reference internal" href="generated/cfunits.Units.formatted.html#cfunits.Units.formatted" title="cfunits.Units.formatted"><code class="xref py py-obj docutils literal notranslate"><span class="pre">formatted</span></code></a> method.</p>
 </dd>
-<dt>definition: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units using basic
+<dt>definition: <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></a>, optional</dt><dd><p>Format the string representation of the units using basic
 units. See the <a class="reference internal" href="generated/cfunits.Units.formatted.html#cfunits.Units.formatted" title="cfunits.Units.formatted"><code class="xref py py-obj docutils literal notranslate"><span class="pre">formatted</span></code></a> method.</p>
 </dd>
-<dt>_ut_unit: <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a>, optional</dt><dd><p>Set the new units from this Udunits binary unit
+<dt>_ut_unit: <a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></a>, optional</dt><dd><p>Set the new units from this Udunits binary unit
 representation. This should be an integer returned by a
 call to <code class="xref py py-obj docutils literal notranslate"><span class="pre">ut_parse</span></code> function of Udunits. Ignored if <em>units</em>
 is set.</p>
@@ -480,7 +480,7 @@ <h2>Units static methods<a class="headerlink" href="#units-static-methods" title
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/contributing.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -112,7 +112,7 @@ <h3>Related Topics</h3>
   <section id="contributing">
 <span id="id1"></span><h1><strong>Contributing</strong><a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>
 <hr class="docutils" />
-<p>Version 3.3.6 for CF-1.10</p>
+<p>Version 3.3.7 for CF-1.11</p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
 <li><p><a class="reference internal" href="#reporting-bugs" id="id2"><strong>Reporting bugs</strong></a></p></li>
@@ -215,7 +215,7 @@ <h2><a class="toc-backref" href="#id6"><strong>Contributors</strong></a><a class
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/generated/_templates/base.html

@@ -35,7 +35,7 @@
 
 
 
-<h1 class="logo"><a href="../../index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="../../index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -118,7 +118,7 @@ <h3>Related Topics</h3>
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/generated/_templates/cfbase.html

@@ -35,7 +35,7 @@
 
 
 
-<h1 class="logo"><a href="../../index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="../../index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -118,7 +118,7 @@ <h3>Related Topics</h3>
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>

docs/generated/cfunits.Units.calendar.html

@@ -37,7 +37,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.6</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.7</a></h1>
 
 
 
@@ -136,7 +136,7 @@ <h1>cfunits.Units.calendar<a class="headerlink" href="#cfunits-units-calendar" t
 <span class="gp">&gt;&gt;&gt; </span><span class="n">Units</span><span class="p">(</span><span class="s1">&#39;days since 2001-1-1&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">calendar</span>
 <span class="gt">Traceback (most recent call last):</span>
 <span class="w">    </span><span class="o">...</span>
-<span class="gr">AttributeError</span>: <span class="n">Units has no attribute &#39;calendar&#39;</span>
+<span class="gr">AttributeError</span>: <span class="n">Units has no attribute &#39;calendar&#39;...</span>
 </pre></div>
 </div>
 </dd></dl>
@@ -151,7 +151,7 @@ <h1>cfunits.Units.calendar<a class="headerlink" href="#cfunits-units-calendar" t
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2023, NCAS | Page built on 2023-05-03.
+      &copy;2024, NCAS | Page built on 2024-04-23.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.5</a>