debug

nrc-cnrc · Oct 19, 2020 · 9f3f1e0 · 9f3f1e0
1 parent f1e7d16
commit 9f3f1e0
Show file tree

Hide file tree

Showing 32 changed files with 15,978 additions and 599 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -33,8 +33,10 @@ MetroloPy can do much more including Monte-Carlo uncertainty propagation, genera
 * [a tutorial](https://nrc-cnrc.github.io/MetroloPy/_build/html/_static/tutorial.html) (or  <a href="https://nrc-cnrc.github.io/MetroloPy/_build/html/_downloads/tutorial.ipynb" download> download the tutorial as Jupyter notebook</a>)
 * [the documentation](https://nrc-cnrc.github.io/MetroloPy/)
 * [the issues page on GitHub](https://github.com/nrc-cnrc/Metrolopy/issues)
+* [a list of the units built into MetroloPy](https://nrc-cnrc.github.io/MetroloPy/_static/units.html)
+* [a list of the physical constants built into MetroloPy](https://nrc-cnrc.github.io/MetroloPy/_static/constants.html)
 
-## New in version 0.6.0
+## new in version 0.6.0
 
 * A constant library has been added with physical constants that can be accessed
   by name or alias with the `constant` function.  The `search_constants` function 

diff --git a/dist/metrolopy-0.5.7-py3-none-any.whl b/dist/metrolopy-0.5.7-py3-none-any.whl
diff --git a/dist/metrolopy-0.5.7.tar.gz b/dist/metrolopy-0.5.7.tar.gz
diff --git a/dist/metrolopy-0.6.0-py3-none-any.whl b/dist/metrolopy-0.6.0-py3-none-any.whl
diff --git a/dist/metrolopy-0.6.0.tar.gz b/dist/metrolopy-0.6.0.tar.gz
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/hand_made_doc.doctree b/docs/_build/doctrees/hand_made_doc.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/metrolopy.doctree b/docs/_build/doctrees/metrolopy.doctree
diff --git a/docs/_build/html/_sources/hand_made_doc.rst.txt b/docs/_build/html/_sources/hand_made_doc.rst.txt
@@ -4,7 +4,11 @@ MetroloPy
 =========
 
 Most of the functionality in the MetroloPy package lies in the
-gummy_ object.
+gummy_ object which combines the functionality of the Unit_ and ``Quantity``
+classes for dealing with units, the ummy_ class for first order propagation
+of uncertainty, and the Distribution_ class for Monte Carlo propagation of
+uncertianty.  The ``immy`` and jummy_ classes support calculations with 
+complex numbers.
 
 .. _gummy:
 
@@ -1194,8 +1198,11 @@ class Distribution and sub-classes
 The ``Distribution`` class is the abstract base class for objects which
 represent the the probability distributions that the gummy Monte-Carlo
 samples are drawn from. Instances of these ``Distributions`` can used as
-the *x* parameter when creating gummys. The
-distributions below are built into the gummy package and custom
+the *x* parameter when creating gummys or can be used independantly as 
+mathematical operations between ``Distributions`` produce ``Convolutions``.
+See the auto-generated documentation for the ``Distribution`` methods and
+properties. 
+The distributions below are built into the gummy package and custom
 distributions can also be defined by the user.
 
 .. _arcsindist:
@@ -1547,8 +1554,11 @@ metrolopy.\ **trunc(x)**: x rounded towards zero
 class Unit
 ==========
 
-The gummy class uses ``Unit`` instances to represent physical units. A
-number of units are loaded with the gummy package. See the
+The gummy class uses ``Unit`` instances to represent physical units or units
+cns be multiplied or divided by other ``Unit`` instances to create composite
+units or multiply or divider numerical values to create ``Quantity`` instances.
+See the auto-generated documentation for the deatils of the ``Quantity`` class.
+A number of units are loaded with the gummy package. See the
 search_units_ function to get a list of all
 available units. Custom units can also be defined by creating instances
 of the ``Unit`` class or a sub-class. Though you
@@ -1560,7 +1570,6 @@ can be accessed using string names. E.g. we can define:
         >>> Unit('weird meter','wm',conversion=Conversion('m',0.9144),add_symbol=True)
         >>> gummy(3.3,unit='wm')
         3.3 wm
-        
 
 class metrolopy.\ **Unit(name, symbol, conversion=None,
 short_name=None, add_symbol=False,
@@ -1788,7 +1797,8 @@ class
 metrolopy.\ **jummy(real=None,imag=None,r=None,phi=None,cov=None,unit=one**
 
 A jummy object represents a complex valued quantity with gummy real and
-imaginary components.
+imaginary components.  See the ``immy`` class in the autogenerated docs for
+a class with ``ummy`` real and imaginary components.
 
 jummy parameters
 ----------------

diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
diff --git a/docs/_build/html/hand_made_doc.html b/docs/_build/html/hand_made_doc.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>MetroloPy &#8212; metrolopy 0.5.7 documentation</title>
+    <title>MetroloPy &#8212; metrolopy 0.6.0 documentation</title>
     <link rel="stylesheet" href="_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -24,7 +24,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.5.7 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.0 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -36,7 +36,11 @@ <h3>Navigation</h3>
   <div class="section" id="metrolopy">
 <span id="hand-made-doc"></span><h1>MetroloPy<a class="headerlink" href="#metrolopy" title="Permalink to this headline">¶</a></h1>
 <p>Most of the functionality in the MetroloPy package lies in the
-<a class="reference internal" href="#gummy">gummy</a> object.</p>
+<a class="reference internal" href="#gummy">gummy</a> object which combines the functionality of the <a href="#id2"><span class="problematic" id="id3">Unit_</span></a> and <code class="docutils literal notranslate"><span class="pre">Quantity</span></code>
+classes for dealing with units, the <a href="#id4"><span class="problematic" id="id5">ummy_</span></a> class for first order propagation
+of uncertainty, and the <a class="reference internal" href="#distribution">Distribution</a> class for Monte Carlo propagation of
+uncertianty.  The <code class="docutils literal notranslate"><span class="pre">immy</span></code> and <a class="reference internal" href="#jummy">jummy</a> classes support calculations with
+complex numbers.</p>
 </div>
 <div class="section" id="class-gummy">
 <span id="gummy"></span><h1>class gummy<a class="headerlink" href="#class-gummy" title="Permalink to this headline">¶</a></h1>
@@ -1104,8 +1108,11 @@ <h3>gummy display methods<a class="headerlink" href="#gummy-display-methods" tit
 <p>The <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> class is the abstract base class for objects which
 represent the the probability distributions that the gummy Monte-Carlo
 samples are drawn from. Instances of these <code class="docutils literal notranslate"><span class="pre">Distributions</span></code> can used as
-the <em>x</em> parameter when creating gummys. The
-distributions below are built into the gummy package and custom
+the <em>x</em> parameter when creating gummys or can be used independantly as
+mathematical operations between <code class="docutils literal notranslate"><span class="pre">Distributions</span></code> produce <code class="docutils literal notranslate"><span class="pre">Convolutions</span></code>.
+See the auto-generated documentation for the <code class="docutils literal notranslate"><span class="pre">Distribution</span></code> methods and
+properties.
+The distributions below are built into the gummy package and custom
 distributions can also be defined by the user.</p>
 <ul class="simple" id="arcsindist">
 <li><p>class metrolopy.<strong>ArcSinDist(center=None, half_width=None,
@@ -1369,8 +1376,11 @@ <h2>custom multi-variate distributions<a class="headerlink" href="#custom-multi-
 </div>
 <div class="section" id="class-unit">
 <span id="id1"></span><h1>class Unit<a class="headerlink" href="#class-unit" title="Permalink to this headline">¶</a></h1>
-<p>The gummy class uses <code class="docutils literal notranslate"><span class="pre">Unit</span></code> instances to represent physical units. A
-number of units are loaded with the gummy package. See the
+<p>The gummy class uses <code class="docutils literal notranslate"><span class="pre">Unit</span></code> instances to represent physical units or units
+cns be multiplied or divided by other <code class="docutils literal notranslate"><span class="pre">Unit</span></code> instances to create composite
+units or multiply or divider numerical values to create <code class="docutils literal notranslate"><span class="pre">Quantity</span></code> instances.
+See the auto-generated documentation for the deatils of the <code class="docutils literal notranslate"><span class="pre">Quantity</span></code> class.
+A number of units are loaded with the gummy package. See the
 <a class="reference internal" href="#search-units">search_units</a> function to get a list of all
 available units. Custom units can also be defined by creating instances
 of the <code class="docutils literal notranslate"><span class="pre">Unit</span></code> class or a sub-class. Though you
@@ -1591,7 +1601,8 @@ <h2>Unit sub-classes<a class="headerlink" href="#unit-sub-classes" title="Permal
 <p>class
 metrolopy.<strong>jummy(real=None,imag=None,r=None,phi=None,cov=None,unit=one</strong></p>
 <p>A jummy object represents a complex valued quantity with gummy real and
-imaginary components.</p>
+imaginary components.  See the <code class="docutils literal notranslate"><span class="pre">immy</span></code> class in the autogenerated docs for
+a class with <code class="docutils literal notranslate"><span class="pre">ummy</span></code> real and imaginary components.</p>
 <div class="section" id="jummy-parameters">
 <h2>jummy parameters<a class="headerlink" href="#jummy-parameters" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
@@ -2080,7 +2091,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.5.7 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.0 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -4,7 +4,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <meta charset="utf-8" />
-    <title>MetroloPy, the docs &#8212; metrolopy 0.5.7 documentation</title>
+    <title>MetroloPy, the docs &#8212; metrolopy 0.6.0 documentation</title>
     <link rel="stylesheet" href="_static/nature.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -24,7 +24,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">metrolopy 0.5.7 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">metrolopy 0.6.0 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -75,6 +75,7 @@ <h2>further reading<a class="headerlink" href="#further-reading" title="Permalin
 <li><p><a class="reference external" href="_static/tutorial.html">a tutorial</a> (or  <a class="reference download internal" download="" href="_downloads/0a570ba296e23260c7c01d8a2c75cc7e/tutorial.ipynb"><code class="xref download docutils literal notranslate"><span class="pre">download</span> <span class="pre">the</span> <span class="pre">tutorial</span> <span class="pre">as</span> <span class="pre">a</span> <span class="pre">Jupyter</span> <span class="pre">notebook</span></code></a>)</p></li>
 <li><p><a class="reference internal" href="hand_made_doc.html#hand-made-doc"><span class="std std-ref">the API documentation</span></a> (see the auto-generated docs below for an alternative set of documentation)</p></li>
 <li><p><a class="reference external" href="_static/units.html">a list of the measurement units built into MetroloPy</a></p></li>
+<li><p><a class="reference external" href="_static/constants.html">a list of the physical constants built into MetroloPy</a></p></li>
 <li><p><a class="reference internal" href="todo.html#todo"><span class="std std-ref">package development and to do</span></a></p></li>
 <li><p><a class="reference external" href="https://github.com/nrc-cnrc/Metrolopy/issues">the issues page on GitHub</a></p></li>
 <li><p><a class="reference external" href="https://github.com/nrc-cnrc/Metrolopy/">the source code on GitHub</a></p></li>
@@ -124,6 +125,8 @@ <h2>version history<a class="headerlink" href="#version-history" title="Permalin
 <li><p>Version 0.5.5, built 7 May 2020, minor bug fixes.</p></li>
 <li><p>Version 0.5.6, built 24 September 2020, minor bug fixes.</p></li>
 <li><p>Version 0.5.7, built 26 September 2020, minor change to setup.py.</p></li>
+<li><p>Verison 0.6.0, built xx October 2020, added the <cite>Quantity</cite> and <cite>immy</cite> classes
+as well as a library of physical constants.</p></li>
 </ul>
 </div>
 <div class="section" id="author">
@@ -192,7 +195,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">metrolopy 0.5.7 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">metrolopy 0.6.0 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">