continuing with docs for useful_scripts idfdiff.py

santoshphilip · Aug 19, 2014 · 9e13352 · 9e13352
1 parent 9885fc9
commit 9e13352
Show file tree

Hide file tree

Showing 32 changed files with 370 additions and 19 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/eppy_api.doctree b/docs/build/doctrees/eppy_api.doctree
diff --git a/docs/build/doctrees/useful_scripts.doctree b/docs/build/doctrees/useful_scripts.doctree
diff --git a/docs/generated/HVAC_Tutorial.html b/docs/generated/HVAC_Tutorial.html
@@ -34,6 +34,9 @@ <h3>Navigation</h3>
         <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>
@@ -457,6 +460,9 @@ <h3>Navigation</h3>
         <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>

diff --git a/docs/generated/HVAC_diagrams.html b/docs/generated/HVAC_diagrams.html
@@ -32,6 +32,9 @@ <h3>Navigation</h3>
         <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><a href="index.html">eppy 0.4.6.2 documentation</a> &raquo;</li> 
       </ul>
     </div>  
@@ -133,6 +136,9 @@ <h3>Navigation</h3>
         <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><a href="index.html">eppy 0.4.6.2 documentation</a> &raquo;</li> 
       </ul>
     </div>

diff --git a/docs/generated/Main_Tutorial.html b/docs/generated/Main_Tutorial.html
@@ -34,6 +34,9 @@ <h3>Navigation</h3>
         <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="HVAC_Tutorial.html" title="HVAC Loops"
              accesskey="N">next</a> |</li>
@@ -1684,6 +1687,9 @@ <h3>Navigation</h3>
         <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="HVAC_Tutorial.html" title="HVAC Loops"
              >next</a> |</li>

diff --git a/docs/generated/Outputs_Tutorial.html b/docs/generated/Outputs_Tutorial.html
@@ -34,6 +34,9 @@ <h3>Navigation</h3>
         <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="newfunctions.html" title="New functions"
              accesskey="N">next</a> |</li>
@@ -603,6 +606,9 @@ <h3>Navigation</h3>
         <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="newfunctions.html" title="New functions"
              >next</a> |</li>

diff --git a/docs/generated/_modules/eppy/modeleditor.html b/docs/generated/_modules/eppy/modeleditor.html
@@ -33,6 +33,9 @@ <h3>Navigation</h3>
         <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><a href="../../index.html">eppy 0.4.6.2 documentation</a> &raquo;</li>
           <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
@@ -726,6 +729,9 @@ <h3>Navigation</h3>
         <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><a href="../../index.html">eppy 0.4.6.2 documentation</a> &raquo;</li>
           <li><a href="../index.html" >Module code</a> &raquo;</li> 
       </ul>

diff --git a/docs/generated/_modules/index.html b/docs/generated/_modules/index.html
@@ -32,6 +32,9 @@ <h3>Navigation</h3>
         <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><a href="../index.html">eppy 0.4.6.2 documentation</a> &raquo;</li> 
       </ul>
     </div>  
@@ -73,6 +76,9 @@ <h3>Navigation</h3>
         <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><a href="../index.html">eppy 0.4.6.2 documentation</a> &raquo;</li> 
       </ul>
     </div>

diff --git a/docs/generated/_sources/useful_scripts.txt b/docs/generated/_sources/useful_scripts.txt
@@ -109,6 +109,11 @@ diff in html format.
     <html><p>file1 = ../resources/idffiles/V_7_2/constructions.idf</p><p>file2 = ../resources/idffiles/V_7_2/constructions_diff.idf</p><table border="1"><tr><th>Object Key</th><th> Object Name</th><th> Field Name</th><th> file1</th><th> file2</th></tr><tr><td>MATERIAL</td><td>F08 Metal surface</td><td></td><td>not here</td><td>is here</td></tr><tr><td>MATERIAL</td><td>F08 Metal surface haha</td><td></td><td>is here</td><td>not here</td></tr><tr><td>MATERIAL</td><td>G05 25mm wood</td><td>Conductivity</td><td>0.15</td><td>0.155</td></tr><tr><td>CONSTRUCTION</td><td>Exterior Door</td><td>Outside Layer</td><td>F08 Metal surface</td><td>F08 Metal surface haha</td></tr></table></html>
 
 
+reprinting the output again for clarity:
+
+<html><p>file1 = ../resources/idffiles/V_7_2/constructions.idf</p><p>file2 = ../resources/idffiles/V_7_2/constructions_diff.idf</p><table border="1"><tr><th>Object Key</th><th> Object Name</th><th> Field Name</th><th> file1</th><th> file2</th></tr><tr><td>MATERIAL</td><td>F08 Metal surface</td><td></td><td>not here</td><td>is here</td></tr><tr><td>MATERIAL</td><td>F08 Metal surface haha</td><td></td><td>is here</td><td>not here</td></tr><tr><td>MATERIAL</td><td>G05 25mm wood</td><td>Conductivity</td><td>0.15</td><td>0.155</td></tr><tr><td>CONSTRUCTION</td><td>Exterior Door</td><td>Outside Layer</td><td>F08 Metal surface</td><td>F08 Metal surface haha</td></tr></table></html>
+
+
 It does look like html :-). We need to redirect this output to a file
 and then open the file in a browser to see what it looks like. Displayed
 below is the html file

diff --git a/docs/generated/eppy_api.html b/docs/generated/eppy_api.html
@@ -33,6 +33,9 @@ <h3>Navigation</h3>
         <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="useful_scripts.html" title="Useful Scripts"
              accesskey="P">previous</a> |</li>
@@ -45,8 +48,115 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body">
 
-  <div class="section" id="eppy-api">
-<h1>Eppy API<a class="headerlink" href="#eppy-api" title="Permalink to this headline">¶</a></h1>
+  <div class="section" id="module-eppy.modeleditor">
+<span id="eppy-api"></span><h1>Eppy API<a class="headerlink" href="#module-eppy.modeleditor" title="Permalink to this headline">¶</a></h1>
+<p>functions to edit the E+ model</p>
+<dl class="class">
+<dt id="eppy.modeleditor.IDF0">
+<em class="property">class </em><tt class="descclassname">eppy.modeleditor.</tt><tt class="descname">IDF0</tt><big>(</big><em>idfname=None</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF0"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF0" title="Permalink to this definition">¶</a></dt>
+<dd><p>document the following variables:</p>
+<ul class="simple">
+<li>idfobjects</li>
+<li>outputtype</li>
+<li>iddname</li>
+<li>idfname</li>
+<li>idd_info</li>
+<li>model</li>
+</ul>
+<dl class="method">
+<dt id="eppy.modeleditor.IDF0.read">
+<tt class="descname">read</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF0.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF0.read" title="Permalink to this definition">¶</a></dt>
+<dd><p>read the idf file</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="eppy.modeleditor.IDF1">
+<em class="property">class </em><tt class="descclassname">eppy.modeleditor.</tt><tt class="descname">IDF1</tt><big>(</big><em>idfname=None</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1" title="Permalink to this definition">¶</a></dt>
+<dd><p>subclass of IDF0. Uses functions of IDF0</p>
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.copyidfobject">
+<tt class="descname">copyidfobject</tt><big>(</big><em>idfobject</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.copyidfobject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.copyidfobject" title="Permalink to this definition">¶</a></dt>
+<dd><p>add idfobject to this model</p>
+<p>idfobject usually comes from another idf file
+or it can be used to copy within this idf file</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.getextensibleindex">
+<tt class="descname">getextensibleindex</tt><big>(</big><em>key</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.getextensibleindex"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.getextensibleindex" title="Permalink to this definition">¶</a></dt>
+<dd><p>get the index of the first extensible item</p>
+<p>only for internal use. # TODO : hide this</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.getobject">
+<tt class="descname">getobject</tt><big>(</big><em>key</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.getobject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.getobject" title="Permalink to this definition">¶</a></dt>
+<dd><p>return the object given key and name</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.newidfobject">
+<tt class="descname">newidfobject</tt><big>(</big><em>key</em>, <em>aname=''</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.newidfobject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.newidfobject" title="Permalink to this definition">¶</a></dt>
+<dd><p>add a new idfobject to the model</p>
+<p>for example</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">newidfobject</span><span class="p">(</span><span class="s">&quot;CONSTRUCTION&quot;</span><span class="p">)</span>
+<span class="n">newidfobject</span><span class="p">(</span><span class="s">&quot;CONSTRUCTION&quot;</span><span class="p">,</span> 
+    <span class="n">Name</span><span class="o">=</span><span class="s">&#39;Interior Ceiling_class&#39;</span><span class="p">,</span> 
+    <span class="n">Outside_Layer</span><span class="o">=</span><span class="s">&#39;LW Concrete&#39;</span><span class="p">,</span> 
+    <span class="n">Layer_2</span><span class="o">=</span><span class="s">&#39;soundmat&#39;</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>If you don&#8217;t specify a value for a field, the default value will be set</p>
+<p>aname is not used. It is left there for backward compatibility</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.popidfobject">
+<tt class="descname">popidfobject</tt><big>(</big><em>key</em>, <em>index</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.popidfobject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.popidfobject" title="Permalink to this definition">¶</a></dt>
+<dd><p>pop this object</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.removeextensibles">
+<tt class="descname">removeextensibles</tt><big>(</big><em>key</em>, <em>name</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.removeextensibles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.removeextensibles" title="Permalink to this definition">¶</a></dt>
+<dd><p>remove extensible items in the object of key and name</p>
+<p>only for internal use. # TODO : hide this</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF1.removeidfobject">
+<tt class="descname">removeidfobject</tt><big>(</big><em>idfobject</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF1.removeidfobject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF1.removeidfobject" title="Permalink to this definition">¶</a></dt>
+<dd><p>remove this idfobject</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="class">
+<dt id="eppy.modeleditor.IDF2">
+<em class="property">class </em><tt class="descclassname">eppy.modeleditor.</tt><tt class="descname">IDF2</tt><big>(</big><em>idfname=None</em><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF2" title="Permalink to this definition">¶</a></dt>
+<dd><p>subclass of IDF1. Uses functions of IDF1</p>
+<dl class="method">
+<dt id="eppy.modeleditor.IDF2.printidf">
+<tt class="descname">printidf</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF2.printidf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF2.printidf" title="Permalink to this definition">¶</a></dt>
+<dd><p>print the idf</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="eppy.modeleditor.IDF2.save">
+<tt class="descname">save</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/eppy/modeleditor.html#IDF2.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.modeleditor.IDF2.save" title="Permalink to this definition">¶</a></dt>
+<dd><p>save with comments</p>
+</dd></dl>
+
+</dd></dl>
+
+<dl class="attribute">
+<dt id="eppy.modeleditor.IDF">
+<tt class="descclassname">eppy.modeleditor.</tt><tt class="descname">IDF</tt><a class="headerlink" href="#eppy.modeleditor.IDF" title="Permalink to this definition">¶</a></dt>
+<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">IDF3</span></tt></p>
+</dd></dl>
+
 </div>
 
 
@@ -86,6 +196,9 @@ <h3>Navigation</h3>
         <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="useful_scripts.html" title="Useful Scripts"
              >previous</a> |</li>