Updating docs version.

InsectRobotics · Nov 9, 2018 · b15d00b · b15d00b
1 parent dfdf36d
commit b15d00b
Show file tree

Hide file tree

Showing 23 changed files with 41 additions and 54 deletions.
diff --git a/docs/_build/doctrees/description.doctree b/docs/_build/doctrees/description.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/pompy.demos.doctree b/docs/_build/doctrees/pompy.demos.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: a8008e02265a8998aa1715dbb14c6cd6
+config: e3bb83f45bc2bdb35624c3b5878a321c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_modules/index.html b/docs/_build/html/_modules/index.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Overview: module code &#8212; pompy 0.1.0 documentation</title>
+    <title>Overview: module code &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="../_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
 
@@ -28,7 +28,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -73,7 +73,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/_modules/pompy/demos.html b/docs/_build/html/_modules/pompy/demos.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.demos &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.demos &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="../../_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
@@ -28,7 +28,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -396,7 +396,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/_build/html/_modules/pompy/models.html b/docs/_build/html/_modules/pompy/models.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.models &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.models &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="../../_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
@@ -28,7 +28,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -669,7 +669,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/_build/html/_modules/pompy/processors.html b/docs/_build/html/_modules/pompy/processors.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.processors &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.processors &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="../../_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
 
@@ -28,7 +28,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  
@@ -396,7 +396,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">pompy 0.1.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../index.html">pompy 0.1.1 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li> 
       </ul>
     </div>

diff --git a/docs/_build/html/_sources/description.rst.txt b/docs/_build/html/_sources/description.rst.txt
@@ -6,9 +6,6 @@ PomPy is a NumPy based implementation of the puff-based odour plume model descri
     `Index page (springer.com) <https://link.springer.com/article/10.1023/A:1016283702837>`_ \:\:
     `PDF (semanticscholar.org) <https://pdfs.semanticscholar.org/7197/d905b0d6e8cd490f78a893fc266af9a4d901.pdf>`_
 
-What is PomPy for?
---------------------
-
 PomPy allows simulation of dynamic 2D odour concentration fields which show some
 of the key characteristics of real chemical plumes in turbulent flows including short
 term intermittency, diffusive effects and longer term variations in spatial extent and

diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.1.0',
+    VERSION: '0.1.1',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

diff --git a/docs/_build/html/description.html b/docs/_build/html/description.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>What is PomPy for? &#8212; pompy 0.1.0 documentation</title>
+    <title>&lt;no title&gt; &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -28,7 +28,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -44,13 +44,10 @@ <h3>Navigation</h3>
 structure of odor plumes. <em>Environmental fluid mechanics</em>, 2(1-2), pp.143-169.
 <a class="reference external" href="https://link.springer.com/article/10.1023/A:1016283702837">Index page (springer.com)</a> ::
 <a class="reference external" href="https://pdfs.semanticscholar.org/7197/d905b0d6e8cd490f78a893fc266af9a4d901.pdf">PDF (semanticscholar.org)</a></div></blockquote>
-<div class="section" id="what-is-pompy-for">
-<h1>What is PomPy for?<a class="headerlink" href="#what-is-pompy-for" title="Permalink to this headline">¶</a></h1>
 <p>PomPy allows simulation of dynamic 2D odour concentration fields which show some
 of the key characteristics of real chemical plumes in turbulent flows including short
 term intermittency, diffusive effects and longer term variations in spatial extent and
 location, while being cheaper to run than a full fluid dynamics simulation.</p>
-</div>
 
 
           </div>
@@ -90,7 +87,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -7,7 +7,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Index &#8212; pompy 0.1.0 documentation</title>
+    <title>Index &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -29,7 +29,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -263,7 +263,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 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
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>PomPy - puff-based odour plume model in Python &#8212; pompy 0.1.0 documentation</title>
+    <title>PomPy - puff-based odour plume model in Python &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.models.html" title="pompy.models module"
              accesskey="N">next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -50,15 +50,12 @@ <h1>PomPy - puff-based odour plume model in Python<a class="headerlink" href="#p
 structure of odor plumes. <em>Environmental fluid mechanics</em>, 2(1-2), pp.143-169.
 <a class="reference external" href="https://link.springer.com/article/10.1023/A:1016283702837">Index page (springer.com)</a> ::
 <a class="reference external" href="https://pdfs.semanticscholar.org/7197/d905b0d6e8cd490f78a893fc266af9a4d901.pdf">PDF (semanticscholar.org)</a></div></blockquote>
-<div class="section" id="what-is-pompy-for">
-<h2>What is PomPy for?<a class="headerlink" href="#what-is-pompy-for" title="Permalink to this headline">¶</a></h2>
 <p>PomPy allows simulation of dynamic 2D odour concentration fields which show some
 of the key characteristics of real chemical plumes in turbulent flows including short
 term intermittency, diffusive effects and longer term variations in spatial extent and
 location, while being cheaper to run than a full fluid dynamics simulation.</p>
 <p>An example simulated concentration field generated by the package is shown below</p>
 <img alt="Plume model animation" class="align-center" src="_images/plume.gif" />
-</div>
 <div class="section" id="api-documentation">
 <h2>API documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h2>
 <div class="toctree-wrapper compound">
@@ -80,7 +77,6 @@ <h2>API documentation<a class="headerlink" href="#api-documentation" title="Perm
   <h3><a href="#">Table of Contents</a></h3>
   <ul>
 <li><a class="reference internal" href="#">PomPy - puff-based odour plume model in Python</a><ul>
-<li><a class="reference internal" href="#what-is-pompy-for">What is PomPy for?</a></li>
 <li><a class="reference internal" href="#api-documentation">API documentation</a></li>
 </ul>
 </li>
@@ -124,7 +120,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.models.html" title="pompy.models module"
              >next</a> |</li>
-        <li class="nav-item nav-item-0"><a href="#">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="#">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/pompy.demos.html b/docs/_build/html/pompy.demos.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.demos module &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.demos module &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -32,7 +32,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.processors.html" title="pompy.processors module"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -238,7 +238,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.processors.html" title="pompy.processors module"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/pompy.models.html b/docs/_build/html/pompy.models.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.models module &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.models module &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="PomPy - puff-based odour plume model in Python"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -491,7 +491,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="index.html" title="PomPy - puff-based odour plume model in Python"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/pompy.processors.html b/docs/_build/html/pompy.processors.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>pompy.processors module &#8212; pompy 0.1.0 documentation</title>
+    <title>pompy.processors module &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.models.html" title="pompy.models module"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -308,7 +308,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="pompy.models.html" title="pompy.models module"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Python Module Index &#8212; pompy 0.1.0 documentation</title>
+    <title>Python Module Index &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -105,7 +105,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="#" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
@@ -6,7 +6,7 @@
   <head>
     <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Search &#8212; pompy 0.1.0 documentation</title>
+    <title>Search &#8212; pompy 0.1.1 documentation</title>
     <link rel="stylesheet" href="_static/classic.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -37,7 +37,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -88,7 +88,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">pompy 0.1.0 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="index.html">pompy 0.1.1 documentation</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">