docs for rename() done. Starting docs for HVAC

loops.

docs/generated/_sources/newfunctions.txt

@@ -1,6 +1,6 @@
 
 New functions
-~~~~~~~~~~~~~
+=============
 
 
 These are recently written functions that have not made it into the main
@@ -76,7 +76,7 @@ Now let us open file fname1 without setting the **idd** file
     ---------------------------------------------------------------------------
     IDDNotSetError                            Traceback (most recent call last)
 
-    <ipython-input-16-44ad2b53d42c> in <module>()
+    <ipython-input-3-44ad2b53d42c> in <module>()
           2     idf1 = IDF(fname1)
           3 except Exception, e:
     ----> 4     raise e
@@ -115,7 +115,7 @@ this and should raise an exception.
     ---------------------------------------------------------------------------
     IDDAlreadySetError                        Traceback (most recent call last)
 
-    <ipython-input-18-52df819ac489> in <module>()
+    <ipython-input-5-52df819ac489> in <module>()
           2     IDF.setiddname("anotheridd.idd")
           3 except Exception, e:
     ----> 4     raise e
@@ -473,6 +473,10 @@ Deleting, copying/adding and making new idfobjects
 --------------------------------------------------
 
 
+Making a new idf object
+~~~~~~~~~~~~~~~~~~~~~~~
+
+
 Let us start with a blank idf file and make some new "MATERIAL" objects
 in it
 
@@ -613,6 +617,10 @@ As we can see there are three MATERIAL idfobjects. They are:
 3. third material
 
 
+Deleting an idf object
+~~~~~~~~~~~~~~~~~~~~~~
+
+
 Let us remove 2. Lousy material. It is the second material in the list.
 So let us remove the second material
 
@@ -690,6 +698,10 @@ So we have two ways of deleting an idf object:
 2. removeidfobject -> give it the idf object to be deleted
 
 
+Copying/Adding an idf object
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
 Having deleted two "MATERIAL" objects, we have only one left. Let us
 make a copy of this object and add it to our idf file
 
@@ -730,4 +742,13 @@ make a copy of this object and add it to our idf file
     ]
 
 
-So now we have a copy of the material
+So now we have a copy of the material. You can use this method to copy
+idf objects from other idf files too.
+
+Renaming an idf object
+----------------------
+
+
+.. code:: python
+
+

docs/generated/eppy_api.html

@@ -76,8 +76,8 @@ <h3>Navigation</h3>
 <em class="property">class </em><tt class="descclassname">eppy.modeleditor.</tt><tt class="descname">IDF1</tt><big>(</big><em>idfname</em><big>)</big><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="headerlink" href="#eppy.modeleditor.IDF1.copyidfobject" title="Permalink to this definition">¶</a></dt>
+<dt id="eppy.modeleditor.IDF1.addidfobject">
+<tt class="descname">addidfobject</tt><big>(</big><em>idfobject</em><big>)</big><a class="headerlink" href="#eppy.modeleditor.IDF1.addidfobject" 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>

docs/generated/genindex.html

@@ -49,7 +49,7 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#A"><strong>A</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#I"><strong>I</strong></a>
@@ -59,11 +59,11 @@ <h1 id="index">Index</h1>
  | <a href="#S"><strong>S</strong></a>
 
 </div>
-<h2 id="C">C</h2>
+<h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
 
-  <dt><a href="eppy_api.html#eppy.modeleditor.IDF1.copyidfobject">copyidfobject() (eppy.modeleditor.IDF1 method)</a>
+  <dt><a href="eppy_api.html#eppy.modeleditor.IDF1.addidfobject">addidfobject() (eppy.modeleditor.IDF1 method)</a>
   </dt>
 
   </dl></td>

docs/generated/newfunctions.html

@@ -109,7 +109,7 @@ <h2>Setting IDD name<a class="headerlink" href="#setting-idd-name" title="Permal
 <div class="highlight-python"><pre>---------------------------------------------------------------------------
 IDDNotSetError                            Traceback (most recent call last)
 
-&lt;ipython-input-16-44ad2b53d42c&gt; in &lt;module&gt;()
+&lt;ipython-input-3-44ad2b53d42c&gt; in &lt;module&gt;()
       2     idf1 = IDF(fname1)
       3 except Exception, e:
 ----&gt; 4     raise e
@@ -137,7 +137,7 @@ <h2>Setting IDD name<a class="headerlink" href="#setting-idd-name" title="Permal
 <div class="highlight-python"><pre>---------------------------------------------------------------------------
 IDDAlreadySetError                        Traceback (most recent call last)
 
-&lt;ipython-input-18-52df819ac489&gt; in &lt;module&gt;()
+&lt;ipython-input-5-52df819ac489&gt; in &lt;module&gt;()
       2     IDF.setiddname("anotheridd.idd")
       3 except Exception, e:
 ----&gt; 4     raise e
@@ -401,6 +401,8 @@ <h2>Blank idf file<a class="headerlink" href="#blank-idf-file" title="Permalink
 </div>
 <div class="section" id="deleting-copying-adding-and-making-new-idfobjects">
 <h2>Deleting, copying/adding and making new idfobjects<a class="headerlink" href="#deleting-copying-adding-and-making-new-idfobjects" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="making-a-new-idf-object">
+<h3>Making a new idf object<a class="headerlink" href="#making-a-new-idf-object" title="Permalink to this headline">¶</a></h3>
 <p>Let us start with a blank idf file and make some new &#8220;MATERIAL&#8221; objects
 in it</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="c"># making a blank idf object</span>
@@ -508,6 +510,9 @@ <h2>Deleting, copying/adding and making new idfobjects<a class="headerlink" href
 <li>Lousy material</li>
 <li>third material</li>
 </ol>
+</div>
+<div class="section" id="deleting-an-idf-object">
+<h3>Deleting an idf object<a class="headerlink" href="#deleting-an-idf-object" title="Permalink to this headline">¶</a></h3>
 <p>Let us remove 2. Lousy material. It is the second material in the list.
 So let us remove the second material</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="n">idf</span><span class="o">.</span><span class="n">popidfobject</span><span class="p">(</span><span class="s">&#39;MATERIAL&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c"># first material is &#39;0&#39;, second is &#39;1&#39;</span>
@@ -569,6 +574,9 @@ <h2>Deleting, copying/adding and making new idfobjects<a class="headerlink" href
 <li>popidfobject -&gt; give it the idf key: &#8220;MATERIAL&#8221;, and the index number</li>
 <li>removeidfobject -&gt; give it the idf object to be deleted</li>
 </ol>
+</div>
+<div class="section" id="copying-adding-an-idf-object">
+<h3>Copying/Adding an idf object<a class="headerlink" href="#copying-adding-an-idf-object" title="Permalink to this headline">¶</a></h3>
 <p>Having deleted two &#8220;MATERIAL&#8221; objects, we have only one left. Let us
 make a copy of this object and add it to our idf file</p>
 <div class="code python highlight-python"><div class="highlight"><pre><span class="n">onlymaterial</span> <span class="o">=</span> <span class="n">idf</span><span class="o">.</span><span class="n">idfobjects</span><span class="p">[</span><span class="s">&quot;MATERIAL&quot;</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
@@ -604,7 +612,12 @@ <h2>Deleting, copying/adding and making new idfobjects<a class="headerlink" href
     0.7;                      !- Visible Absorptance
 ]</pre>
 </div>
-<p>So now we have a copy of the material</p>
+<p>So now we have a copy of the material. You can use this method to copy
+idf objects from other idf files too.</p>
+</div>
+</div>
+<div class="section" id="renaming-an-idf-object">
+<h2>Renaming an idf object<a class="headerlink" href="#renaming-an-idf-object" title="Permalink to this headline">¶</a></h2>
 </div>
 </div>
 
@@ -622,7 +635,13 @@ <h3><a href="index.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#check-range-for-fields">Check range for fields</a></li>
 <li><a class="reference internal" href="#looping-through-all-the-fields-in-an-idf-object">Looping through all the fields in an idf object</a></li>
 <li><a class="reference internal" href="#blank-idf-file">Blank idf file</a></li>
-<li><a class="reference internal" href="#deleting-copying-adding-and-making-new-idfobjects">Deleting, copying/adding and making new idfobjects</a></li>
+<li><a class="reference internal" href="#deleting-copying-adding-and-making-new-idfobjects">Deleting, copying/adding and making new idfobjects</a><ul>
+<li><a class="reference internal" href="#making-a-new-idf-object">Making a new idf object</a></li>
+<li><a class="reference internal" href="#deleting-an-idf-object">Deleting an idf object</a></li>
+<li><a class="reference internal" href="#copying-adding-an-idf-object">Copying/Adding an idf object</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#renaming-an-idf-object">Renaming an idf object</a></li>
 </ul>
 </li>
 </ul>

docs/generated/newfunctions.rst

@@ -1,6 +1,6 @@
 
 New functions
-~~~~~~~~~~~~~
+=============
 
 
 These are recently written functions that have not made it into the main
@@ -76,7 +76,7 @@ Now let us open file fname1 without setting the **idd** file
     ---------------------------------------------------------------------------
     IDDNotSetError                            Traceback (most recent call last)
 
-    <ipython-input-16-44ad2b53d42c> in <module>()
+    <ipython-input-3-44ad2b53d42c> in <module>()
           2     idf1 = IDF(fname1)
           3 except Exception, e:
     ----> 4     raise e
@@ -115,7 +115,7 @@ this and should raise an exception.
     ---------------------------------------------------------------------------
     IDDAlreadySetError                        Traceback (most recent call last)
 
-    <ipython-input-18-52df819ac489> in <module>()
+    <ipython-input-5-52df819ac489> in <module>()
           2     IDF.setiddname("anotheridd.idd")
           3 except Exception, e:
     ----> 4     raise e
@@ -473,6 +473,10 @@ Deleting, copying/adding and making new idfobjects
 --------------------------------------------------
 
 
+Making a new idf object
+~~~~~~~~~~~~~~~~~~~~~~~
+
+
 Let us start with a blank idf file and make some new "MATERIAL" objects
 in it
 
@@ -613,6 +617,10 @@ As we can see there are three MATERIAL idfobjects. They are:
 3. third material
 
 
+Deleting an idf object
+~~~~~~~~~~~~~~~~~~~~~~
+
+
 Let us remove 2. Lousy material. It is the second material in the list.
 So let us remove the second material
 
@@ -690,6 +698,10 @@ So we have two ways of deleting an idf object:
 2. removeidfobject -> give it the idf object to be deleted
 
 
+Copying/Adding an idf object
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
 Having deleted two "MATERIAL" objects, we have only one left. Let us
 make a copy of this object and add it to our idf file
 
@@ -730,4 +742,13 @@ make a copy of this object and add it to our idf file
     ]
 
 
-So now we have a copy of the material
+So now we have a copy of the material. You can use this method to copy
+idf objects from other idf files too.
+
+Renaming an idf object
+----------------------
+
+
+.. code:: python
+
+    

docs/generated/newfunctions_files/newfunctions_55_0.text

@@ -1,6 +1,6 @@
 
 MATERIAL,                 
-    third material,           !- Name
+    Shiny new material object,    !- Name
     ,                         !- Roughness
     ,                         !- Thickness
     ,                         !- Conductivity

docs/generated/newfunctions_files/newfunctions_71_0.text

@@ -0,0 +1,23 @@
+[
+MATERIAL,                 
+    Shiny new material object,    !- Name
+    ,                         !- Roughness
+    ,                         !- Thickness
+    ,                         !- Conductivity
+    ,                         !- Density
+    ,                         !- Specific Heat
+    0.9,                      !- Thermal Absorptance
+    0.7,                      !- Solar Absorptance
+    0.7;                      !- Visible Absorptance
+, 
+MATERIAL,                 
+    Shiny new material object,    !- Name
+    ,                         !- Roughness
+    ,                         !- Thickness
+    ,                         !- Conductivity
+    ,                         !- Density
+    ,                         !- Specific Heat
+    0.9,                      !- Thermal Absorptance
+    0.7,                      !- Solar Absorptance
+    0.7;                      !- Visible Absorptance
+]