v3.3.3 latest documentation

Author: davidhassell

docs/Changelog.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -115,6 +115,14 @@ <h3>Related Topics</h3>
   <div class="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" />
+<div class="section" id="version-3-3-3">
+<h2>version 3.3.3<a class="headerlink" href="#version-3-3-3" title="Permalink to this headline">¶</a></h2>
+<hr class="docutils" />
+<p><strong>2021-05-24</strong></p>
+<ul class="simple">
+<li><p>Fixed error in <code class="xref py py-obj docutils literal notranslate"><span class="pre">setup.py</span></code> that prevented installation via <code class="xref py py-obj docutils literal notranslate"><span class="pre">pip</span></code>.</p></li>
+</ul>
+</div>
 <div class="section" id="version-3-3-2">
 <h2>version 3.3.2<a class="headerlink" href="#version-3-3-2" title="Permalink to this headline">¶</a></h2>
 <hr class="docutils" />
@@ -338,7 +346,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;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</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.2',
+    VERSION: '3.3.3',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/cfunits.Units.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -121,7 +121,7 @@ <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.2/cfunits/units.py#L469"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units" title="Permalink to this definition">¶</a></dt>
+<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.3/cfunits/units.py#L469"><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.9)"><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
@@ -484,7 +484,7 @@ <h2>Units static methods<a class="headerlink" href="#units-static-methods" title
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/_templates/base.html

@@ -34,7 +34,7 @@
 
 
 
-<h1 class="logo"><a href="../../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -119,7 +119,7 @@ <h3>Related Topics</h3>
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/_templates/cfbase.html

@@ -34,7 +34,7 @@
 
 
 
-<h1 class="logo"><a href="../../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -119,7 +119,7 @@ <h3>Related Topics</h3>
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/cfunits.Units.calendar.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -155,7 +155,7 @@ <h1>cfunits.Units.calendar<a class="headerlink" href="#cfunits-units-calendar" t
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/cfunits.Units.conform.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -123,7 +123,7 @@ <h3>Related Topics</h3>
 <h1>cfunits.Units.conform<a class="headerlink" href="#cfunits-units-conform" title="Permalink to this headline">¶</a></h1>
 <dl class="method">
 <dt id="cfunits.Units.conform">
-<em class="property">classmethod </em><code class="sig-prename descclassname">Units.</code><code class="sig-name descname">conform</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">from_units</em>, <em class="sig-param">to_units</em>, <em class="sig-param">inplace=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.2/cfunits/units.py#L2051"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.conform" title="Permalink to this definition">¶</a></dt>
+<em class="property">classmethod </em><code class="sig-prename descclassname">Units.</code><code class="sig-name descname">conform</code><span class="sig-paren">(</span><em class="sig-param">x</em>, <em class="sig-param">from_units</em>, <em class="sig-param">to_units</em>, <em class="sig-param">inplace=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.3/cfunits/units.py#L2051"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.conform" title="Permalink to this definition">¶</a></dt>
 <dd><p>Conforms values to equivalent values in a compatible unit.</p>
 <p>Returns the conformed values.</p>
 <p>The values may either be a <a class="reference external" href="https://numpy.org/doc/stable/reference/index.html#module-numpy" title="(in NumPy v1.20)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">numpy</span></code></a> array, a Python numeric type,
@@ -199,7 +199,7 @@ <h1>cfunits.Units.conform<a class="headerlink" href="#cfunits-units-conform" tit
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/cfunits.Units.copy.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -123,7 +123,7 @@ <h3>Related Topics</h3>
 <h1>cfunits.Units.copy<a class="headerlink" href="#cfunits-units-copy" title="Permalink to this headline">¶</a></h1>
 <dl class="method">
 <dt id="cfunits.Units.copy">
-<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.2/cfunits/units.py#L2307"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.copy" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.3/cfunits/units.py#L2307"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.copy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a deep copy.</p>
 <p>Equivalent to <code class="docutils literal notranslate"><span class="pre">copy.deepcopy(u)</span></code>.</p>
 <dl class="field-list simple">
@@ -150,7 +150,7 @@ <h1>cfunits.Units.copy<a class="headerlink" href="#cfunits-units-copy" title="Pe
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/cfunits.Units.equals.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -123,7 +123,7 @@ <h3>Related Topics</h3>
 <h1>cfunits.Units.equals<a class="headerlink" href="#cfunits-units-equals" title="Permalink to this headline">¶</a></h1>
 <dl class="method">
 <dt id="cfunits.Units.equals">
-<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">equals</code><span class="sig-paren">(</span><em class="sig-param">other</em>, <em class="sig-param">rtol=None</em>, <em class="sig-param">atol=None</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.2/cfunits/units.py#L2326"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.equals" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">equals</code><span class="sig-paren">(</span><em class="sig-param">other</em>, <em class="sig-param">rtol=None</em>, <em class="sig-param">atol=None</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.3/cfunits/units.py#L2326"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.equals" title="Permalink to this definition">¶</a></dt>
 <dd><p>Tests if units are numerically convertible to equal value.</p>
 <p>Returns True if and only if numeric values in one unit are
 convertible to numeric values in the other unit and their
@@ -191,7 +191,7 @@ <h1>cfunits.Units.equals<a class="headerlink" href="#cfunits-units-equals" title
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>

docs/generated/cfunits.Units.equivalent.html

@@ -36,7 +36,7 @@
 
 
 
-<h1 class="logo"><a href="../index.html">cfunits 3.3.2</a></h1>
+<h1 class="logo"><a href="../index.html">cfunits 3.3.3</a></h1>
 
 
 
@@ -123,7 +123,7 @@ <h3>Related Topics</h3>
 <h1>cfunits.Units.equivalent<a class="headerlink" href="#cfunits-units-equivalent" title="Permalink to this headline">¶</a></h1>
 <dl class="method">
 <dt id="cfunits.Units.equivalent">
-<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">equivalent</code><span class="sig-paren">(</span><em class="sig-param">other</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.2/cfunits/units.py#L1807"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.equivalent" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">Units.</code><code class="sig-name descname">equivalent</code><span class="sig-paren">(</span><em class="sig-param">other</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/NCAS-CMS/cfunits/blob/v3.3.3/cfunits/units.py#L1807"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#cfunits.Units.equivalent" title="Permalink to this definition">¶</a></dt>
 <dd><p>Tests whether two units are numerically convertible.</p>
 <p>Returns True if numeric values in one unit are convertible to
 numeric values in the other unit.</p>
@@ -185,7 +185,7 @@ <h1>cfunits.Units.equivalent<a class="headerlink" href="#cfunits-units-equivalen
     <div class="clearer"></div>
   </div>
     <div class="footer">
-      &copy;2021, NCAS | Page built on 2021-05-22.
+      &copy;2021, NCAS | Page built on 2021-05-24.
 
       |
       Powered by <a href="http://sphinx-doc.org/">Sphinx 2.3.1</a>