-
Notifications
You must be signed in to change notification settings - Fork 0
/
dibs_computing_core.iso_simulator.data_source.html
240 lines (210 loc) · 19.3 KB
/
dibs_computing_core.iso_simulator.data_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dibs_computing_core.iso_simulator.data_source package — Dibs Documentation 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=8d563738"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="dibs_computing_core.iso_simulator.exceptions package" href="dibs_computing_core.iso_simulator.exceptions.html" />
<link rel="prev" title="dibs_computing_core.iso_simulator.building_simulator package" href="dibs_computing_core.iso_simulator.building_simulator.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Dibs Documentation
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">src</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="dibs_computing_core.html">dibs_computing_core package</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="dibs_computing_core.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="dibs_computing_core.iso_simulator.html">dibs_computing_core.iso_simulator package</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="dibs_computing_core.html#module-dibs_computing_core">Module contents</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Dibs Documentation</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">src</a></li>
<li class="breadcrumb-item"><a href="dibs_computing_core.html">dibs_computing_core package</a></li>
<li class="breadcrumb-item"><a href="dibs_computing_core.iso_simulator.html">dibs_computing_core.iso_simulator package</a></li>
<li class="breadcrumb-item active">dibs_computing_core.iso_simulator.data_source package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/dibs_computing_core.iso_simulator.data_source.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="dibs-computing-core-iso-simulator-data-source-package">
<h1>dibs_computing_core.iso_simulator.data_source package<a class="headerlink" href="#dibs-computing-core-iso-simulator-data-source-package" title="Link to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-dibs_computing_core.iso_simulator.data_source.datasource">
<span id="dibs-computing-core-iso-simulator-data-source-datasource-module"></span><h2>dibs_computing_core.iso_simulator.data_source.datasource module<a class="headerlink" href="#module-dibs_computing_core.iso_simulator.data_source.datasource" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dibs_computing_core.iso_simulator.data_source.datasource.</span></span><span class="sig-name descname"><span class="pre">DataSource</span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<p>This interface provides several methods that can be implemented in other classes</p>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.choose_and_get_the_right_weather_data_from_path">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">choose_and_get_the_right_weather_data_from_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.weather_data.WeatherData" title="dibs_computing_core.iso_simulator.model.weather_data.WeatherData"><span class="pre">WeatherData</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.choose_and_get_the_right_weather_data_from_path" title="Link to this definition"></a></dt>
<dd><p>This method retrieves the right weather data
Args:
Returns:</p>
<blockquote>
<div><p>weather_data_objects</p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_epw_file">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_epw_file</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.epw_file.EPWFile" title="dibs_computing_core.iso_simulator.model.epw_file.EPWFile"><span class="pre">EPWFile</span></a></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_epw_file" title="Link to this definition"></a></dt>
<dd><p>Function finds the epw file depending on building location, Pick latitude and longitude from plz_data and put
values into a list and Calculate minimum distance to next weather station
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>epw_file object</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_epw_pe_factors">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_epw_pe_factors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.primary_energy_and_emission_factors.PrimaryEnergyAndEmissionFactor" title="dibs_computing_core.iso_simulator.model.primary_energy_and_emission_factors.PrimaryEnergyAndEmissionFactor"><span class="pre">PrimaryEnergyAndEmissionFactor</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_epw_pe_factors" title="Link to this definition"></a></dt>
<dd><p>This method retrieves all primary energy and emission factors
Returns:</p>
<blockquote>
<div><p>epw_pe_factors</p>
</div></blockquote>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_gains">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_gains</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_gains" title="Link to this definition"></a></dt>
<dd><p>Find data from DIN V 18599-10 or SIA2024
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>gain_person_and_typ_norm, appliance_gains</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_schedule">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_schedule</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.schedule_name.ScheduleName" title="dibs_computing_core.iso_simulator.model.schedule_name.ScheduleName"><span class="pre">ScheduleName</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="dibs_computing_core.iso_simulator.exceptions.html#dibs_computing_core.iso_simulator.exceptions.uk_or_hk_exception.HkOrUkNotFoundError" title="dibs_computing_core.iso_simulator.exceptions.uk_or_hk_exception.HkOrUkNotFoundError"><span class="pre">HkOrUkNotFoundError</span></a></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_schedule" title="Link to this definition"></a></dt>
<dd><p>Find occupancy schedule from SIA2024, depending on hk_geb, uk_geb
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>schedule_name_list, schedule_name or throws an error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_tek">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_tek</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="dibs_computing_core.iso_simulator.exceptions.html#dibs_computing_core.iso_simulator.exceptions.uk_or_hk_exception.HkOrUkNotFoundError" title="dibs_computing_core.iso_simulator.exceptions.uk_or_hk_exception.HkOrUkNotFoundError"><span class="pre">HkOrUkNotFoundError</span></a></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_tek" title="Link to this definition"></a></dt>
<dd><p>Find TEK values from Partial energy parameters to build the comparative values in accordance with the
announcement of 15.04.2021 on the Building Energy Act (GEG) of 2020, depending on hk_geb, uk_geb
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>tek_dhw, tek_name or throws an error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_usage_time">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_usage_time</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="dibs_computing_core.iso_simulator.exceptions.html#dibs_computing_core.iso_simulator.exceptions.usage_time_exception.UsageTimeError" title="dibs_computing_core.iso_simulator.exceptions.usage_time_exception.UsageTimeError"><span class="pre">UsageTimeError</span></a></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_usage_time" title="Link to this definition"></a></dt>
<dd><p>Find building’s usage time DIN 18599-10 or SIA2024
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>usage_start, usage_end or throws error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_user_building">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_user_building</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.building.Building" title="dibs_computing_core.iso_simulator.model.building.Building"><span class="pre">Building</span></a></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_user_building" title="Link to this definition"></a></dt>
<dd><p>This method retrieves the building to be simulated.
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>building</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_user_buildings">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_user_buildings</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="dibs_computing_core.iso_simulator.model.html#dibs_computing_core.iso_simulator.model.building.Building" title="dibs_computing_core.iso_simulator.model.building.Building"><span class="pre">Building</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#dibs_computing_core.iso_simulator.data_source.datasource.DataSource.get_user_buildings" title="Link to this definition"></a></dt>
<dd><p>This method retrieves all the building to be simulated.
Args:</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>building</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-dibs_computing_core.iso_simulator.data_source">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-dibs_computing_core.iso_simulator.data_source" title="Link to this heading"></a></h2>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="dibs_computing_core.iso_simulator.building_simulator.html" class="btn btn-neutral float-left" title="dibs_computing_core.iso_simulator.building_simulator package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="dibs_computing_core.iso_simulator.exceptions.html" class="btn btn-neutral float-right" title="dibs_computing_core.iso_simulator.exceptions package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, IWUGERMANY.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>