Skip to content

wattsworth / puppet

Go to a project
Commit 87602c38 by John Donnal
Options

auto doc rebuild

parent d101dbd3
Expand all
Inline Side-by-side
Showing with 225 additions and 61 deletions
modules/docs/files/docs/joule/_sources/index.rst.txt
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Joule: Modular Data Processing Joule: Modular Data Processing
================================= =================================
...@@ -21,23 +21,22 @@ bugs and find bottlenecks in processing pipelines. ...@@ -21,23 +21,22 @@ bugs and find bottlenecks in processing pipelines.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
concepts concepts
install
getting_started getting_started
writing_modules writing_modules
testing_modules testing_modules
nilm nilmdb
reference reference
Contributing & Running Tests Contributing & Running Tests
---------------------------- ----------------------------
Contribution is always welcome. Please include tests with your pull request. Contribution is always welcome. Please include tests with your pull request.
Unittests can be run using nose2, see **joule/htmlcov** for code coverage. Unittests can be run using nose2, see **joule/htmlcov** for code coverage.
.. code-block:: bash .. code-block:: bash
$> cd joule $> cd joule
$> nose2 # run all unittests $> nose2 # run all unittests
...@@ -47,8 +46,8 @@ https://docs.docker.com/compose/install/ for details on installing ...@@ -47,8 +46,8 @@ https://docs.docker.com/compose/install/ for details on installing
docker-compose. The NilmDB container is available by request on `Docker Hub`_. docker-compose. The NilmDB container is available by request on `Docker Hub`_.
.. code-block:: bash .. code-block:: bash
$> cd test/e2e $> cd test/e2e
$> ./runner.sh # run end-to-end tests $> ./runner.sh # run end-to-end tests
.. _Docker Hub: https://hub.docker.com/ .. _Docker Hub: https://hub.docker.com/
modules/docs/files/docs/joule/_sources/install.rst.txt
...@@ -141,6 +141,14 @@ Download and Install Source ...@@ -141,6 +141,14 @@ Download and Install Source
This will install python3.5 into **/usr/local/bin** This will install python3.5 into **/usr/local/bin**
Install matplotlib, numpy and scipy. These must be built from source so you need to
get the dependencies before running pip. Edit ``/etc/apt/sources.list`` to include a
source entry like ``deb-src``. Then run the following commands:
.. code-block:: bash
$> sudo apt-get build-dep python3-scipy python3-numpy python3-matplotlib
$> sudo pip3 install numpy matplotlib scipy
VirtualEnv VirtualEnv
^^^^^^^^^^ ^^^^^^^^^^
......
modules/docs/files/docs/joule/_static/css/custom.css 0 → 100644
.command-title {
background: #DDD;
padding: 8px;
border-radius: 4px;
margin-top: 40px;
border-top: black;
border-style: solid;
border-width: 1px
}
.command-title>i {
font-style: normal;
font-weight: bold;
font-family: monospace;
}
.text-mono {
font-family: monospace;
}
.block-indent {
margin-left: 20px;
}
.text-grey {
color: #808080;
}
.arglist>dd {
margin: 0px;
margin-left: 30px;
}
.arglist>dt {
color: #808080;
font-weight: normal;
font-family: monospace;
}
.arglist {
margin-top: 0px;
margin-bottom: 0px;
}
.plainlist {
margin-bottom: 0px;
}
.plainlist>dd {
margin-left: 30px;
}
.plainlist>dt {
font-weight: normal;
font-family: monospace;
}
.plug-cli {
font-family: monospace;
background: #DDD;
display: block;
margin: 5px;
padding: 5px;
border-radius: 4px;
border-style: solid;
border-width: 1px;
border-color: #BBB
}
.mono-dl>dt {
font-family: monospace;
}
.arglist.dl-horizontal>dt {
width: inherit;
}
.arglist.dl-horizontal>dd {
margin-left: 130px;
}
.command {
font-family: monospace;
color: #808080
}
.command>em {
font-weight: bold;
font-style: normal;
color: black;
}
modules/docs/files/docs/joule/concepts.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -157,7 +158,7 @@ with a consume module. See reference section for details on the pipe API.</p> ...@@ -157,7 +158,7 @@ with a consume module. See reference section for details on the pipe API.</p>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
modules/docs/files/docs/joule/genindex.html
...@@ -11,6 +11,7 @@ ...@@ -11,6 +11,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -72,11 +73,10 @@ ...@@ -72,11 +73,10 @@
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li> <li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
modules/docs/files/docs/joule/getting_started.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -247,7 +248,7 @@ $&gt; nilmtool list -E -n /demo/* ...@@ -247,7 +248,7 @@ $&gt; nilmtool list -E -n /demo/*
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
modules/docs/files/docs/joule/index.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -62,13 +63,6 @@ bugs and find bottlenecks in processing pipelines.</p> ...@@ -62,13 +63,6 @@ bugs and find bottlenecks in processing pipelines.</p>
<li class="toctree-l2"><a class="reference internal" href="concepts.html#pipes">Pipes</a></li> <li class="toctree-l2"><a class="reference internal" href="concepts.html#pipes">Pipes</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#install-nilmdb">Install NilmDb</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#install-python-3-5">Install Python 3.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#install-joule">Install Joule</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#verify-installation">Verify Installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#a-reader-module">A Reader Module</a></li> <li class="toctree-l2"><a class="reference internal" href="getting_started.html#a-reader-module">A Reader Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#a-filter-module">A Filter Module</a></li> <li class="toctree-l2"><a class="reference internal" href="getting_started.html#a-filter-module">A Filter Module</a></li>
...@@ -80,21 +74,66 @@ bugs and find bottlenecks in processing pipelines.</p> ...@@ -80,21 +74,66 @@ bugs and find bottlenecks in processing pipelines.</p>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a><ul> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing_modules.html#unit-testing">Unit Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="testing_modules.html#unit-testing">Unit Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="testing_modules.html#end-to-end-testing">End-to-End Testing</a></li> <li class="toctree-l3"><a class="reference internal" href="testing_modules.html#readermodules">ReaderModules</a></li>
<li class="toctree-l3"><a class="reference internal" href="testing_modules.html#filtermodules">FilterModules</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="testing_modules.html#end-to-end-testing">End-to-End Testing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="testing_modules.html#configuration-files">Configuration Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="testing_modules.html#test-py">test.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilmtool"><code class="docutils literal"><span class="pre">nilmtool</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-help"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">help</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-info"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">info</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-create"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">create</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-rename"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">rename</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-list"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">list</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-intervals"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">intervals</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-metadata"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">metadata</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-insert"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">insert</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-extract"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">extract</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-remove"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">remove</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="nilmdb.html#nilmtool-destroy"><code class="docutils literal"><span class="pre">nilmtool</span> <span class="pre">destroy</span></code></a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a><ul> <li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-copy"><code class="docutils literal"><span class="pre">nilm-copy</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilm.html#installation">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-copy-wildcard"><code class="docutils literal"><span class="pre">nilm-copy-wildcard</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilm.html#configuration">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-decimate"><code class="docutils literal"><span class="pre">nilm-decimate</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilm.html#verify-operation">Verify Operation</a></li> <li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-decimate-auto"><code class="docutils literal"><span class="pre">nilm-decimate-auto</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-insert"><code class="docutils literal"><span class="pre">nilm-insert</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilmdb-server"><code class="docutils literal"><span class="pre">nilmdb-server</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilmdb-fsck"><code class="docutils literal"><span class="pre">nilmdb-fsck</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="nilmdb.html#nilm-cleanup"><code class="docutils literal"><span class="pre">nilm-cleanup</span></code></a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a><ul> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#command-line-utilities">Command Line Utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="reference.html#command-line-utilities">Command Line Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#configuration-files">Configuration Files</a></li> <li class="toctree-l3"><a class="reference internal" href="reference.html#joule">joule</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#numpy-pipes">Numpy Pipes</a></li> <li class="toctree-l3"><a class="reference internal" href="reference.html#jouled">jouled</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#e2e-utilities">E2E Utilities</a></li> <li class="toctree-l3"><a class="reference internal" href="reference.html#nilmtool">nilmtool</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#configuration-files">Configuration Files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference.html#main-conf">main.conf</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference.html#stream-configs">stream configs</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference.html#module-configs">module configs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#numpy-pipes">Numpy Pipes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference.html#concepts">Concepts</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference.html#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#e2e-utilities">E2E Utilities</a><ul>
<li class="toctree-l3"><a class="reference internal" href="reference.html#id3">joule</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference.html#id4">nilmtool</a></li>
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -141,11 +180,10 @@ $&gt; ./runner.sh <span class="c1"># run end-to-end tests</span> ...@@ -141,11 +180,10 @@ $&gt; ./runner.sh <span class="c1"># run end-to-end tests</span>
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li> <li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
modules/docs/files/docs/joule/install.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -26,8 +27,6 @@ ...@@ -26,8 +27,6 @@
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="Getting Started" href="getting_started.html" />
<link rel="prev" title="Joule Concepts" href="concepts.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" />
...@@ -146,6 +145,13 @@ $&gt; sudo make install ...@@ -146,6 +145,13 @@ $&gt; sudo make install
</pre></div> </pre></div>
</div> </div>
<p>This will install python3.5 into <strong>/usr/local/bin</strong></p> <p>This will install python3.5 into <strong>/usr/local/bin</strong></p>
<p>Install matplotlib, numpy and scipy. These must be built from source so you need to
get the dependencies before running pip. Edit <code class="docutils literal"><span class="pre">/etc/apt/sources.list</span></code> to include a
source entry like <code class="docutils literal"><span class="pre">deb-src</span></code>. Then run the following commands:</p>
<div class="highlight-bash"><div class="highlight"><pre><span></span>$&gt; sudo apt-get build-dep python3-scipy python3-numpy python3-matplotlib
$&gt; sudo pip3 install numpy matplotlib scipy
</pre></div>
</div>
<div class="section" id="virtualenv"> <div class="section" id="virtualenv">
<h3>VirtualEnv<a class="headerlink" href="#virtualenv" title="Permalink to this headline"></a></h3> <h3>VirtualEnv<a class="headerlink" href="#virtualenv" title="Permalink to this headline"></a></h3>
<p>You may optionally install Joule into a virtual environment, this is <p>You may optionally install Joule into a virtual environment, this is
...@@ -283,19 +289,12 @@ the python3.5 binaries in <strong>/usr/local/bin/</strong></td></tr> ...@@ -283,19 +289,12 @@ the python3.5 binaries in <strong>/usr/local/bin/</strong></td></tr>
<h3>Navigation</h3> <h3>Navigation</h3>
<ul class="current"> <ul>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li> <li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#install-nilmdb">Install NilmDb</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-python-3-5">Install Python 3.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-joule">Install Joule</a></li>
<li class="toctree-l2"><a class="reference internal" href="#verify-installation">Verify Installation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
...@@ -303,8 +302,6 @@ the python3.5 binaries in <strong>/usr/local/bin/</strong></td></tr> ...@@ -303,8 +302,6 @@ the python3.5 binaries in <strong>/usr/local/bin/</strong></td></tr>
<h3>Related Topics</h3> <h3>Related Topics</h3>
<ul> <ul>
<li><a href="index.html">Documentation overview</a><ul> <li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="concepts.html" title="previous chapter">Joule Concepts</a></li>
<li>Next: <a href="getting_started.html" title="next chapter">Getting Started</a></li>
</ul></li> </ul></li>
</ul> </ul>
</div> </div>
......
modules/docs/files/docs/joule/reference.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -26,7 +27,7 @@ ...@@ -26,7 +27,7 @@
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="prev" title="NILM Modules" href="nilm.html" /> <link rel="prev" title="Database Reference" href="nilmdb.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" />
...@@ -218,12 +219,30 @@ full set of options and their default settings:</p> ...@@ -218,12 +219,30 @@ full set of options and their default settings:</p>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Reference</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#command-line-utilities">Command Line Utilities</a></li> <li class="toctree-l2"><a class="reference internal" href="#command-line-utilities">Command Line Utilities</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-files">Configuration Files</a></li> <li class="toctree-l3"><a class="reference internal" href="#joule">joule</a></li>
<li class="toctree-l2"><a class="reference internal" href="#numpy-pipes">Numpy Pipes</a></li> <li class="toctree-l3"><a class="reference internal" href="#jouled">jouled</a></li>
<li class="toctree-l2"><a class="reference internal" href="#e2e-utilities">E2E Utilities</a></li> <li class="toctree-l3"><a class="reference internal" href="#nilmtool">nilmtool</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#configuration-files">Configuration Files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#main-conf">main.conf</a></li>
<li class="toctree-l3"><a class="reference internal" href="#stream-configs">stream configs</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-configs">module configs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#numpy-pipes">Numpy Pipes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#concepts">Concepts</a></li>
<li class="toctree-l3"><a class="reference internal" href="#methods">Methods</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#e2e-utilities">E2E Utilities</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#id3">joule</a></li>
<li class="toctree-l3"><a class="reference internal" href="#id4">nilmtool</a></li>
</ul>
</li>
</ul> </ul>
</li> </li>
</ul> </ul>
...@@ -232,7 +251,7 @@ full set of options and their default settings:</p> ...@@ -232,7 +251,7 @@ full set of options and their default settings:</p>
<h3>Related Topics</h3> <h3>Related Topics</h3>
<ul> <ul>
<li><a href="index.html">Documentation overview</a><ul> <li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="nilm.html" title="previous chapter">NILM Modules</a></li> <li>Previous: <a href="nilmdb.html" title="previous chapter">Database Reference</a></li>
</ul></li> </ul></li>
</ul> </ul>
</div> </div>
......
modules/docs/files/docs/joule/search.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -95,11 +96,10 @@ ...@@ -95,11 +96,10 @@
<h3>Navigation</h3> <h3>Navigation</h3>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li> <li class="toctree-l1"><a class="reference internal" href="concepts.html">Joule Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
modules/docs/files/docs/joule/testing_modules.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -26,7 +27,7 @@ ...@@ -26,7 +27,7 @@
<script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" /> <link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" /> <link rel="search" title="Search" href="search.html" />
<link rel="next" title="NILM Modules" href="nilm.html" /> <link rel="next" title="Database Reference" href="nilmdb.html" />
<link rel="prev" title="Writing Modules" href="writing_modules.html" /> <link rel="prev" title="Writing Modules" href="writing_modules.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" />
...@@ -481,11 +482,19 @@ and the e2eutils reference for details on the testing API.</p> ...@@ -481,11 +482,19 @@ and the e2eutils reference for details on the testing API.</p>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="writing_modules.html">Writing Modules</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Testing Modules</a><ul> <li class="toctree-l1 current"><a class="current reference internal" href="#">Testing Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#unit-testing">Unit Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="#unit-testing">Unit Testing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#end-to-end-testing">End-to-End Testing</a></li> <li class="toctree-l3"><a class="reference internal" href="#readermodules">ReaderModules</a></li>
<li class="toctree-l3"><a class="reference internal" href="#filtermodules">FilterModules</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l2"><a class="reference internal" href="#end-to-end-testing">End-to-End Testing</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#configuration-files">Configuration Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="#test-py">test.py</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
...@@ -494,7 +503,7 @@ and the e2eutils reference for details on the testing API.</p> ...@@ -494,7 +503,7 @@ and the e2eutils reference for details on the testing API.</p>
<ul> <ul>
<li><a href="index.html">Documentation overview</a><ul> <li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="writing_modules.html" title="previous chapter">Writing Modules</a></li> <li>Previous: <a href="writing_modules.html" title="previous chapter">Writing Modules</a></li>
<li>Next: <a href="nilm.html" title="next chapter">NILM Modules</a></li> <li>Next: <a href="nilmdb.html" title="next chapter">Database Reference</a></li>
</ul></li> </ul></li>
</ul> </ul>
</div> </div>
......
modules/docs/files/docs/joule/writing_modules.html
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" /> <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
...@@ -277,7 +278,7 @@ modules in isolation. An example is provided in <strong>test_filter.py</strong>. ...@@ -277,7 +278,7 @@ modules in isolation. An example is provided in <strong>test_filter.py</strong>.
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="testing_modules.html">Testing Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="nilm.html">NILM Modules</a></li> <li class="toctree-l1"><a class="reference internal" href="nilmdb.html">Database Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="reference.html">Reference</a></li>
</ul> </ul>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment