Skip to content

Commit

Permalink
Update 'docs' folder with main and delete old branches.
Browse files Browse the repository at this point in the history
  • Loading branch information
FWuellhorst committed Oct 26, 2023
1 parent 2846466 commit 9b30317
Show file tree
Hide file tree
Showing 24 changed files with 472 additions and 5,948 deletions.
Binary file modified docs/main/docs/.doctrees/Contribution.doctree
Binary file not shown.
Binary file modified docs/main/docs/.doctrees/code/aixweather.doctree
Binary file not shown.
Binary file modified docs/main/docs/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file modified docs/main/docs/.doctrees/index.doctree
Binary file not shown.
8 changes: 5 additions & 3 deletions docs/main/docs/Contribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,11 @@ <h1>Contribute as a developer<a class="headerlink" href="#contribute-as-a-develo
<p>Please also raise an issue and create a new branch labeled <code class="docutils literal notranslate"><span class="pre">issueNR_issueName</span></code>.</p>
<p>Once your feature is ready, create a pull request and check if the pipeline succeeds.
Assign a reviewer before merging. Once the review is finished, you can merge.</p>
<p>Please note that the main branch is used in the WebApp and should always be synced with PyPi.
Pull requests should merge into the development first.
Every merge of the development to the main branch must result in a PyPi release.</p>
<p>Please note that the main branch is used in the WebApp and therefore changes here must be in
line with the current version of the WebApp. Updates to the main branch that affect
functionalities require therefore a PYPI RELEASE. The VM that hosts the WebApp must be updated.
Pull requests should merge into the development first. The development branch contains a working
version which can be functionally ahead of the WebApp.</p>
<p><strong>Before</strong> implementing or modifying modules, classes or functions, please read the following page.</p>
<section id="styleguide">
<h2>Styleguide<a class="headerlink" href="#styleguide" title="Permalink to this heading"></a></h2>
Expand Down
12 changes: 12 additions & 0 deletions docs/main/docs/_modules/aixweather/data_quality_checks.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,15 @@ <h1>Source code for aixweather.data_quality_checks</h1><div class="highlight"><p


<div class="viewcode-block" id="plot_heatmap_missing_values_daily"><a class="viewcode-back" href="../../code/aixweather.html#aixweather.data_quality_checks.plot_heatmap_missing_values_daily">[docs]</a><span class="k">def</span> <span class="nf">plot_heatmap_missing_values_daily</span><span class="p">(</span><span class="n">df</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Generate a heatmap to visualize daily missing values in a DataFrame.</span>

<span class="sd"> Args:</span>
<span class="sd"> df (pd.DataFrame): The DataFrame to be analyzed for missing values.</span>

<span class="sd"> Returns:</span>
<span class="sd"> plt: A Matplotlib figure representing the heatmap of missing values.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># Group by day and check for any missing values for each day</span>
<span class="n">missing_data</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">resample</span><span class="p">(</span><span class="s2">&quot;D&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">apply</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="n">x</span><span class="o">.</span><span class="n">isnull</span><span class="p">()</span><span class="o">.</span><span class="n">any</span><span class="p">())</span>

Expand All @@ -192,6 +201,9 @@ <h1>Source code for aixweather.data_quality_checks</h1><div class="highlight"><p


<div class="viewcode-block" id="print_df_info"><a class="viewcode-back" href="../../code/aixweather.html#aixweather.data_quality_checks.print_df_info">[docs]</a><span class="k">def</span> <span class="nf">print_df_info</span><span class="p">(</span><span class="n">df</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> prints df info for intermediate checks or debugging</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">info</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">info</span><span class="p">()</span>
<span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span></div>
</pre></div>
Expand Down
9 changes: 8 additions & 1 deletion docs/main/docs/_modules/aixweather/definitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,11 @@
<div itemprop="articleBody">

<h1>Source code for aixweather.definitions</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">os</span>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">This module includes variables or functions which define central variables for the whole project.</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">import</span> <span class="nn">os</span>

<span class="c1"># format of the core_data</span>
<span class="c1"># time of measurement is always at indicated time</span>
Expand Down Expand Up @@ -207,6 +211,9 @@ <h1>Source code for aixweather.definitions</h1><div class="highlight"><pre>
<span class="n">local_folder_temp</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">ROOT_DIR</span><span class="p">,</span> <span class="s2">&quot;temp_local&quot;</span><span class="p">)</span>

<div class="viewcode-block" id="result_folder_path"><a class="viewcode-back" href="../../code/aixweather.html#aixweather.definitions.result_folder_path">[docs]</a><span class="k">def</span> <span class="nf">result_folder_path</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates the path to the resultsfolder.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">folder_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="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">ROOT_DIR</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;results&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">folder_path</span></div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ <h1>Source code for aixweather.imports.custom_file</h1><div class="highlight"><p
<span class="c1">### convert timestamp to datetime and set as index</span>

<span class="c1">### return data frame</span>
<span class="k">return</span></div>
<span class="k">return</span> <span class="s2">&quot;DataFrame&quot;</span></div>
</pre></div>

</div>
Expand Down
Loading

0 comments on commit 9b30317

Please sign in to comment.