This is the release 0.5

santoshphilip · Jul 14, 2015 · acd5d85 · acd5d85
1 parent 88a7549
commit acd5d85
Show file tree

Hide file tree

Showing 20 changed files with 347 additions and 17 deletions.
diff --git a/docs/HVAC_Tutorial.ipynb b/docs/HVAC_Tutorial.ipynb
@@ -913,15 +913,6 @@
      "source": [
       "Again, just as we did in the plant and condensor loop, we can change the components of the loop, by replacing the branchs and traverse the loop using the functions nextnode() and prevnode()"
      ]
-    },
-    {
-     "cell_type": "code",
-     "collapsed": false,
-     "input": [],
-     "language": "python",
-     "metadata": {},
-     "outputs": [],
-     "prompt_number": 27
     }
    ],
    "metadata": {}

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/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>
@@ -521,6 +524,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/LICENSE.html b/docs/generated/LICENSE.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="dev_docs/doc_eppy.html" title="Documenting eppy"
              accesskey="P">previous</a> |</li>
@@ -104,6 +107,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="dev_docs/doc_eppy.html" title="Documenting eppy"
              >previous</a> |</li>

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/bunch_subclass.html b/docs/generated/_modules/eppy/bunch_subclass.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.5 documentation</a> &raquo;</li>
           <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
@@ -385,6 +388,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.5 documentation</a> &raquo;</li>
           <li><a href="../index.html" >Module code</a> &raquo;</li> 
       </ul>

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.5 documentation</a> &raquo;</li>
           <li><a href="../index.html" accesskey="U">Module code</a> &raquo;</li> 
       </ul>
@@ -732,6 +735,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.5 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.5 documentation</a> &raquo;</li> 
       </ul>
     </div>  
@@ -74,6 +77,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.5 documentation</a> &raquo;</li> 
       </ul>
     </div>

diff --git a/docs/generated/changes.html b/docs/generated/changes.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="dev_docs/index.html" title="Developer Documentation for eppy"
              accesskey="N">next</a> |</li>
@@ -263,6 +266,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="dev_docs/index.html" title="Developer Documentation for eppy"
              >next</a> |</li>

diff --git a/docs/generated/eppy_api.html b/docs/generated/eppy_api.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="changes.html" title="Changes"
              accesskey="N">next</a> |</li>
@@ -49,8 +52,129 @@ <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 and the idd file.
+If the idd file had been already read, it will not be read again.
+Read populates the following data structures:</p>
+<ul class="simple">
+<li>idfobjects</li>
+<li>model</li>
+<li>idd_info # done only once</li>
+</ul>
+</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=u''</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">IDF4</span></tt></p>
+</dd></dl>
+
+<span class="target" id="module-eppy.bunch_subclass"></span><p>sub class bunch in steps going from data, aliases, functions</p>
+<dl class="class">
+<dt id="eppy.bunch_subclass.EpBunch_1">
+<em class="property">class </em><tt class="descclassname">eppy.bunch_subclass.</tt><tt class="descname">EpBunch_1</tt><big>(</big><em>obj</em>, <em>objls</em>, <em>objidd</em>, <em>*args</em>, <em>**kwargs</em><big>)</big><a class="reference internal" href="_modules/eppy/bunch_subclass.html#EpBunch_1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#eppy.bunch_subclass.EpBunch_1" title="Permalink to this definition">¶</a></dt>
+<dd><p>Has data in bunch</p>
+</dd></dl>
+
 </div>
 
 
@@ -93,6 +217,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="changes.html" title="Changes"
              >next</a> |</li>