rm old doc and directly include ReadMe, making maintenance easier in …

…the future.
RWTH-EBC · Feb 21, 2025 · 4112140 · 4112140
1 parent e51040e
commit 4112140
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 110 deletions.
diff --git a/docs/source/acknowledgments.rst b/docs/source/acknowledgments.rst
@@ -9,5 +9,11 @@ The following people have directly contributed to the implementation of TEASER:
  - Yasin Goerguelue
  - Christoph Gingter
  - Peter Remmen
+ - David Jansen
+ - Larissa Kühn
+ - Fabian Wüllhorst
+ - Jonatan Höpp
+ - Jonas Reuter-Schniete
+ - Hendrick van der Stok
 
 Special thanks goes to Gregor Hillebrand, who created the basis of TEASER (Retrofit Matrix).
diff --git a/docs/source/development.rst b/docs/source/development.rst
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,40 +6,7 @@
 TEASER
 ======
 
-.. image:: teaser_logo.png
- :scale: 100 %
- :alt: teaser_logo
- :align: left
-
-TEASER (Tool for Energy Analysis and Simulation for Efficient Retrofit) allows
-fast generation of archetype buildings with low input requirements and the
-export of individual dynamic simulation models for the below-mentioned Modelica
-libraries. These libraries all use the framework of `Modelica IBPSA
-library <https://github.com/ibpsa/modelica>`_. TEASER is being
-developed at the `RWTH Aachen University, E.ON Energy Research Center, Institute
-for Energy Efficient Buildings and Indoor Climate <https://www.ebc.eonerc.rwth-aachen.de/cms/~dmzz/E-ON-ERC-EBC/?lidx=1>`_.
-
-   - `AixLib <https://github.com/RWTH-EBC/AixLib>`_
-   - `Buildings <https://github.com/lbl-srg/modelica-buildings>`_
-   - `BuildingSystems <https://github.com/UdK-VPT/BuildingSystems>`_
-   - `IDEAS <https://github.com/open-ideas/IDEAS>`_.
-
-This software is work-in-progress. Documentation will be incomplete or missing
-and the software may not run properly. In particular the Graphical User
-Interface is a beta release and not fully tested. If you find any bugs, please
-report them in the issue section of the `repository <https://github.com/RWTH-EBC/TEASER/issues>`_.
-
-If you have any questions regarding TEASER feel free to contact us at
-`[email protected] <[email protected]>`_.
-
-Note that this documentation will always be auto-generated using the
-`development branch <https://github.com/RWTH-EBC/TEASER/tree/development>`_.
-That means, there might be new developments described in this docu that are not
-working in the main and pip installation of TEASER. A list of those issue can
-be found `here <development.html>`_
-
-Also have a look at the `FAQ section <faq.html>`_. If you feel your question should also be listed, please open an issue in the issue section of the `repository <https://github.com/RWTH-EBC/TEASER/issues>`_.
-
+.. mdinclude::  ../../README.md
 
 Contents
 ========
@@ -53,31 +20,7 @@ Contents
    code/modules
    acknowledgments
    license
-   faq
-   development
-
-
-Publications
-============
-  - TEASER: an open tool for urban energy modelling of building stocks. Remmen P., Lauster M., Mans M., Fuchs M., Osterhage T., Müller D.. Journal of Building Performance Simulation, February 2017, `pdf <http://dx.doi.org/10.1080/19401493.2017.1283539>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite_jbps.bib>`__
-  - CityGML Import and Export for Dynamic Building Performance Simulation in Modelica. Remmen P., Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016, `pdf <http://www.ibpsa.org/proceedings/BSO2016/p1047.pdf>`__, `bibtex <https://github.com/RWTH-EBC/TEASER/tree/main/doc/cite.bib>`__
-  - Scalable Design-Driven Parameterization of Reduced Order Models Using Archetype Buildings with TEASER. Lauster M., Mans M., Remmen P., Fuchs M., Müller D.. BauSIM2016, p.535-542, September 2016, `pdf <https://www.researchgate.net/profile/Moritz_Lauster/publication/310465372_Scalable_Design-Driven_Parameterization_of_Reduced_Order_Models_using_Archetype_Buildings_with_TEASER/links/582ee96908ae004f74be1fb0.pdf?origin=publication_detail&ev=pub_int_prw_xdl&msrp=eEyK6WYemhC8wK7xkMEPRDO4obE4uxBN4-0BdBy1Ldwhy9FhCe1pXfNObJYubvC_aZN0IWDPf9uayBo3u79bsZvg3hzUoLoYRatES2ARH8c.B2cYwSICt0IOa7lD-4oAiEa_3TtrO-7k-1W9chuNQwr_VNMCpZ5ubSb-eY2D77rGUP4S6wS8m6vudUUbMlXbQQ.Cledgd1Q9fPp11nYGpcpKNhSS6bVTqAEXeMZPkiV3HsJxcVWTFj4Hr_jmLZ0MOzDxbDEZObcGiKfmTL_9k_59A>`__
-
-Funding
-=======
-.. image:: http://www.innovation-beratung-foerderung.de/INNO/Redaktion/DE/Bilder/Titelbilder/titel_foerderlogo_bmwi.jpg;jsessionid=4BD60B6CD6337CDB6DE21DC1F3D6FEC5?__blob=poster&v=2
- :height: 173 px
- :width: 210 px
- :alt: teaser_logo
- :align: right
-
-Parts of TEASER have been developed within public funded projects and with
-financial support by BMWi (German Federal Ministry for Economic Affairs and
-Energy).
 
-|
-|
-|
 
 Indices and tables
 ==================

diff --git a/docs/source/install_teaser.rst b/docs/source/install_teaser.rst
@@ -14,27 +14,3 @@ and then run::
 		pip install -e [Path/to/your/Teaser/Clone]
 
 which will install the local version of TEASER.
-
-
-TEASER uses Python 2.7 <= v >=3.3. Further using a Python distribution is
-recommended as they already contain (or easily support installation of) many
-Python packages (e.g. SciPy, NumPy, pip, PyQT, etc.) that are used in the
-TEASER code. Two examples of those distributions are:
-
-	- https://winpython.github.io/ WinPython comes along with a lot of Python packages (e.g. SciPy, NumPy, pip, PyQT, etc.).
-
-	- http://conda.pydata.org/miniconda.html Conda is an open source package management  system and environment management system for installing multiple versions of software  packages and their dependencies and switching easily between them.
-
-In addition, TEASER requires some specific Python packages:
-
-1. Mako: template Engine::
-
-		pip install-U mako
-
-2. PyXB: XML binding Engine::
-
-		pip install -U pyxb
-
-3. pytest: Unit Tests engine::
-
-		pip install -U pytest