Skip to content

Commit

Permalink
Update 'docs' folder with development and delete old branches.
Browse files Browse the repository at this point in the history
  • Loading branch information
FWuellhorst committed Jan 18, 2024
1 parent 2d79d11 commit 1b339f8
Show file tree
Hide file tree
Showing 17 changed files with 131 additions and 41 deletions.
Binary file not shown.
Binary file modified docs/development/docs/.doctrees/environment.pickle
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,18 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_epw_energyplus<

<span class="kn">import</span> <span class="nn">csv</span>
<span class="kn">import</span> <span class="nn">datetime</span> <span class="k">as</span> <span class="nn">dt</span>
<span class="kn">import</span> <span class="nn">logging</span>

<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>

<span class="kn">from</span> <span class="nn">aixweather</span> <span class="kn">import</span> <span class="n">definitions</span>
<span class="kn">from</span> <span class="nn">aixweather.imports.utils_import</span> <span class="kn">import</span> <span class="n">MetaData</span>
<span class="kn">from</span> <span class="nn">aixweather.transformation_functions</span> <span class="kn">import</span> <span class="n">auxiliary</span><span class="p">,</span> <span class="n">time_observation_transformations</span><span class="p">,</span> <span class="n">pass_through_handling</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">format_epw information:</span>
<span class="sd">for links see readme</span>
Expand Down Expand Up @@ -454,9 +459,9 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_epw_energyplus<
<span class="p">)</span>
<span class="k">return</span> <span class="n">ground_temp</span>
<span class="k">except</span> <span class="ne">KeyError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span>
<span class="sa">f</span><span class="s2">&quot;For adding the probably unnecessary ground temperature to the .epw file header, &quot;</span>
<span class="sa">f</span><span class="s2">&quot;the following made it impossible: </span><span class="si">{</span><span class="n">err</span><span class="si">}</span><span class="s2">&quot;</span>
<span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span>
<span class="s2">&quot;Error while adding the probably unnecessary ground temperature to the .epw file &quot;</span>
<span class="s2">&quot;header. A placeholder will be used. Error: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">err</span>
<span class="p">)</span>
<span class="n">ground_temp</span> <span class="o">=</span> <span class="n">ground_temp</span> <span class="o">+</span> <span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># 0 ground layers</span>

Expand Down Expand Up @@ -702,7 +707,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_epw_energyplus<
<span class="n">df_as_list</span><span class="p">,</span> <span class="n">df</span> <span class="o">=</span> <span class="n">format_data</span><span class="p">(</span><span class="n">df</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">)</span>
<span class="n">writer</span><span class="o">.</span><span class="n">writerows</span><span class="p">(</span><span class="n">df_as_list</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;EPW file saved to </span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;EPW file saved to </span><span class="si">%s</span><span class="s2">.&quot;</span><span class="p">,</span> <span class="n">file_path</span><span class="p">)</span>

<span class="k">return</span> <span class="n">df</span></div>
</pre></div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_mos_TMY3</h1><d
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Converts core data to modelica TMY3Reader data</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">calendar</span>
<span class="kn">import</span> <span class="nn">datetime</span> <span class="k">as</span> <span class="nn">dt</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
Expand All @@ -90,6 +90,9 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_mos_TMY3</h1><d
<span class="kn">from</span> <span class="nn">aixweather.imports.utils_import</span> <span class="kn">import</span> <span class="n">MetaData</span>
<span class="kn">from</span> <span class="nn">aixweather.transformation_functions</span> <span class="kn">import</span> <span class="n">auxiliary</span><span class="p">,</span> <span class="n">time_observation_transformations</span><span class="p">,</span> <span class="n">pass_through_handling</span>


<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>

<span class="sd">&quot;&quot;&quot;</span>
<span class="sd">format_modelica_TMY3 information:</span>

Expand Down Expand Up @@ -331,7 +334,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.to_mos_TMY3</h1><d
<span class="n">file</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">file</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">header_of</span><span class="si">}</span><span class="se">\n</span><span class="si">{</span><span class="n">content</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;MOS file saved to </span><span class="si">{</span><span class="n">filepath</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;MOS file saved to </span><span class="si">%s</span><span class="s2">.&quot;</span><span class="p">,</span> <span class="n">filepath</span><span class="p">)</span>
<span class="k">return</span> <span class="n">df</span></div>
</pre></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.unconverted_to_x</
<span class="sd">converts core data to different simpler formats (currently without any transformation)</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">pickle</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
Expand All @@ -90,6 +91,9 @@ <h1>Source code for aixweather.core_data_format_2_output_file.unconverted_to_x</
<span class="kn">from</span> <span class="nn">aixweather.imports.utils_import</span> <span class="kn">import</span> <span class="n">MetaData</span>


<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="to_pickle"><a class="viewcode-back" href="../../../code/aixweather.core_data_format_2_output_file.html#aixweather.core_data_format_2_output_file.unconverted_to_x.to_pickle">[docs]</a><span class="k">def</span> <span class="nf">to_pickle</span><span class="p">(</span>
<span class="n">core_df</span><span class="p">:</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">,</span>
<span class="n">meta</span><span class="p">:</span> <span class="n">MetaData</span><span class="p">,</span>
Expand All @@ -115,7 +119,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.unconverted_to_x</
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">meta_file_path</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">pickle</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">meta</span><span class="p">,</span> <span class="n">file</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Pickle saved to </span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">, meta information saved to </span><span class="si">{</span><span class="n">meta_file_path</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Pickle saved to </span><span class="si">%s</span><span class="s2">, meta information saved to </span><span class="si">%s</span><span class="s2">.&quot;</span><span class="p">,</span> <span class="n">file_path</span><span class="p">,</span> <span class="n">meta_file_path</span><span class="p">)</span>

<span class="k">return</span> <span class="n">core_df</span></div>

Expand Down Expand Up @@ -150,7 +154,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.unconverted_to_x</
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">meta_file_path</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">meta_dict</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;JSON saved to </span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">, meta information saved to </span><span class="si">{</span><span class="n">meta_file_path</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;JSON saved to </span><span class="si">%s</span><span class="s2">, meta information saved to </span><span class="si">%s</span><span class="s2">.&quot;</span><span class="p">,</span> <span class="n">file_path</span><span class="p">,</span> <span class="n">meta_file_path</span><span class="p">)</span>

<span class="k">return</span> <span class="n">core_df</span></div>

Expand Down Expand Up @@ -184,7 +188,7 @@ <h1>Source code for aixweather.core_data_format_2_output_file.unconverted_to_x</
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">meta_file_path</span><span class="p">,</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">file</span><span class="p">:</span>
<span class="n">json</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="n">meta_dict</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">indent</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;CSV saved to </span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">, meta information saved to </span><span class="si">{</span><span class="n">meta_file_path</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;CSV saved to </span><span class="si">%s</span><span class="s2">, meta information saved to </span><span class="si">%s</span><span class="s2">.&quot;</span><span class="p">,</span> <span class="n">file_path</span><span class="p">,</span> <span class="n">meta_file_path</span><span class="p">)</span>

<span class="k">return</span> <span class="n">core_df</span></div>
</pre></div>
Expand Down
7 changes: 5 additions & 2 deletions docs/development/docs/_modules/aixweather/imports/DWD.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h1>Source code for aixweather.imports.DWD</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">imports weather data from the DWD</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">zipfile</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">shutil</span>
Expand All @@ -93,6 +93,9 @@ <h1>Source code for aixweather.imports.DWD</h1><div class="highlight"><pre>
<span class="kn">from</span> <span class="nn">aixweather</span> <span class="kn">import</span> <span class="n">definitions</span>


<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="import_DWD_historical"><a class="viewcode-back" href="../../../code/aixweather.imports.html#aixweather.imports.DWD.import_DWD_historical">[docs]</a><span class="k">def</span> <span class="nf">import_DWD_historical</span><span class="p">(</span><span class="n">start</span><span class="p">:</span> <span class="n">dt</span><span class="o">.</span><span class="n">datetime</span><span class="p">,</span> <span class="n">station</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Pull historical data from DWD:</span>
Expand Down Expand Up @@ -428,7 +431,7 @@ <h1>Source code for aixweather.imports.DWD</h1><div class="highlight"><pre>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">4</span><span class="p">):</span> <span class="c1"># try retrieval 3 times</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">urllib</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">urlretrieve</span><span class="p">(</span><span class="n">url</span> <span class="o">+</span> <span class="n">zip_name</span><span class="p">,</span> <span class="n">total_zip_name</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Loaded: </span><span class="si">{</span><span class="n">total_zip_name</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Loaded: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">total_zip_name</span><span class="p">)</span>

<span class="c1"># save unzipped files to folder_unzip</span>
<span class="n">extract_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">definitions</span><span class="o">.</span><span class="n">local_folder_temp</span><span class="p">,</span> <span class="n">folder_unzip</span><span class="p">)</span>
Expand Down
Loading

0 comments on commit 1b339f8

Please sign in to comment.