Skip to content

Commit

Permalink
Update 'docs' folder with try_gh_app and delete old branches.
Browse files Browse the repository at this point in the history
  • Loading branch information
FWuellhorst committed Sep 1, 2023
1 parent 147ce99 commit 2fee536
Show file tree
Hide file tree
Showing 16 changed files with 687 additions and 665 deletions.
Binary file modified docs/try_gh_app/docs/.doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

Example 1: Generate archetype buildings using TEASER API
# Example 1: Generate archetype buildings using TEASER API
This module contains an example how to generate archetype buildings using
TEASER API functions.
You can run this example using the [jupyter-notebook](https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks)
Expand Down
27 changes: 21 additions & 6 deletions docs/try_gh_app/docs/examples/e1_generate_archetype.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &mdash; TEASER 0.7.7 documentation</title>
<title>Example 1: Generate archetype buildings using TEASER API &mdash; TEASER 0.7.7 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/autodoc_pydantic.css" type="text/css" />
Expand Down Expand Up @@ -47,10 +47,23 @@
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../install_teaser.html">Install TEASER</a></li>
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1"><a class="reference internal" href="../teaser.Examples.html">Examples</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
<li class="toctree-l3"><a class="reference internal" href="e5_load.html">Example 5: Load information</a></li>
<li class="toctree-l3"><a class="reference internal" href="e6_generate_building.html">Example 7: Generate single building</a></li>
<li class="toctree-l3"><a class="reference internal" href="e7_retrofit.html">Example 7: Retrofit buildings</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../teaser_advanced_example.html">Advanced examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../code/modules.html">teaser</a></li>
<li class="toctree-l1"><a class="reference internal" href="../acknowledgments.html">Acknowledgments</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
Expand All @@ -74,7 +87,7 @@
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../teaser.Examples.html">Examples</a></li>
<li class="breadcrumb-item"><a href="../teaser_api_example.html">API examples</a></li>
<li class="breadcrumb-item active">&lt;no title&gt;</li>
<li class="breadcrumb-item active">Example 1: Generate archetype buildings using TEASER API</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/examples/e1_generate_archetype.md.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -84,8 +97,9 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<p>Example 1: Generate archetype buildings using TEASER API
This module contains an example how to generate archetype buildings using
<section id="example-1-generate-archetype-buildings-using-teaser-api">
<h1>Example 1: Generate archetype buildings using TEASER API<a class="headerlink" href="#example-1-generate-archetype-buildings-using-teaser-api" title="Permalink to this heading"></a></h1>
<p>This module contains an example how to generate archetype buildings using
TEASER API functions.
You can run this example using the <a class="reference external" href="https://mybinder.org/v2/gh/RWTH-EBC/TEASER/master?labpath=docs%2Fjupyter_notebooks">jupyter-notebook</a></p>
<p>First step: Import the TEASER API (called Project) into your Python
Expand Down Expand Up @@ -192,6 +206,7 @@
<span class="n">construction_type</span><span class="o">=</span><span class="s1">&#39;tabula_retrofit&#39;</span><span class="p">)</span>
</pre></div>
</div>
</section>


</div>
Expand Down
5 changes: 3 additions & 2 deletions docs/try_gh_app/docs/examples/e2_export_aixlib_models.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Example 3: Export Modelica models for IBPSA library using TEASER API" href="e3_export_ibpsa_models.html" />
<link rel="prev" title="&lt;no title&gt;" href="e1_generate_archetype.html" />
<link rel="prev" title="Example 1: Generate archetype buildings using TEASER API" href="e1_generate_archetype.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
Expand Down Expand Up @@ -168,7 +169,7 @@ <h1>Example 2: Export Modelica models for AixLib library using TEASER API<a clas
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="e1_generate_archetype.html" class="btn btn-neutral float-left" title="&lt;no title&gt;" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="e1_generate_archetype.html" class="btn btn-neutral float-left" title="Example 1: Generate archetype buildings using TEASER API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="e3_export_ibpsa_models.html" class="btn btn-neutral float-right" title="Example 3: Export Modelica models for IBPSA library using TEASER API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

Expand Down
1 change: 1 addition & 0 deletions docs/try_gh_app/docs/examples/e3_export_ibpsa_models.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/try_gh_app/docs/examples/e4_save.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Example 4: Save information</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/try_gh_app/docs/examples/e5_load.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/try_gh_app/docs/examples/e6_generate_building.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/try_gh_app/docs/examples/e7_retrofit.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="../archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../teaser_api_example.html">API examples</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="e4_save.html">Example 4: Save information</a></li>
Expand Down
Binary file modified docs/try_gh_app/docs/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/try_gh_app/docs/searchindex.js

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions docs/try_gh_app/docs/teaser_api_example.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<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="&lt;no title&gt;" href="examples/e1_generate_archetype.html" />
<link rel="next" title="Example 1: Generate archetype buildings using TEASER API" href="examples/e1_generate_archetype.html" />
<link rel="prev" title="Examples" href="teaser.Examples.html" />
</head>

Expand Down Expand Up @@ -52,6 +52,7 @@
<li class="toctree-l1"><a class="reference internal" href="archetypes.html">Archetype Buildings</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="teaser.Examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">API examples</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples/e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples/e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples/e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples/e4_save.html">Example 4: Save information</a></li>
Expand Down Expand Up @@ -101,6 +102,7 @@ <h1>API examples<a class="headerlink" href="#api-examples" title="Permalink to t
You can also run these scripts using jupyter-notebook when loading the files under docs/jupyter-notebooks.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/e1_generate_archetype.html">Example 1: Generate archetype buildings using TEASER API</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/e2_export_aixlib_models.html">Example 2: Export Modelica models for AixLib library using TEASER API</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/e3_export_ibpsa_models.html">Example 3: Export Modelica models for IBPSA library using TEASER API</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/e4_save.html">Example 4: Save information</a></li>
Expand All @@ -116,7 +118,7 @@ <h1>API examples<a class="headerlink" href="#api-examples" title="Permalink to t
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="teaser.Examples.html" class="btn btn-neutral float-left" title="Examples" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="examples/e1_generate_archetype.html" class="btn btn-neutral float-right" title="&lt;no title&gt;" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="examples/e1_generate_archetype.html" class="btn btn-neutral float-right" title="Example 1: Generate archetype buildings using TEASER API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit 2fee536

Please sign in to comment.