docs updated

santoshphilip · Sep 4, 2016 · 331f3cc · 331f3cc
1 parent 6babd49
commit 331f3cc
Show file tree

Hide file tree

Showing 44 changed files with 1,395 additions and 1,031 deletions.
diff --git a/docs/generated/.buildinfo b/docs/generated/.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: 785c3ecfc971412d1152b35265c09757
+config: d223d8725870b3717436adab002b3c62
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/generated/HVAC_Tutorial.html b/docs/generated/HVAC_Tutorial.html
@@ -8,7 +8,7 @@
 
     <title>HVAC Loops &mdash; eppy 0.5.31 documentation</title>
 
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
@@ -27,27 +27,30 @@
     <link rel="next" title="Reading outputs from E+" href="Outputs_Tutorial.html" />
     <link rel="prev" title="Eppy Tutorial" href="Main_Tutorial.html" /> 
   </head>
-  <body role="document">
-    <div class="related" role="navigation" aria-label="related navigation">
+  <body>
+    <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li class="right" >
           <a href="Outputs_Tutorial.html" title="Reading outputs from E+"
              accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="Main_Tutorial.html" title="Eppy Tutorial"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
+        <li><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          <div class="body" role="main">
+          <div class="body">
 
   <div class="section" id="hvac-loops">
 <h1>HVAC Loops<a class="headerlink" href="#hvac-loops" title="Permalink to this headline">¶</a></h1>
@@ -95,7 +98,7 @@ <h2>Conceptual Introduction to HVAC Loops<a class="headerlink" href="#conceptual
 <p>The two ends of the supply side connect to the two ends of the demand
 side.</p>
 <p>Diagramtically the the two sides of the loop will look like this:</p>
-<div class="highlight-python"><div class="highlight"><pre>Supply Side:
+<div class="highlight-python"><pre>Supply Side:
 ------------
                 -&gt; branch1 -&gt;
 start_branch   --&gt; branch2 --&gt; end_branch
@@ -105,8 +108,7 @@ <h2>Conceptual Introduction to HVAC Loops<a class="headerlink" href="#conceptual
 
                   -&gt; d_branch1 -&gt;
 d_start_branch   --&gt; d_branch2 --&gt; d_end_branch
-                  -&gt; d_branch3 -&gt;
-</pre></div>
+                  -&gt; d_branch3 -&gt;</pre>
 </div>
 <p>In eppy you could embody this is a list</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="n">supplyside</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;start_brandh&#39;</span><span class="p">,</span>   <span class="p">[</span>  <span class="s">&#39;branch1&#39;</span><span class="p">,</span>   <span class="s">&#39;branch2&#39;</span><span class="p">,</span>   <span class="s">&#39;branch3&#39;</span><span class="p">],</span>   <span class="s">&#39;end_branch&#39;</span><span class="p">]</span>
@@ -116,15 +118,13 @@ <h2>Conceptual Introduction to HVAC Loops<a class="headerlink" href="#conceptual
 <p>Eppy will build the build the shape/topology of the loop using the two
 lists above. Each branch will have a placeholder component, like a pipe
 or a duct:</p>
-<div class="highlight-python"><div class="highlight"><pre>branch1 = --duct--
-</pre></div>
+<div class="highlight-python"><pre>branch1 = --duct--</pre>
 </div>
 <p>Now we will have to replace the placeholder with the real components
 that make up the loop. For instance, branch1 should really have a
 pre-heat coil leading to a supply fan leading to a cooling coil leading
 to a heating coil:</p>
-<div class="highlight-python"><div class="highlight"><pre>new_branch = pre-heatcoil -&gt; supplyfan -&gt; coolingcoil -&gt; heatingcoil
-</pre></div>
+<div class="highlight-python"><pre>new_branch = pre-heatcoil -&gt; supplyfan -&gt; coolingcoil -&gt; heatingcoil</pre>
 </div>
 <p>Eppy lets you build a new branch and you can replace branch1 with
 new_branch</p>
@@ -221,7 +221,7 @@ <h3>Modifying the topology of the loop<a class="headerlink" href="#modifying-the
 of <strong>listofcomponents</strong></p>
 <ul class="simple">
 <li>We will do this by calling the function replacebranch</li>
-<li>Calling replacebranch can throw an exception <code class="docutils literal"><span class="pre">WhichLoopError</span></code></li>
+<li>Calling replacebranch can throw an exception <tt class="docutils literal"><span class="pre">WhichLoopError</span></tt></li>
 <li>In a moment, you will see why this exception is important</li>
 </ul>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="k">try</span><span class="p">:</span>
@@ -230,13 +230,12 @@ <h3>Modifying the topology of the loop<a class="headerlink" href="#modifying-the
     <span class="k">print</span> <span class="n">e</span>
 </pre></div>
 </div>
-<div class="highlight-python"><div class="highlight"><pre>Where should this loop connect ?
+<div class="highlight-python"><pre>Where should this loop connect ?
 CHILLER:ELECTRIC - Central_Chiller
-[u&#39;Chilled_Water_&#39;, u&#39;Condenser_&#39;, u&#39;Heat_Recovery_&#39;]
-</pre></div>
+[u'Chilled_Water_', u'Condenser_', u'Heat_Recovery_']</pre>
 </div>
 <p>The above code throws the exception. It says that the idfobject
-<code class="docutils literal"><span class="pre">CHILLER:ELECTRIC</span> <span class="pre">-</span> <span class="pre">Central_Chiller</span></code> has three possible connections.
+<tt class="docutils literal"><span class="pre">CHILLER:ELECTRIC</span> <span class="pre">-</span> <span class="pre">Central_Chiller</span></tt> has three possible connections.
 The chiller has inlet outlet nodes for the following</p>
 <ul class="simple">
 <li>Chilled water</li>
@@ -245,7 +244,7 @@ <h3>Modifying the topology of the loop<a class="headerlink" href="#modifying-the
 </ul>
 <p>eppy does not know which one to connect to, and it needs your help. We
 know that the chiller needs to be connected to the chilled water inlet
-and outlet. Simply copy <code class="docutils literal"><span class="pre">Chilled_Water_</span></code> from the text in the
+and outlet. Simply copy <tt class="docutils literal"><span class="pre">Chilled_Water_</span></tt> from the text in the
 exception and paste as shown in the code below. (make sure you copy it
 exactly. eppy is a little nerdy about that)</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="c"># instead of passing chiller to the function, we pass a tuple (chiller, &#39;Chilled_Water_&#39;).</span>
@@ -263,10 +262,9 @@ <h3>Modifying the topology of the loop<a class="headerlink" href="#modifying-the
 <span class="n">idf</span><span class="o">.</span><span class="n">saveas</span><span class="p">(</span><span class="s">&quot;hhh_new.idf&quot;</span><span class="p">)</span>
 </pre></div>
 </div>
-<div class="highlight-python"><div class="highlight"><pre>no exception was thrown
-</pre></div>
+<div class="highlight-python"><pre>no exception was thrown</pre>
 </div>
-<p><em>Tagential note</em>: The <code class="docutils literal"><span class="pre">&quot;try</span> <span class="pre">..</span> <span class="pre">except</span> <span class="pre">..</span> <span class="pre">else&quot;</span></code> statement is useful
+<p><em>Tagential note</em>: The <tt class="docutils literal"><span class="pre">&quot;try</span> <span class="pre">..</span> <span class="pre">except</span> <span class="pre">..</span> <span class="pre">else&quot;</span></tt> statement is useful
 here. If you have not run across it before, take a look at these two
 links</p>
 <ul class="simple">
@@ -286,9 +284,9 @@ <h3>Modifying the topology of the loop<a class="headerlink" href="#modifying-the
 <img alt="_images/HVAC_Tutorial_34_0.png" src="_images/HVAC_Tutorial_34_0.png" />
 <p>This diagram shows the new components in the branch</p>
 <div class="section" id="work-flow-with-whichlooperror">
-<h4>Work flow with <code class="docutils literal"><span class="pre">WhichLoopError</span></code><a class="headerlink" href="#work-flow-with-whichlooperror" title="Permalink to this headline">¶</a></h4>
-<p>When you are writing scripts don&#8217;t bother to use <code class="docutils literal"><span class="pre">try</span> <span class="pre">..</span> <span class="pre">except</span></code> for
-<code class="docutils literal"><span class="pre">WhichLoopError</span></code>.</p>
+<h4>Work flow with <tt class="docutils literal"><span class="pre">WhichLoopError</span></tt><a class="headerlink" href="#work-flow-with-whichlooperror" title="Permalink to this headline">¶</a></h4>
+<p>When you are writing scripts don&#8217;t bother to use <tt class="docutils literal"><span class="pre">try</span> <span class="pre">..</span> <span class="pre">except</span></tt> for
+<tt class="docutils literal"><span class="pre">WhichLoopError</span></tt>.</p>
 <ul class="simple">
 <li>Simply allow the exception to be raised.</li>
 <li>Use the information in the exception to update your code</li>
@@ -470,7 +468,7 @@ <h2>Building an Air Loop<a class="headerlink" href="#building-an-air-loop" title
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
   <h3><a href="index.html">Table Of Contents</a></h3>
   <ul>
@@ -480,7 +478,7 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#building-the-topology-of-the-loop">Building the topology of the loop</a></li>
 <li><a class="reference internal" href="#diagram-of-the-loop">Diagram of the loop</a></li>
 <li><a class="reference internal" href="#modifying-the-topology-of-the-loop">Modifying the topology of the loop</a><ul>
-<li><a class="reference internal" href="#work-flow-with-whichlooperror">Work flow with <code class="docutils literal"><span class="pre">WhichLoopError</span></code></a></li>
+<li><a class="reference internal" href="#work-flow-with-whichlooperror">Work flow with <tt class="docutils literal"><span class="pre">WhichLoopError</span></tt></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#traversing-the-loop">Traversing the loop</a></li>
@@ -498,14 +496,12 @@ <h4>Previous topic</h4>
   <h4>Next topic</h4>
   <p class="topless"><a href="Outputs_Tutorial.html"
                         title="next chapter">Reading outputs from E+</a></p>
-  <div role="note" aria-label="source link">
-    <h3>This Page</h3>
-    <ul class="this-page-menu">
-      <li><a href="_sources/HVAC_Tutorial.txt"
-            rel="nofollow">Show Source</a></li>
-    </ul>
-   </div>
-<div id="searchbox" style="display: none" role="search">
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/HVAC_Tutorial.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
   <h3>Quick search</h3>
     <form class="search" action="search.html" method="get">
       <input type="text" name="q" />
@@ -522,24 +518,27 @@ <h3>Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li class="right" >
           <a href="Outputs_Tutorial.html" title="Reading outputs from E+"
              >next</a> |</li>
         <li class="right" >
           <a href="Main_Tutorial.html" title="Eppy Tutorial"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
+        <li><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
       </ul>
     </div>
-    <div class="footer" role="contentinfo">
+    <div class="footer">
         &copy; Copyright 2013, Santosh Philip.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b2.
     </div>
   </body>
 </html>
diff --git a/docs/generated/HVAC_diagrams.html b/docs/generated/HVAC_diagrams.html
@@ -8,7 +8,7 @@
 
     <title>&lt;no title&gt; &mdash; eppy 0.5.31 documentation</title>
 
-    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
     <script type="text/javascript">
@@ -25,21 +25,24 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="top" title="eppy 0.5.31 documentation" href="index.html" /> 
   </head>
-  <body role="document">
-    <div class="related" role="navigation" aria-label="related navigation">
+  <body>
+    <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          <div class="body" role="main">
+          <div class="body">
 
   <div class="code python highlight-python"><div class="highlight"><pre><span class="sd">&quot;&quot;&quot;HVAC diagrams&quot;&quot;&quot;</span>
 </pre></div>
@@ -91,10 +94,9 @@ <h3>Navigation</h3>
 <span class="n">g</span><span class="o">.</span><span class="n">write_png</span><span class="p">(</span><span class="n">pngname</span><span class="p">)</span>
 </pre></div>
 </div>
-<div class="highlight-python"><div class="highlight"><pre>readingfile
+<div class="highlight-python"><pre>readingfile
 constructing the loops
-making the diagram
-</pre></div>
+making the diagram</pre>
 </div>
 <div class="highlight-python"><div class="highlight"><pre><span class="bp">True</span>
 </pre></div>
@@ -104,16 +106,14 @@ <h3>Navigation</h3>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+      <div class="sphinxsidebar">
         <div class="sphinxsidebarwrapper">
-  <div role="note" aria-label="source link">
-    <h3>This Page</h3>
-    <ul class="this-page-menu">
-      <li><a href="_sources/HVAC_diagrams.txt"
-            rel="nofollow">Show Source</a></li>
-    </ul>
-   </div>
-<div id="searchbox" style="display: none" role="search">
+  <h3>This Page</h3>
+  <ul class="this-page-menu">
+    <li><a href="_sources/HVAC_diagrams.txt"
+           rel="nofollow">Show Source</a></li>
+  </ul>
+<div id="searchbox" style="display: none">
   <h3>Quick search</h3>
     <form class="search" action="search.html" method="get">
       <input type="text" name="q" />
@@ -130,18 +130,21 @@ <h3>Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="related navigation">
+    <div class="related">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
+        <li><a href="index.html">eppy 0.5.31 documentation</a> &raquo;</li> 
       </ul>
     </div>
-    <div class="footer" role="contentinfo">
+    <div class="footer">
         &copy; Copyright 2013, Santosh Philip.
-      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
+      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2b2.
     </div>
   </body>
 </html>