Merge pull request #8 from RWTH-EBC/issue7_OptionalPara

Issue7 optional para

doc/_build/html/genindex.html

@@ -49,7 +49,8 @@ <h3>Navigation</h3>
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#B"><strong>B</strong></a>
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
@@ -58,6 +59,7 @@ <h1 id="index">Index</h1>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
+ | <a href="#N"><strong>N</strong></a>
  | <a href="#O"><strong>O</strong></a>
  | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
@@ -68,6 +70,16 @@ <h1 id="index">Index</h1>
  | <a href="#Y"><strong>Y</strong></a>
 
 </div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%" valign="top"><dl>
+
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.attic">attic (teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
+  </dt>
+
+  </dl></td>
+</tr></table>
+
 <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
@@ -117,12 +129,12 @@ <h2 id="C">C</h2>
   <dt><a href="teaser.Logic.BuildingObjects.BuildingPhysics.html#teaser.Logic.BuildingObjects.BuildingPhysics.BuildingElement.BuildingElement.calc_ua_value">calc_ua_value() (teaser.Logic.BuildingObjects.BuildingPhysics.BuildingElement.BuildingElement method)</a>
   </dt>
 
-  </dl></td>
-  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="teaser.Logic.BuildingObjects.html#teaser.Logic.BuildingObjects.ThermalZone.ThermalZone.calc_weightfactors">calc_weightfactors() (teaser.Logic.BuildingObjects.ThermalZone.ThermalZone method)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
 
   <dt><a href="teaser.Logic.BuildingObjects.html#teaser.Logic.BuildingObjects.ThermalZone.ThermalZone.calc_zone_parameters">calc_zone_parameters() (teaser.Logic.BuildingObjects.ThermalZone.ThermalZone method)</a>
   </dt>
@@ -132,13 +144,23 @@ <h2 id="C">C</h2>
   </dt>
 
 
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.cellar">cellar (teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
+  </dt>
+
+
   <dt><a href="teaser.Logic.BuildingObjects.html#teaser.Logic.BuildingObjects.ThermalZone.ThermalZone.combine_building_elements">combine_building_elements() (teaser.Logic.BuildingObjects.ThermalZone.ThermalZone method)</a>
   </dt>
 
 
   <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Office.Office.construction_type">construction_type (teaser.Logic.BuildingObjects.TypeBuildings.Office.Office attribute)</a>
   </dt>
 
+      <dd><dl>
+
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.construction_type">(teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
+  </dt>
+
+      </dl></dd>
 
   <dt><a href="teaser.Logic.html#teaser.Logic.Utilis.create_path">create_path() (in module teaser.Logic.Utilis)</a>
   </dt>
@@ -153,6 +175,12 @@ <h2 id="D">D</h2>
   <dt><a href="teaser.Data.html#teaser.Data.DataClass.DataClass">DataClass (class in teaser.Data.DataClass)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
+
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.dormer">dormer (teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
@@ -346,6 +374,16 @@ <h2 id="M">M</h2>
   </dl></td>
 </tr></table>
 
+<h2 id="N">N</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%" valign="top"><dl>
+
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.neighbour_buildings">neighbour_buildings (teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
+  </dt>
+
+  </dl></td>
+</tr></table>
+
 <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%" valign="top"><dl>
@@ -432,16 +470,20 @@ <h2 id="R">R</h2>
   </dt>
 
 
-  <dt><a href="teaser.Project.html#teaser.Project.Project.retrofit_all_buildings">retrofit_all_buildings() (teaser.Project.Project method)</a>
+  <dt><a href="teaser.Logic.BuildingObjects.TypeBuildings.html#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.residential_layout">residential_layout (teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential attribute)</a>
   </dt>
 
 
-  <dt><a href="teaser.Logic.BuildingObjects.html#teaser.Logic.BuildingObjects.Building.Building.retrofit_building">retrofit_building() (teaser.Logic.BuildingObjects.Building.Building method)</a>
+  <dt><a href="teaser.Project.html#teaser.Project.Project.retrofit_all_buildings">retrofit_all_buildings() (teaser.Project.Project method)</a>
   </dt>
 
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
 
+  <dt><a href="teaser.Logic.BuildingObjects.html#teaser.Logic.BuildingObjects.Building.Building.retrofit_building">retrofit_building() (teaser.Logic.BuildingObjects.Building.Building method)</a>
+  </dt>
+
+
   <dt><a href="teaser.Logic.BuildingObjects.BuildingPhysics.html#teaser.Logic.BuildingObjects.BuildingPhysics.Wall.Wall.retrofit_wall">retrofit_wall() (teaser.Logic.BuildingObjects.BuildingPhysics.Wall.Wall method)</a>
   </dt>
 

doc/_build/html/teaser.Logic.BuildingObjects.TypeBuildings.html

@@ -104,23 +104,23 @@ <h1>TypeBuildings package<a class="headerlink" href="#typebuildings-package" tit
 </div></blockquote>
 <p><strong>office_layout</strong> : int</p>
 <blockquote>
-<div><p>type of floor plan</p>
+<div><p>type of floor plan (default = 0)</p>
 <p>0: use default values
 1: elongated 1 floor
 2: elongated 2 floors
 3: compact</p>
 </div></blockquote>
 <p><strong>window_layout</strong> : int</p>
 <blockquote>
-<div><p>type of window layout</p>
+<div><p>type of window layout (default = 0)</p>
 <p>0: use default values
 1: punctuated facade
 2: banner facade
 3: full glazing</p>
 </div></blockquote>
 <p><strong>construction_type</strong> : str</p>
 <blockquote class="last">
-<div><p>construction type</p>
+<div><p>construction type (default = &#8220;heavy&#8221;)</p>
 <p>heavy: heavy construction
 light: light construction</p>
 </div></blockquote>
@@ -207,7 +207,7 @@ <h1>TypeBuildings package<a class="headerlink" href="#typebuildings-package" tit
 <span id="residential-module"></span><h2>Residential module<a class="headerlink" href="#module-teaser.Logic.BuildingObjects.TypeBuildings.Residential" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential">
-<em class="property">class </em><code class="descclassname">teaser.Logic.BuildingObjects.TypeBuildings.Residential.</code><code class="descname">Residential</code><span class="sig-paren">(</span><em>parent</em>, <em>name</em>, <em>year_of_construction=None</em>, <em>number_of_floors=None</em>, <em>height_of_floors=None</em>, <em>net_leased_area=None</em>, <em>residential_layout=None</em>, <em>neighbour_buildings=None</em>, <em>attic=None</em>, <em>cellar=None</em>, <em>construction_type=None</em>, <em>dormer=None</em><span class="sig-paren">)</span><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">teaser.Logic.BuildingObjects.TypeBuildings.Residential.</code><code class="descname">Residential</code><span class="sig-paren">(</span><em>parent</em>, <em>name</em>, <em>year_of_construction=None</em>, <em>number_of_floors=None</em>, <em>height_of_floors=None</em>, <em>net_leased_area=None</em>, <em>residential_layout=None</em>, <em>neighbour_buildings=None</em>, <em>attic=None</em>, <em>cellar=None</em>, <em>dormer=None</em>, <em>construction_type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#teaser.Logic.BuildingObjects.TypeBuildings.TypeBuilding.TypeBuilding" title="teaser.Logic.BuildingObjects.TypeBuildings.TypeBuilding.TypeBuilding"><code class="xref py py-class docutils literal"><span class="pre">teaser.Logic.BuildingObjects.TypeBuildings.TypeBuilding.TypeBuilding</span></code></a></p>
 <p>Type Building Residential.</p>
 <p>Subclass from Building to represent Residential Buildings. Allows for
@@ -245,36 +245,36 @@ <h1>TypeBuildings package<a class="headerlink" href="#typebuildings-package" tit
 </div></blockquote>
 <p><strong>residential_layout</strong> : int</p>
 <blockquote>
-<div><p>type of floor plan</p>
+<div><p>type of floor plan (default = 0)</p>
 <p>0: compact
 1: elongated/complex</p>
 </div></blockquote>
 <p><strong>neighbour_buildings</strong> : int</p>
 <blockquote>
-<div><p>neighbour</p>
+<div><p>neighbour (default = 0)</p>
 <p>0: no neighbour
 1: one neighbour
 2: two neighbours</p>
 </div></blockquote>
 <p><strong>attic</strong> : int</p>
 <blockquote>
-<div><p>type of attic</p>
+<div><p>type of attic (default = 0)</p>
 <p>0: flat roof
 1: non heated attic
 2: partly heated attic
 3: heated attic</p>
 </div></blockquote>
 <p><strong>cellar</strong> : int</p>
 <blockquote>
-<div><p>type of cellar</p>
+<div><p>type of cellar (default = 0)</p>
 <p>0: no cellar
 1: non heated cellar
 2: partly heated cellar
 3: heated cellar</p>
 </div></blockquote>
 <p><strong>construction_type</strong> : str</p>
 <blockquote>
-<div><p>construction type</p>
+<div><p>construction type (default = &#8220;heavy&#8221;)</p>
 <p>heavy: heavy construction
 light: light construction</p>
 </div></blockquote>
@@ -337,6 +337,26 @@ <h1>TypeBuildings package<a class="headerlink" href="#typebuildings-package" tit
 </tbody>
 </table>
 <p class="rubric">Methods</p>
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.attic">
+<code class="descname">attic</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.attic" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.cellar">
+<code class="descname">cellar</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.cellar" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.construction_type">
+<code class="descname">construction_type</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.construction_type" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.dormer">
+<code class="descname">dormer</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.dormer" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="method">
 <dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.generate_residential">
 <code class="descname">generate_residential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.generate_residential" title="Permalink to this definition">¶</a></dt>
@@ -346,6 +366,16 @@ <h1>TypeBuildings package<a class="headerlink" href="#typebuildings-package" tit
 Berechnungsgrundlagen: IWU, &#8220;Kurzverfahren Energieprofil&#8221;; 2005.</p>
 </dd></dl>
 
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.neighbour_buildings">
+<code class="descname">neighbour_buildings</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.neighbour_buildings" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="attribute">
+<dt id="teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.residential_layout">
+<code class="descname">residential_layout</code><a class="headerlink" href="#teaser.Logic.BuildingObjects.TypeBuildings.Residential.Residential.residential_layout" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </dd></dl>
 
 </div>