Update 'docs' folder with _fix_coverage and delete old branches.

RWTH-EBC · Dec 4, 2023 · 2bbf96b · 2bbf96b
1 parent fcdbaec
commit 2bbf96b
Show file tree

Hide file tree

Showing 143 changed files with 42,183 additions and 0 deletions.
diff --git a/docs/_fix_coverage/build/build.svg b/docs/_fix_coverage/build/build.svg
diff --git a/docs/_fix_coverage/docs/.buildinfo b/docs/_fix_coverage/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: ee6ed4ac1603b1baffe69c43606c34d8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_fix_coverage/docs/.doctrees/Contribution.doctree b/docs/_fix_coverage/docs/.doctrees/Contribution.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/modules.doctree b/docs/_fix_coverage/docs/.doctrees/code/modules.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.compressors.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.compressors.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.expansion_valves.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.expansion_valves.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.heat_exchangers.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.components.heat_exchangers.doctree
diff --git a/...fix_coverage/docs/.doctrees/code/vclibpy.components.heat_exchangers.heat_transfer.doctree b/...fix_coverage/docs/.doctrees/code/vclibpy.components.heat_exchangers.heat_transfer.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.flowsheets.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.flowsheets.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.media.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.media.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/code/vclibpy.utils.doctree b/docs/_fix_coverage/docs/.doctrees/code/vclibpy.utils.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/environment.pickle b/docs/_fix_coverage/docs/.doctrees/environment.pickle
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e1_refrigerant_data.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e1_refrigerant_data.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e2_compressor.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e2_compressor.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e3_inputs_and_flowsheet_state.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e3_inputs_and_flowsheet_state.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e4_heat_exchanger.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e4_heat_exchanger.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e5_expansion_valve.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e5_expansion_valve.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e6_simple_heat_pump.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e6_simple_heat_pump.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/examples/e7_vapor_injection.doctree b/docs/_fix_coverage/docs/.doctrees/examples/e7_vapor_injection.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/index.doctree b/docs/_fix_coverage/docs/.doctrees/index.doctree
diff --git a/docs/_fix_coverage/docs/.doctrees/version_his.doctree b/docs/_fix_coverage/docs/.doctrees/version_his.doctree
diff --git a/docs/_fix_coverage/docs/.nojekyll b/docs/_fix_coverage/docs/.nojekyll
diff --git a/docs/_fix_coverage/docs/Contribution.html b/docs/_fix_coverage/docs/Contribution.html
@@ -0,0 +1,177 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Contribute as a user &mdash; vclibpy 0.1.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
+      <link rel="stylesheet" type="text/css" href="_static/autodoc_pydantic.css" />
+
+
+  <!--[if lt IE 9]>
+    <script src="_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="_static/jquery.js"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
+        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+        <script src="_static/doctools.js"></script>
+        <script src="_static/sphinx_highlight.js"></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="Version History" href="version_his.html" />
+    <link rel="prev" title="vclibpy.utils package" href="code/vclibpy.utils.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">
+            vclibpy
+          </a>
+              <div class="version">
+                0.1
+              </div>
+<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">
+              <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="code/modules.html">vclibpy</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Contribute as a user</a></li>
+<li class="toctree-l1"><a class="reference internal" href="#contribute-as-a-developer">Contribute as a developer</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#styleguide">Styleguide</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#unit-tests">Unit-Tests</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#pylint">Pylint</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="version_his.html">Version History</a></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">vclibpy</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 active">Contribute as a user</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="_sources/Contribution.md.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="contribute-as-a-user">
+<h1>Contribute as a user<a class="headerlink" href="#contribute-as-a-user" title="Permalink to this heading"></a></h1>
+<p>The documentation, examples and tutorials should be understandable and the code bug-free.
+As all user’s have different backgrounds, you may not understand everything or encounter bugs.
+In that case, PLEASE raise an issue <a class="reference external" href="https://github.com/RWTH-EBC/vclibpy/issues/new">here</a>.</p>
+<p>Consider labeling the issue using the flag <code class="docutils literal notranslate"><span class="pre">bug</span></code> or <code class="docutils literal notranslate"><span class="pre">documentation</span></code> / <code class="docutils literal notranslate"><span class="pre">question</span></code>.</p>
+</section>
+<section id="contribute-as-a-developer">
+<h1>Contribute as a developer<a class="headerlink" href="#contribute-as-a-developer" title="Permalink to this heading"></a></h1>
+<p>If you instead want to contribute new features or fix bugs yourself, we are more than happy.</p>
+<p>Please also <a class="reference external" href="https://github.com/RWTH-EBC/vclibpy/issues/new">raise an issue</a> and create a new branch labeled <code class="docutils literal notranslate"><span class="pre">issueXY_some_name</span></code>.
+Here, <code class="docutils literal notranslate"><span class="pre">XY</span></code> is the number of your issue and <code class="docutils literal notranslate"><span class="pre">some_name</span></code> is a meaingful description.</p>
+<p>Once you’re feature is ready, create a pull request and check if the pipeline succeeds.
+Assign a reviewer before merging. Once review is finished, you can merge.</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>
+<p>We use PEP8 as a styleguide. Some IDEs (like PyCharm) automatically show you code that is not in PEP8. If you don’t have such an IDE, please read <a class="reference external" href="https://pep8.org/">this page</a> to get a better understanding of it.</p>
+</section>
+<section id="documentation">
+<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h2>
+<p>All created or modified function should be documented properly. Try to follow the structure already present. If possible, write a little doctest example into the docstring to make clear to user’s what the desired output of your function is. All non self-explanatory lines of code should include a comment. We use the pycharm-style for docstrings, e.g.</p>
+<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">foo</span><span class="p">(</span><span class="n">dummy</span><span class="p">,</span> <span class="n">dummy2</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Describe what the function does in here.</span>
+<span class="sd">    The blank line below is necessary for the doc to render nicely.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        dummy (str):</span>
+<span class="sd">            Any parameter description</span>
+<span class="sd">        dummy2 (int,float):</span>
+<span class="sd">            A variable that may have two types</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+</pre></div>
+</div>
+</section>
+<section id="unit-tests">
+<h2>Unit-Tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading"></a></h2>
+<p>Espacially when creating new functions or classes, you have to add a unit-test function.
+Open the <code class="docutils literal notranslate"><span class="pre">test_module.py</span></code> file in the <code class="docutils literal notranslate"><span class="pre">\tests</span></code>-directory and add a function to the class <code class="docutils literal notranslate"><span class="pre">TestModule</span></code>with a name like <code class="docutils literal notranslate"><span class="pre">test_my_new_function</span></code>. If you create a new module, you have to create a new <code class="docutils literal notranslate"><span class="pre">test_my_new_module.py</span></code> file and follow the existing structure of the
+other test-files.</p>
+<p>If you are not familiar with unit-tests, here is a quick summary:</p>
+<ul class="simple">
+<li><p>Test as many things as possible. Even seemingly silly tests like correct input-format help prevent future problems for new users</p></li>
+<li><p>use the <code class="docutils literal notranslate"><span class="pre">self.assertSOMETHING</span></code> functions provided by <code class="docutils literal notranslate"><span class="pre">unittest</span></code>. This way a test failure is presented correctly An error inside your test function will not be handeled as a failure but an error.</p></li>
+<li><p>If the success of your test depends on the used device, you can use decorators like <code class="docutils literal notranslate"><span class="pre">skip()</span></code>, <code class="docutils literal notranslate"><span class="pre">skipif(numpy.__version__&lt;(1,</span> <span class="pre">0),</span> <span class="pre">&quot;not</span> <span class="pre">supported</span> <span class="pre">with</span> <span class="pre">your</span> <span class="pre">numpy</span> <span class="pre">version&quot;)</span></code>, etc.</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">setUp()</span></code> and <code class="docutils literal notranslate"><span class="pre">tearDown()</span></code> are called before and after each test. Use this functions to define parameters used in every test, or to close applications like Dymola once a test is completed.</p></li>
+<li><p>See the <a class="reference external" href="https://docs.python.org/3/library/unittest.html#organizing-tests">unittest-documentation</a> for further information</p></li>
+</ul>
+<p>You can check your work by running all tests before commiting to git.</p>
+</section>
+<section id="pylint">
+<h2>Pylint<a class="headerlink" href="#pylint" title="Permalink to this heading"></a></h2>
+<p>With pylint we try to keep our code clean.<span class="raw-html-m2r"><br></span>
+See the description in <a class="reference external" href="https://git.rwth-aachen.de/EBC/EBC_all/gitlab_ci/templates/tree/master/pylint">this repo</a> on information on what pylint is and how to use it.</p>
+</section>
+</section>
+
+
+           </div>
+          </div>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="code/vclibpy.utils.html" class="btn btn-neutral float-left" title="vclibpy.utils package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="version_his.html" class="btn btn-neutral float-right" title="Version History" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, EON EBC.</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>