s_ranjbar/summer_course_2024
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
523c96216a
summer_course_2024/docs/build/html/index.html

1273 lines
81 KiB
HTML
Raw Normal View History

Add project documentation
2020-06-15 11:38:18 -04:00
<!DOCTYPE html>
<html >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Welcome to CERC libs’s documentation!</title>
<link rel="stylesheet" href="_static/pygments.css">
<link rel="stylesheet" href="_static/theme.css">
<link rel="stylesheet" href="_static/sphinx_press_theme.css">
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<!-- sphinx script_files -->
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/theme-vendors.js"></script>
<script src="_static/theme.js" defer></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body>
<div id="app" class="theme-container" :class="pageClasses"><navbar @toggle-sidebar="toggleSidebar">
<router-link to="#" class="home-link">
<span class="site-name">CERC libs</span>
</router-link>
<div class="links">
<navlinks class="can-hide">
</navlinks>
</div>
</navbar>
<div class="sidebar-mask" @click="toggleSidebar(false)">
</div>
<sidebar @toggle-sidebar="toggleSidebar">
<navlinks>
</navlinks><div id="searchbox" class="searchbox" role="search">
<div class="caption"><span class="caption-text">Quick search</span>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div><div class="sidebar-links" role="navigation" aria-label="main navigation">
<div class="sidebar-group">
<p class="caption">
<span class="caption-text"><a href="#welcome-to-cerc-libs-s-documentation">Contents:</a></span>
</p>
<ul class="">
</ul>
</div>
</div>
</sidebar>
<page>
<div class="body-header" role="navigation" aria-label="navigation">
<ul class="breadcrumbs">
<li><a href="#">Docs</a> &raquo;</li>
<li>Welcome to CERC libs’s documentation!</li>
</ul>
<ul class="page-nav">
</ul>
</div>
<hr>
<div class="content" role="main">
<div class="section" id="welcome-to-cerc-libs-s-documentation">
<h1>Welcome to CERC libs’s documentation!<a class="headerlink" href="#welcome-to-cerc-libs-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
<div class="section" id="city-model-structure">
<h1>City Model Structure<a class="headerlink" href="#city-model-structure" title="Permalink to this headline"></a></h1>
<div class="section" id="module-city_model_structure.city">
<span id="city"></span><h2>City<a class="headerlink" href="#module-city_model_structure.city" title="Permalink to this headline"></a></h2>
<p>City module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.city.City">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.city.</code><code class="sig-name descname">City</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lower_corner</span></em>, <em class="sig-param"><span class="n">upper_corner</span></em>, <em class="sig-param"><span class="n">srs_name</span></em>, <em class="sig-param"><span class="n">buildings</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/city.html#City"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.city.City" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City class</p>
<dl class="py method">
<dt id="city_model_structure.city.City.add_city_object">
<code class="sig-name descname">add_city_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">new_city_object</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/city.html#City.add_city_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.city.City.add_city_object" title="Permalink to this definition"></a></dt>
<dd><p>Add a CityObject to the city
:param new_city_object:CityObject
:return: None</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dl class="py method">
<dt id="city_model_structure.city.City.bixi_features">
<em class="property">property </em><code class="sig-name descname">bixi_features</code><a class="headerlink" href="#city_model_structure.city.City.bixi_features" title="Permalink to this definition"></a></dt>
<dd><p>Bixi features belonging to the city
:return: NotImplementedError</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.buildings">
<em class="property">property </em><code class="sig-name descname">buildings</code><a class="headerlink" href="#city_model_structure.city.City.buildings" title="Permalink to this definition"></a></dt>
<dd><p>Buildings belonging to the city
:return: None or [Building]</p>
</dd></dl>
Add project documentation
2020-06-15 11:38:18 -04:00
<dl class="py method">
<dt id="city_model_structure.city.City.city_object">
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<code class="sig-name descname">city_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span> &#x2192; Optional<span class="p">[</span><a class="reference internal" href="#city_model_structure.city_object.CityObject" title="city_model_structure.city_object.CityObject">city_model_structure.city_object.CityObject</a><span class="p">]</span><a class="reference internal" href="_modules/city_model_structure/city.html#City.city_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.city.City.city_object" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Retrieve the city CityObject with the given name
:param name:str
:return: None or CityObject</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.city_objects">
<em class="property">property </em><code class="sig-name descname">city_objects</code><a class="headerlink" href="#city_model_structure.city.City.city_objects" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dd><p>City objects belonging to the city
:return: None or [CityObject]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.composting_plants">
<em class="property">property </em><code class="sig-name descname">composting_plants</code><a class="headerlink" href="#city_model_structure.city.City.composting_plants" title="Permalink to this definition"></a></dt>
<dd><p>Composting plants belonging to the city
:return: NotImplementedError</p>
Add project documentation
2020-06-15 11:38:18 -04:00
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.country_code">
<em class="property">property </em><code class="sig-name descname">country_code</code><a class="headerlink" href="#city_model_structure.city.City.country_code" title="Permalink to this definition"></a></dt>
<dd><p>City country code
:return: str</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.lower_corner">
<em class="property">property </em><code class="sig-name descname">lower_corner</code><a class="headerlink" href="#city_model_structure.city.City.lower_corner" title="Permalink to this definition"></a></dt>
<dd><p>City lower corner
:return: [x,y,z]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.name">
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#city_model_structure.city.City.name" title="Permalink to this definition"></a></dt>
<dd><p>City name
:return: str</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city.City.srs_name">
<em class="property">property </em><code class="sig-name descname">srs_name</code><a class="headerlink" href="#city_model_structure.city.City.srs_name" title="Permalink to this definition"></a></dt>
<dd><p>srs name
:return: str</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dl class="py method">
<dt id="city_model_structure.city.City.trees">
<em class="property">property </em><code class="sig-name descname">trees</code><a class="headerlink" href="#city_model_structure.city.City.trees" title="Permalink to this definition"></a></dt>
<dd><p>Trees belonging to the city
:return: NotImplementedError</p>
</dd></dl>
Add project documentation
2020-06-15 11:38:18 -04:00
<dl class="py method">
<dt id="city_model_structure.city.City.upper_corner">
<em class="property">property </em><code class="sig-name descname">upper_corner</code><a class="headerlink" href="#city_model_structure.city.City.upper_corner" title="Permalink to this definition"></a></dt>
<dd><p>City upper corner
:return: [x,y,z]</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.city_object">
<span id="city-object"></span><h2>City Object<a class="headerlink" href="#module-city_model_structure.city_object" title="Permalink to this headline"></a></h2>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<p>CityObject module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.city_object.CityObject">
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.city_object.</code><code class="sig-name descname">CityObject</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lod</span></em>, <em class="sig-param"><span class="n">surfaces</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/city_object.html#CityObject"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.city_object.CityObject" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dd><p>class CityObject</p>
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<dl class="py method">
<dt id="city_model_structure.city_object.CityObject.location">
<em class="property">property </em><code class="sig-name descname">location</code><a class="headerlink" href="#city_model_structure.city_object.CityObject.location" title="Permalink to this definition"></a></dt>
<dd><p>City object location
:return: [x,y,z]</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dl class="py method">
<dt id="city_model_structure.city_object.CityObject.lod">
<em class="property">property </em><code class="sig-name descname">lod</code><a class="headerlink" href="#city_model_structure.city_object.CityObject.lod" title="Permalink to this definition"></a></dt>
<dd><p>City object level of detail 1, 2, 3 or 4
:return: int</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<dl class="py method">
<dt id="city_model_structure.city_object.CityObject.surface">
<code class="sig-name descname">surface</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em><span class="sig-paren">)</span> &#x2192; Optional<span class="p">[</span><a class="reference internal" href="#city_model_structure.surface.Surface" title="city_model_structure.surface.Surface">city_model_structure.surface.Surface</a><span class="p">]</span><a class="reference internal" href="_modules/city_model_structure/city_object.html#CityObject.surface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.city_object.CityObject.surface" title="Permalink to this definition"></a></dt>
<dd><p>Get the city object surface with a given name
:param name: str
:return: None or Surface</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city_object.CityObject.surfaces">
<em class="property">property </em><code class="sig-name descname">surfaces</code><a class="headerlink" href="#city_model_structure.city_object.CityObject.surfaces" title="Permalink to this definition"></a></dt>
<dd><p>City object surfaces
:return: [Surface]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.city_object.CityObject.volume">
<em class="property">property </em><code class="sig-name descname">volume</code><a class="headerlink" href="#city_model_structure.city_object.CityObject.volume" title="Permalink to this definition"></a></dt>
<dd><p>City object volume in cubic meters
:return: float</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.bixi_feature">
<span id="bixi-feature"></span><h2>Bixi Feature<a class="headerlink" href="#module-city_model_structure.bixi_feature" title="Permalink to this headline"></a></h2>
<p>bixi_feature module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.bixi_feature.BixiFeature">
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.bixi_feature.</code><code class="sig-name descname">BixiFeature</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lod</span></em>, <em class="sig-param"><span class="n">surfaces</span></em>, <em class="sig-param"><span class="n">feature_type</span></em>, <em class="sig-param"><span class="n">length</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/bixi_feature.html#BixiFeature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.bixi_feature.BixiFeature" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dd><p>BixiFeature(CityObject) class</p>
<dl class="py method">
<dt id="city_model_structure.bixi_feature.BixiFeature.feature_type">
<em class="property">property </em><code class="sig-name descname">feature_type</code><a class="headerlink" href="#city_model_structure.bixi_feature.BixiFeature.feature_type" title="Permalink to this definition"></a></dt>
<dd><p>Get type of bixi feature
:return: feature_type</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.bixi_feature.BixiFeature.length">
<em class="property">property </em><code class="sig-name descname">length</code><a class="headerlink" href="#city_model_structure.bixi_feature.BixiFeature.length" title="Permalink to this definition"></a></dt>
<dd><p>Get length of bixi feature in meters
:return: length</p>
</dd></dl>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
</div>
<div class="section" id="module-city_model_structure.building">
<span id="building"></span><h2>Building<a class="headerlink" href="#module-city_model_structure.building" title="Permalink to this headline"></a></h2>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<p>Building module
Add project documentation
2020-06-15 11:38:18 -04:00
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.building.</code><code class="sig-name descname">Building</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">lod</span></em>, <em class="sig-param"><span class="n">surfaces</span></em>, <em class="sig-param"><span class="n">terrains</span></em>, <em class="sig-param"><span class="n">year_of_construction</span></em>, <em class="sig-param"><span class="n">function</span></em>, <em class="sig-param"><span class="n">lower_corner</span></em>, <em class="sig-param"><span class="n">attic_heated</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">basement_heated</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/building.html#Building"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.building.Building" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dd><p>Building(CityObject) class</p>
Add project documentation
2020-06-15 11:38:18 -04:00
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.attic_heated">
<em class="property">property </em><code class="sig-name descname">attic_heated</code><a class="headerlink" href="#city_model_structure.building.Building.attic_heated" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get if the city object attic is heated
:return: Boolean</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.average_storey_height">
<em class="property">property </em><code class="sig-name descname">average_storey_height</code><a class="headerlink" href="#city_model_structure.building.Building.average_storey_height" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get city object average storey height in meters
:return: float</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.basement_heated">
<em class="property">property </em><code class="sig-name descname">basement_heated</code><a class="headerlink" href="#city_model_structure.building.Building.basement_heated" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get if the city object basement is heated
:return: Boolean</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.foot_print">
<em class="property">property </em><code class="sig-name descname">foot_print</code><a class="headerlink" href="#city_model_structure.building.Building.foot_print" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object foot print surface
:return: Surface</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.function">
<em class="property">property </em><code class="sig-name descname">function</code><a class="headerlink" href="#city_model_structure.building.Building.function" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object function
:return: str</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.heated_volume">
<em class="property">property </em><code class="sig-name descname">heated_volume</code><a class="headerlink" href="#city_model_structure.building.Building.heated_volume" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object heated volume in cubic meters
:return: float</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.max_height">
<em class="property">property </em><code class="sig-name descname">max_height</code><a class="headerlink" href="#city_model_structure.building.Building.max_height" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object maximal height in meters
:return: float</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.name">
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#city_model_structure.building.Building.name" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object name
:return: str</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.stl_export">
<code class="sig-name descname">stl_export</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/building.html#Building.stl_export"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.building.Building.stl_export" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Export the city object to stl file (city_object_name.stl) to the given path
:param path: str
:return: None</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.storeys_above_ground">
<em class="property">property </em><code class="sig-name descname">storeys_above_ground</code><a class="headerlink" href="#city_model_structure.building.Building.storeys_above_ground" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get city object storeys number above ground
:return: int</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.terrains">
<em class="property">property </em><code class="sig-name descname">terrains</code><a class="headerlink" href="#city_model_structure.building.Building.terrains" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get city object terrain surfaces
:return: [Surface]</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.thermal_zones">
<em class="property">property </em><code class="sig-name descname">thermal_zones</code><a class="headerlink" href="#city_model_structure.building.Building.thermal_zones" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object thermal zones
:return: [ThermalZone]</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.type">
<em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#city_model_structure.building.Building.type" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object type
:return: str</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.usage_zones">
<em class="property">property </em><code class="sig-name descname">usage_zones</code><a class="headerlink" href="#city_model_structure.building.Building.usage_zones" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>Get city object usage zones
:return: [UsageZone]</p>
</dd></dl>
<dl class="py method">
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dt id="city_model_structure.building.Building.year_of_construction">
<em class="property">property </em><code class="sig-name descname">year_of_construction</code><a class="headerlink" href="#city_model_structure.building.Building.year_of_construction" title="Permalink to this definition"></a></dt>
Add project documentation
2020-06-15 11:38:18 -04:00
<dd><p>City object year of construction
:return: int</p>
</dd></dl>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
</div>
<div class="section" id="module-city_model_structure.composting_plant">
<span id="composting-plant"></span><h2>Composting Plant<a class="headerlink" href="#module-city_model_structure.composting_plant" title="Permalink to this headline"></a></h2>
<p>Composting plant module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.composting_plant.CompostingPlant">
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.composting_plant.</code><code class="sig-name descname">CompostingPlant</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lod</span></em>, <em class="sig-param"><span class="n">surfaces</span></em>, <em class="sig-param"><span class="n">waste_type</span></em>, <em class="sig-param"><span class="n">capacity</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/composting_plant.html#CompostingPlant"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.composting_plant.CompostingPlant" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dd><p>CompostingPlant(CityObject) class</p>
<dl class="py method">
<dt id="city_model_structure.composting_plant.CompostingPlant.capacity">
<em class="property">property </em><code class="sig-name descname">capacity</code><a class="headerlink" href="#city_model_structure.composting_plant.CompostingPlant.capacity" title="Permalink to this definition"></a></dt>
<dd><p>Get capacity of composting plant in kg
:return: capacity</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.composting_plant.CompostingPlant.waste_type">
<em class="property">property </em><code class="sig-name descname">waste_type</code><a class="headerlink" href="#city_model_structure.composting_plant.CompostingPlant.waste_type" title="Permalink to this definition"></a></dt>
<dd><p>Get waste_type treated in composting plant
:return: waste_type</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.tree">
<span id="tree"></span><h2>Tree<a class="headerlink" href="#module-city_model_structure.tree" title="Permalink to this headline"></a></h2>
<p>Tree module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.tree.Tree">
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.tree.</code><code class="sig-name descname">Tree</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">lod</span></em>, <em class="sig-param"><span class="n">surfaces</span></em>, <em class="sig-param"><span class="n">height</span></em>, <em class="sig-param"><span class="n">canopy</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/tree.html#Tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.tree.Tree" title="Permalink to this definition"></a></dt>
Add the building/city_objects hierarchy to the city
2020-06-16 16:06:33 -04:00
<dd><p>Tree(CityObject) class</p>
<dl class="py method">
<dt id="city_model_structure.tree.Tree.canopy">
<em class="property">property </em><code class="sig-name descname">canopy</code><a class="headerlink" href="#city_model_structure.tree.Tree.canopy" title="Permalink to this definition"></a></dt>
<dd><p>Get canopy of tree
:return: canopy</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.tree.Tree.height">
<em class="property">property </em><code class="sig-name descname">height</code><a class="headerlink" href="#city_model_structure.tree.Tree.height" title="Permalink to this definition"></a></dt>
<dd><p>Get height of tree in meters
:return: height</p>
</dd></dl>
</dd></dl>
Add project documentation
2020-06-15 11:38:18 -04:00
</div>
<div class="section" id="module-city_model_structure.internal_gains">
<span id="internal-gains"></span><h2>Internal Gains<a class="headerlink" href="#module-city_model_structure.internal_gains" title="Permalink to this headline"></a></h2>
<p>InternalGains module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.internal_gains.InternalGains">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.internal_gains.</code><code class="sig-name descname">InternalGains</code><a class="reference internal" href="_modules/city_model_structure/internal_gains.html#InternalGains"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.internal_gains.InternalGains" title="Permalink to this definition"></a></dt>
<dd><p>InternalGains class</p>
<dl class="py method">
<dt id="city_model_structure.internal_gains.InternalGains.average_internal_gain">
<em class="property">property </em><code class="sig-name descname">average_internal_gain</code><a class="headerlink" href="#city_model_structure.internal_gains.InternalGains.average_internal_gain" title="Permalink to this definition"></a></dt>
<dd><p>Get internal gains average internal gain in w/m2
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.internal_gains.InternalGains.convective_fraction">
<em class="property">property </em><code class="sig-name descname">convective_fraction</code><a class="headerlink" href="#city_model_structure.internal_gains.InternalGains.convective_fraction" title="Permalink to this definition"></a></dt>
<dd><p>Get internal gains convective fraction
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.internal_gains.InternalGains.latent_fraction">
<em class="property">property </em><code class="sig-name descname">latent_fraction</code><a class="headerlink" href="#city_model_structure.internal_gains.InternalGains.latent_fraction" title="Permalink to this definition"></a></dt>
<dd><p>Get internal gains latent fraction
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.internal_gains.InternalGains.radiative_fraction">
<em class="property">property </em><code class="sig-name descname">radiative_fraction</code><a class="headerlink" href="#city_model_structure.internal_gains.InternalGains.radiative_fraction" title="Permalink to this definition"></a></dt>
<dd><p>Get internal gains radiative fraction
:return: float</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.layer">
<span id="layer"></span><h2>Layer<a class="headerlink" href="#module-city_model_structure.layer" title="Permalink to this headline"></a></h2>
<p>Layers module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.layer.Layer">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.layer.</code><code class="sig-name descname">Layer</code><a class="reference internal" href="_modules/city_model_structure/layer.html#Layer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.layer.Layer" title="Permalink to this definition"></a></dt>
<dd><p>Layer class</p>
<dl class="py method">
<dt id="city_model_structure.layer.Layer.material">
<em class="property">property </em><code class="sig-name descname">material</code><a class="headerlink" href="#city_model_structure.layer.Layer.material" title="Permalink to this definition"></a></dt>
<dd><p>Get layer material
:return: Material</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.layer.Layer.thickness">
<em class="property">property </em><code class="sig-name descname">thickness</code><a class="headerlink" href="#city_model_structure.layer.Layer.thickness" title="Permalink to this definition"></a></dt>
<dd><p>Get layer thickness in meters
:return: float</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.material">
<span id="material"></span><h2>Material<a class="headerlink" href="#module-city_model_structure.material" title="Permalink to this headline"></a></h2>
<p>Material module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.material.Material">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.material.</code><code class="sig-name descname">Material</code><a class="reference internal" href="_modules/city_model_structure/material.html#Material"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.material.Material" title="Permalink to this definition"></a></dt>
<dd><p>Material class</p>
<dl class="py method">
<dt id="city_model_structure.material.Material.conductivity">
<em class="property">property </em><code class="sig-name descname">conductivity</code><a class="headerlink" href="#city_model_structure.material.Material.conductivity" title="Permalink to this definition"></a></dt>
<dd><p>Get material conductivity in W/mK
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.density">
<em class="property">property </em><code class="sig-name descname">density</code><a class="headerlink" href="#city_model_structure.material.Material.density" title="Permalink to this definition"></a></dt>
<dd><p>Get material density in kg/m3
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.no_mass">
<em class="property">property </em><code class="sig-name descname">no_mass</code><a class="headerlink" href="#city_model_structure.material.Material.no_mass" title="Permalink to this definition"></a></dt>
<dd><p>Get material no mass flag
:return: Boolean</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.solar_absorptance">
<em class="property">property </em><code class="sig-name descname">solar_absorptance</code><a class="headerlink" href="#city_model_structure.material.Material.solar_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get material solar absorptance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.specific_heat">
<em class="property">property </em><code class="sig-name descname">specific_heat</code><a class="headerlink" href="#city_model_structure.material.Material.specific_heat" title="Permalink to this definition"></a></dt>
<dd><p>Get material conductivity in J/kgK
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.thermal_absorptance">
<em class="property">property </em><code class="sig-name descname">thermal_absorptance</code><a class="headerlink" href="#city_model_structure.material.Material.thermal_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get material thermal absorptance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.thermal_resistance">
<em class="property">property </em><code class="sig-name descname">thermal_resistance</code><a class="headerlink" href="#city_model_structure.material.Material.thermal_resistance" title="Permalink to this definition"></a></dt>
<dd><p>Get material thermal resistance in m2K/W
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.material.Material.visible_absorptance">
<em class="property">property </em><code class="sig-name descname">visible_absorptance</code><a class="headerlink" href="#city_model_structure.material.Material.visible_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get material visible absorptance
:return: float</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.polyhedron">
<span id="polyhedron"></span><h2>Polyhedron<a class="headerlink" href="#module-city_model_structure.polyhedron" title="Permalink to this headline"></a></h2>
<p>Polyhedron module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.polyhedron.Polyhedron">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.polyhedron.</code><code class="sig-name descname">Polyhedron</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surfaces</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/polyhedron.html#Polyhedron"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron class</p>
Add the building/city_objects hierarchy to the city
2020-06-16 16:19:14 -04:00
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.centroid">
<em class="property">property </em><code class="sig-name descname">centroid</code><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.centroid" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron centroid
:return: [x,y,z]</p>
</dd></dl>
Add the building/city_objects hierarchy to the city
2020-06-16 15:34:35 -04:00
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.export">
<code class="sig-name descname">export</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">full_path</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/polyhedron.html#Polyhedron.export"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.export" title="Permalink to this definition"></a></dt>
<dd><p>Export the polyhedron to stl given file
:param full_path: str
:return: None</p>
</dd></dl>
Add project documentation
2020-06-15 11:38:18 -04:00
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.faces">
<em class="property">property </em><code class="sig-name descname">faces</code><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.faces" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron faces
:return: np.ndarray([int])</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.max_z">
<em class="property">property </em><code class="sig-name descname">max_z</code><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.max_z" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron maximal z value
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.vertices">
<em class="property">property </em><code class="sig-name descname">vertices</code><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.vertices" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron vertices
:return: np.ndarray(int)</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.polyhedron.Polyhedron.volume">
<em class="property">property </em><code class="sig-name descname">volume</code><a class="headerlink" href="#city_model_structure.polyhedron.Polyhedron.volume" title="Permalink to this definition"></a></dt>
<dd><p>Polyhedron volume in cubic meters
:return: float</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.surface">
<span id="surface"></span><h2>Surface<a class="headerlink" href="#module-city_model_structure.surface" title="Permalink to this headline"></a></h2>
<p>Surface module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.surface.Surface">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.surface.</code><code class="sig-name descname">Surface</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">coordinates</span></em>, <em class="sig-param"><span class="n">surface_type</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">swr</span><span class="o">=</span><span class="default_value">'0.2'</span></em>, <em class="sig-param"><span class="n">remove_last</span><span class="o">=</span><span class="default_value">True</span></em>, <em class="sig-param"><span class="n">is_projected</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/surface.html#Surface"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.surface.Surface" title="Permalink to this definition"></a></dt>
<dd><p>Surface class</p>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.add_shared">
<code class="sig-name descname">add_shared</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surface</span></em>, <em class="sig-param"><span class="n">intersection_area</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/surface.html#Surface.add_shared"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.surface.Surface.add_shared" title="Permalink to this definition"></a></dt>
<dd><p>Add a given surface and shared area in percent to this surface.
:param surface:
:param intersection_area:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.area">
<em class="property">property </em><code class="sig-name descname">area</code><a class="headerlink" href="#city_model_structure.surface.Surface.area" title="Permalink to this definition"></a></dt>
<dd><p>Surface area in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.area_above_ground">
<em class="property">property </em><code class="sig-name descname">area_above_ground</code><a class="headerlink" href="#city_model_structure.surface.Surface.area_above_ground" title="Permalink to this definition"></a></dt>
<dd><p>Surface area above ground in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.area_below_ground">
<em class="property">property </em><code class="sig-name descname">area_below_ground</code><a class="headerlink" href="#city_model_structure.surface.Surface.area_below_ground" title="Permalink to this definition"></a></dt>
<dd><p>Surface area below ground in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.azimuth">
<em class="property">property </em><code class="sig-name descname">azimuth</code><a class="headerlink" href="#city_model_structure.surface.Surface.azimuth" title="Permalink to this definition"></a></dt>
<dd><p>Surface azimuth in radians
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.global_irradiance_hour">
<em class="property">property </em><code class="sig-name descname">global_irradiance_hour</code><a class="headerlink" href="#city_model_structure.surface.Surface.global_irradiance_hour" title="Permalink to this definition"></a></dt>
<dd><p>Get surface global irradiance hour in Wh/m2
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.global_irradiance_month">
<em class="property">property </em><code class="sig-name descname">global_irradiance_month</code><a class="headerlink" href="#city_model_structure.surface.Surface.global_irradiance_month" title="Permalink to this definition"></a></dt>
<dd><p>Get surface global irradiance per month in Wh/m2
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.ground_points">
<em class="property">property </em><code class="sig-name descname">ground_points</code><a class="headerlink" href="#city_model_structure.surface.Surface.ground_points" title="Permalink to this definition"></a></dt>
<dd><p>Surface grounded points matrix
:return: np.ndarray</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.ground_polygon">
<em class="property">property </em><code class="sig-name descname">ground_polygon</code><a class="headerlink" href="#city_model_structure.surface.Surface.ground_polygon" title="Permalink to this definition"></a></dt>
<dd><p>Surface grounded polygon
:return: None or pyny3d.Polygon</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.inclination">
<em class="property">property </em><code class="sig-name descname">inclination</code><a class="headerlink" href="#city_model_structure.surface.Surface.inclination" title="Permalink to this definition"></a></dt>
<dd><p>Surface inclination in radians
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.intersect">
<code class="sig-name descname">intersect</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surface</span></em><span class="sig-paren">)</span> &#x2192; Optional<span class="p">[</span><a class="reference internal" href="#city_model_structure.surface.Surface" title="city_model_structure.surface.Surface">city_model_structure.surface.Surface</a><span class="p">]</span><a class="reference internal" href="_modules/city_model_structure/surface.html#Surface.intersect"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.surface.Surface.intersect" title="Permalink to this definition"></a></dt>
<dd><p>Get the intersection surface, if any, between the given surface and this surface
:param surface: Surface
:return: None or Surface</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.min_x">
<em class="property">property </em><code class="sig-name descname">min_x</code><a class="headerlink" href="#city_model_structure.surface.Surface.min_x" title="Permalink to this definition"></a></dt>
<dd><p>Surface minimal x value
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.min_y">
<em class="property">property </em><code class="sig-name descname">min_y</code><a class="headerlink" href="#city_model_structure.surface.Surface.min_y" title="Permalink to this definition"></a></dt>
<dd><p>Surface minimal y value
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.min_z">
<em class="property">property </em><code class="sig-name descname">min_z</code><a class="headerlink" href="#city_model_structure.surface.Surface.min_z" title="Permalink to this definition"></a></dt>
<dd><p>Surface minimal z value
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.name">
<em class="property">property </em><code class="sig-name descname">name</code><a class="headerlink" href="#city_model_structure.surface.Surface.name" title="Permalink to this definition"></a></dt>
<dd><p>Surface name
:return: str</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.normal">
<em class="property">property </em><code class="sig-name descname">normal</code><a class="headerlink" href="#city_model_structure.surface.Surface.normal" title="Permalink to this definition"></a></dt>
<dd><p>Surface normal vector
:return: np.ndarray</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.parent">
<code class="sig-name descname">parent</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">parent</span></em>, <em class="sig-param"><span class="n">surface_id</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/surface.html#Surface.parent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.surface.Surface.parent" title="Permalink to this definition"></a></dt>
<dd><p>Assign a city object as surface parent and a surface id
:param parent: CityObject
:param surface_id: str
:return: None</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.points">
<em class="property">property </em><code class="sig-name descname">points</code><a class="headerlink" href="#city_model_structure.surface.Surface.points" title="Permalink to this definition"></a></dt>
<dd><p>Surface point matrix
:return: np.ndarray</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.points_list">
<em class="property">property </em><code class="sig-name descname">points_list</code><a class="headerlink" href="#city_model_structure.surface.Surface.points_list" title="Permalink to this definition"></a></dt>
<dd><p>Surface point list
:return: np.ndarray</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.polygon">
<em class="property">property </em><code class="sig-name descname">polygon</code><a class="headerlink" href="#city_model_structure.surface.Surface.polygon" title="Permalink to this definition"></a></dt>
<dd><p>Surface polygon
:return: None or pyny3d.Polygon</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.projection">
<em class="property">property </em><code class="sig-name descname">projection</code><a class="headerlink" href="#city_model_structure.surface.Surface.projection" title="Permalink to this definition"></a></dt>
<dd><p>Projected surface (Z projection)
:return: Surface</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.shapely">
<em class="property">property </em><code class="sig-name descname">shapely</code><a class="headerlink" href="#city_model_structure.surface.Surface.shapely" title="Permalink to this definition"></a></dt>
<dd><p>Surface shapely (Z projection)
:return: None or pyny3d.Polygon</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.shared">
<code class="sig-name descname">shared</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surface</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/surface.html#Surface.shared"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.surface.Surface.shared" title="Permalink to this definition"></a></dt>
<dd><p>Check if given surface share some area with this surface
:param surface: Surface
:return: None</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.swr">
<em class="property">property </em><code class="sig-name descname">swr</code><a class="headerlink" href="#city_model_structure.surface.Surface.swr" title="Permalink to this definition"></a></dt>
<dd><p>Get surface short wave reflectance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.surface.Surface.type">
<em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#city_model_structure.surface.Surface.type" title="Permalink to this definition"></a></dt>
<dd><p>Surface type Ground, Wall or Roof
:return: str</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.thermal_boundary">
<span id="thermal-boundary"></span><h2>Thermal Boundary<a class="headerlink" href="#module-city_model_structure.thermal_boundary" title="Permalink to this headline"></a></h2>
<p>ThermalBoundary module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.thermal_boundary.</code><code class="sig-name descname">ThermalBoundary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surface</span></em>, <em class="sig-param"><span class="n">delimits</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/thermal_boundary.html#ThermalBoundary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary" title="Permalink to this definition"></a></dt>
<dd><p>ThermalBoundary class</p>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.area">
<em class="property">property </em><code class="sig-name descname">area</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.area" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary area in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.area_above_ground">
<em class="property">property </em><code class="sig-name descname">area_above_ground</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.area_above_ground" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary area above ground in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.area_below_ground">
<em class="property">property </em><code class="sig-name descname">area_below_ground</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.area_below_ground" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary area below ground in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.azimuth">
<em class="property">property </em><code class="sig-name descname">azimuth</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.azimuth" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary azimuth in radians
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.delimits">
<em class="property">property </em><code class="sig-name descname">delimits</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.delimits" title="Permalink to this definition"></a></dt>
<dd><p>Get the thermal zones delimited by the thermal boundary
:return: [ThermalZone]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.inclination">
<em class="property">property </em><code class="sig-name descname">inclination</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.inclination" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary inclination in radians
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.layers">
<em class="property">property </em><code class="sig-name descname">layers</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.layers" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary layers
:return: [Layers]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.outside_solar_absorptance">
<em class="property">property </em><code class="sig-name descname">outside_solar_absorptance</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.outside_solar_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary outside solar absorptance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.outside_thermal_absorptance">
<em class="property">property </em><code class="sig-name descname">outside_thermal_absorptance</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.outside_thermal_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary outside thermal absorptance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.outside_visible_absorptance">
<em class="property">property </em><code class="sig-name descname">outside_visible_absorptance</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.outside_visible_absorptance" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary outside visible absorptance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.shortwave_reflectance">
<em class="property">property </em><code class="sig-name descname">shortwave_reflectance</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.shortwave_reflectance" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary shortwave reflectance
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.thermal_openings">
<em class="property">property </em><code class="sig-name descname">thermal_openings</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.thermal_openings" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary thermal openings
:return: [ThermalOpening]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.type">
<em class="property">property </em><code class="sig-name descname">type</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.type" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary surface type
:return: str</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.u_value">
<em class="property">property </em><code class="sig-name descname">u_value</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.u_value" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary u value in W/m2K
internal and external convective coefficient in W/m2K values, can be configured at configuration.ini
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.window_area">
<em class="property">property </em><code class="sig-name descname">window_area</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.window_area" title="Permalink to this definition"></a></dt>
<dd><p>Thermal boundary window area in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_boundary.ThermalBoundary.window_ratio">
<em class="property">property </em><code class="sig-name descname">window_ratio</code><a class="headerlink" href="#city_model_structure.thermal_boundary.ThermalBoundary.window_ratio" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundary window ratio
:return: float</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.thermal_opening">
<span id="thermal-opening"></span><h2>Thermal Opening<a class="headerlink" href="#module-city_model_structure.thermal_opening" title="Permalink to this headline"></a></h2>
<p>ThermalOpening module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.thermal_opening.ThermalOpening">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.thermal_opening.</code><code class="sig-name descname">ThermalOpening</code><a class="reference internal" href="_modules/city_model_structure/thermal_opening.html#ThermalOpening"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening" title="Permalink to this definition"></a></dt>
<dd><p>ThermalOpening class</p>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.back_side_solar_transmittance_at_normal_incidence">
<em class="property">property </em><code class="sig-name descname">back_side_solar_transmittance_at_normal_incidence</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.back_side_solar_transmittance_at_normal_incidence" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening back side solar transmittance at normal incidence
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.conductivity">
<em class="property">property </em><code class="sig-name descname">conductivity</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.conductivity" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening conductivity in W/mK
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.frame_ratio">
<em class="property">property </em><code class="sig-name descname">frame_ratio</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.frame_ratio" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening frame ratio
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.front_side_solar_transmittance_at_normal_incidence">
<em class="property">property </em><code class="sig-name descname">front_side_solar_transmittance_at_normal_incidence</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.front_side_solar_transmittance_at_normal_incidence" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening front side solar transmittance at normal incidence
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.g_value">
<em class="property">property </em><code class="sig-name descname">g_value</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.g_value" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening g value
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.openable_ratio">
<em class="property">property </em><code class="sig-name descname">openable_ratio</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.openable_ratio" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening openable ratio, NOT IMPLEMENTED
:return: Exception</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.overall_u_value">
<em class="property">property </em><code class="sig-name descname">overall_u_value</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.overall_u_value" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening overall u value in W/m2K
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_opening.ThermalOpening.thickness">
<em class="property">property </em><code class="sig-name descname">thickness</code><a class="headerlink" href="#city_model_structure.thermal_opening.ThermalOpening.thickness" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal opening thickness in meters
:return:</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.thermal_zone">
<span id="thermal-zone"></span><h2>Thermal Zone<a class="headerlink" href="#module-city_model_structure.thermal_zone" title="Permalink to this headline"></a></h2>
<p>ThermalZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.thermal_zone.ThermalZone">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.thermal_zone.</code><code class="sig-name descname">ThermalZone</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">surfaces</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/city_model_structure/thermal_zone.html#ThermalZone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone" title="Permalink to this definition"></a></dt>
<dd><p>ThermalZone class</p>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.additional_thermal_bridge_u_value">
<em class="property">property </em><code class="sig-name descname">additional_thermal_bridge_u_value</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.additional_thermal_bridge_u_value" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone additional thermal bridge u value W/m2K
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.bounded">
<em class="property">property </em><code class="sig-name descname">bounded</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.bounded" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal boundaries bounding with the thermal zone
:return: [ThermalBoundary]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.cooled">
<em class="property">property </em><code class="sig-name descname">cooled</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.cooled" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone cooled flag
:return: Boolean</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.effective_thermal_capacity">
<em class="property">property </em><code class="sig-name descname">effective_thermal_capacity</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.effective_thermal_capacity" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone effective thermal capacity
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.floor_area">
<em class="property">property </em><code class="sig-name descname">floor_area</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.floor_area" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone floor area in square meters
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.heated">
<em class="property">property </em><code class="sig-name descname">heated</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.heated" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone heated flag
:return: Boolean</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.indirectly_heated_area_ratio">
<em class="property">property </em><code class="sig-name descname">indirectly_heated_area_ratio</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.indirectly_heated_area_ratio" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone indirectly heated area ratio
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_off">
<em class="property">property </em><code class="sig-name descname">infiltration_rate_system_off</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_off" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone infiltration rate system off in air changes per hour
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_on">
<em class="property">property </em><code class="sig-name descname">infiltration_rate_system_on</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.infiltration_rate_system_on" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone infiltration rate system on in air changes per hour
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.surfaces">
<em class="property">property </em><code class="sig-name descname">surfaces</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.surfaces" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone surfaces
:return: [Surface]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.thermal_zone.ThermalZone.usage_zones">
<em class="property">property </em><code class="sig-name descname">usage_zones</code><a class="headerlink" href="#city_model_structure.thermal_zone.ThermalZone.usage_zones" title="Permalink to this definition"></a></dt>
<dd><p>Get thermal zone usage zones
:return: [UsageZone]</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-city_model_structure.usage_zone">
<span id="usage-zone"></span><h2>Usage Zone<a class="headerlink" href="#module-city_model_structure.usage_zone" title="Permalink to this headline"></a></h2>
<p>UsageZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="city_model_structure.usage_zone.UsageZone">
<em class="property">class </em><code class="sig-prename descclassname">city_model_structure.usage_zone.</code><code class="sig-name descname">UsageZone</code><a class="reference internal" href="_modules/city_model_structure/usage_zone.html#UsageZone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone" title="Permalink to this definition"></a></dt>
<dd><p>UsageZone class</p>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.cooling_setpoint">
<em class="property">property </em><code class="sig-name descname">cooling_setpoint</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.cooling_setpoint" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone cooling setpoint in celsius grads
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.days_year">
<em class="property">property </em><code class="sig-name descname">days_year</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.days_year" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone usage days per year
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.heating_setback">
<em class="property">property </em><code class="sig-name descname">heating_setback</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.heating_setback" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone heating setback in celsius grads
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.heating_setpoint">
<em class="property">property </em><code class="sig-name descname">heating_setpoint</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.heating_setpoint" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone heating set point in celsius grads
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.hours_day">
<em class="property">property </em><code class="sig-name descname">hours_day</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.hours_day" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone usage hours per day
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.internal_gains">
<em class="property">property </em><code class="sig-name descname">internal_gains</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.internal_gains" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone internal gains
:return: [InternalGains]</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.mechanical_air_change">
<em class="property">property </em><code class="sig-name descname">mechanical_air_change</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.mechanical_air_change" title="Permalink to this definition"></a></dt>
<dd><p>Set usage zone mechanical air change in air change per hour
:return: float</p>
</dd></dl>
<dl class="py method">
<dt id="city_model_structure.usage_zone.UsageZone.usage">
<em class="property">property </em><code class="sig-name descname">usage</code><a class="headerlink" href="#city_model_structure.usage_zone.UsageZone.usage" title="Permalink to this definition"></a></dt>
<dd><p>Get usage zone usage
:return: str</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="section" id="factories">
<h1>Factories<a class="headerlink" href="#factories" title="Permalink to this headline"></a></h1>
<div class="section" id="module-geometry.geometry_factory">
<span id="geometry-factory"></span><h2>Geometry Factory<a class="headerlink" href="#module-geometry.geometry_factory" title="Permalink to this headline"></a></h2>
<p>GeometryFactory retrieve the specific geometric module to load the given format
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="geometry.geometry_factory.GeometryFactory">
<em class="property">class </em><code class="sig-prename descclassname">geometry.geometry_factory.</code><code class="sig-name descname">GeometryFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">file_type</span></em>, <em class="sig-param"><span class="n">path</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/geometry/geometry_factory.html#GeometryFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#geometry.geometry_factory.GeometryFactory" title="Permalink to this definition"></a></dt>
<dd><p>GeometryFactory class</p>
<dl class="py method">
<dt id="geometry.geometry_factory.GeometryFactory.city">
<em class="property">property </em><code class="sig-name descname">city</code><a class="headerlink" href="#geometry.geometry_factory.GeometryFactory.city" title="Permalink to this definition"></a></dt>
<dd><p>Load the city model structure from a geometry source
:return: City</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-physics.physics_factory">
<span id="physics-factory"></span><h2>Physics Factory<a class="headerlink" href="#module-physics.physics_factory" title="Permalink to this headline"></a></h2>
<p>PhysicsFactory retrieve the specific physics module for the given region
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="physics.physics_factory.PhysicsFactory">
<em class="property">class </em><code class="sig-prename descclassname">physics.physics_factory.</code><code class="sig-name descname">PhysicsFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">city</span></em>, <em class="sig-param"><span class="n">base_path</span><span class="o">=</span><span class="default_value">'data/physics'</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/physics/physics_factory.html#PhysicsFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#physics.physics_factory.PhysicsFactory" title="Permalink to this definition"></a></dt>
<dd><p>PhysicsFactor class</p>
<dl class="py method">
<dt id="physics.physics_factory.PhysicsFactory.factory">
<code class="sig-name descname">factory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/physics/physics_factory.html#PhysicsFactory.factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#physics.physics_factory.PhysicsFactory.factory" title="Permalink to this definition"></a></dt>
<dd><p>Enrich the city with the physics information
:return: None</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-usage.usage_factory">
<span id="usage-factory"></span><h2>Usage Factory<a class="headerlink" href="#module-usage.usage_factory" title="Permalink to this headline"></a></h2>
<p>UsageFactory retrieve the specific usage module for the given region
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez <a class="reference external" href="mailto:guillermo&#46;gutierrezmorote&#37;&#52;&#48;concordia&#46;ca">guillermo<span>&#46;</span>gutierrezmorote<span>&#64;</span>concordia<span>&#46;</span>ca</a></p>
<dl class="py class">
<dt id="usage.usage_factory.UsageFactory">
<em class="property">class </em><code class="sig-prename descclassname">usage.usage_factory.</code><code class="sig-name descname">UsageFactory</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">handler</span></em>, <em class="sig-param"><span class="n">city</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/usage/usage_factory.html#UsageFactory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#usage.usage_factory.UsageFactory" title="Permalink to this definition"></a></dt>
<dd><p>UsageFactory class</p>
<dl class="py method">
<dt id="usage.usage_factory.UsageFactory.factory">
<code class="sig-name descname">factory</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/usage/usage_factory.html#UsageFactory.factory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#usage.usage_factory.UsageFactory.factory" title="Permalink to this definition"></a></dt>
<dd><p>Enrich the city with the usage information
:return: None</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="section" id="additional-files">
<h1>Additional Files<a class="headerlink" href="#additional-files" title="Permalink to this headline"></a></h1>
<p><a class="reference download internal" download="" href="_downloads/e1ab89a34fbe66ed8839d64f1e448e11/README.md"><code class="xref download docutils literal notranslate"><span class="pre">README.md</span></code></a>
<a class="reference download internal" download="" href="_downloads/45c67e110fdd21d2beb01832b61177ec/LICENSE.md"><code class="xref download docutils literal notranslate"><span class="pre">LICENSE.md</span></code></a>
<a class="reference download internal" download="" href="_downloads/2e7955674502227d52eac12f33460c6c/CODE_OF_CONDUCT.md"><code class="xref download docutils literal notranslate"><span class="pre">CODE_OF_CONDUCT.md</span></code></a>
<a class="reference download internal" download="" href="_downloads/13a3f69333aa9b7801ffb3c647ab96e3/CONTRIBUTING.md"><code class="xref download docutils literal notranslate"><span class="pre">CONTRIBUTING.md</span></code></a>
<a class="reference download internal" download="" href="_downloads/a6997596463e84fde618c07830426201/PYGUIDE.md"><code class="xref download docutils literal notranslate"><span class="pre">PYGUIDE.md</span></code></a></p>
</div>
</div>
<div class="page-nav">
<div class="inner"><ul class="page-nav">
</ul><div class="footer" role="contentinfo">
&#169; Copyright 2020, Guillermo Gutierrez.
<br>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.1 with <a href="https://github.com/schettino72/sphinx_press_theme">Press Theme</a>.
</div>
</div>
</div>
</page>
</div>
</body>
</html>
Reference in New Issue Copy Permalink