Merge pull request #625 from RWTH-EBC/development

Development

.gitlab-ci.yml

@@ -0,0 +1,46 @@
+test3.6-subset:
+  image: python:3.6
+  stage: test
+  script:
+
+    - pip install --upgrade pip setuptools wheel
+    - pip install --only-binary=numpy,scipy numpy scipy
+    - pip install pyxb
+    - pip install pytest
+    - pip install PyGithub==1.39
+    - pip install flake8==3.4.1
+    - pip install -e .
+    - flake8 --count --ignore W503,F401 --exclude teaser/data/bindings,doc,tests,.eggs --max-line-length=120
+    - py.test --ignore=tests/test_modelicaversion.py
+
+test3.6-full:
+  image: python:3.6
+  stage: test
+  only:
+    - master
+  script:
+
+    - pip install --upgrade pip setuptools wheel
+    - pip install --only-binary=numpy,scipy numpy scipy
+    - pip install pyxb
+    - pip install pytest
+    - pip install PyGithub==1.39
+    - pip install flake8==3.4.1
+    - pip install -e .
+    - flake8 --count --ignore W503,F401 --exclude teaser/data/bindings,doc,tests,.eggs --max-line-length=120
+    - py.test
+
+test3.7:
+  image: python:3.7
+  stage: test
+  script:
+
+    - pip install --upgrade pip setuptools wheel
+    - pip install --only-binary=numpy,scipy numpy scipy
+    - pip install pyxb
+    - pip install pytest
+    - pip install PyGithub==1.39
+    - pip install flake8==3.4.1
+    - pip install -e .
+    - flake8 --count --ignore W503,F401 --exclude teaser/data/bindings,doc,tests,.eggs --max-line-length=120
+    - py.test --ignore=tests/test_modelicaversion.py

.travis.yml

@@ -1,26 +1,29 @@
 language: python
 python:
-- 2.7
-- 3.4
-- 3.5
 - 3.6
+- 3.7
 install:
   - pip install --upgrade pip setuptools wheel
-  - pip install --only-binary=numpy,scipy numpy scipy
-  - pip install pyxb
-  - pip install -e .
+  - pip install --only-binary=numpy,scipy,cython numpy scipy cython
+  - pip install --no-use-pep517 -e .
   - pip install pytest-cov
   - pip install coveralls
   - pip install PyGithub==1.39
   - pip install flake8==3.4.1
 
 before_script:
   - flake8 --count --ignore W503,F401 --exclude teaser/data/bindings,doc,tests --max-line-length=120
+master:
+  script:
+  - py.test --cov=teaser
+  after_success:
+  - coveralls
 
 script:
-- py.test --cov=teaser
+- py.test --cov=teaser --ignore=tests/test_modelicaversion.py
 after_success:
 - coveralls
+
 deploy:
   provider: pypi
   user: teaser_github

README.md

@@ -32,17 +32,11 @@ available under the
 If you have any questions regarding TEASER feel free to contact us at
 [[email protected]](mailto:[email protected]).
 
----
-
-## Updates
-TEASER Online Released
-If you want to generate fast and easily archetype building models you can simulate with the Modelica-IBPSA related libraries, follow
-this link:
+If you want to use TEASER without installation, you can use out TEASER webtool, which
+will generate a Modelica model and provide this as download:
 
  * [http://teaser.eonerc.rwth-aachen.de](http://teaser.eonerc.rwth-aachen.de)
 
----
-
 ## Description
 
 Energy supply of buildings in urban context currently undergoes significant
@@ -64,15 +58,16 @@ models for all libraries supporting the
 
 ## Version
 
-TEASER is a ongoing research project, the current version is 0.6.9, which is
+TEASER is a ongoing research project, the current version is 0.7.0, which is
 still a pre-release.
 
 ## How to use TEASER
 
 ### Dependencies
 
-TEASER is tested against Python versions 2.7, 3.4, 3.5 and 3.6. Further
-using a Python distribution is recommended as they already contain (or easily
+TEASER is currently tested against Python 3.6 and 3.7. Older versions of Python may
+still work, but are no longer actively supported.
+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:
 
@@ -87,8 +82,8 @@ In addition, TEASER requires some specific Python packages:
 
 1. Mako: template Engine
   install on a python-enabled command line with `pip install -U mako`
-2. PyXB: XML binding Engine
-  install on a python-enabled command line with `pip install -U pyxb`
+2. pandas: popular data analysis library
+  install on a python-enabled command line with `pip install -U pandas`
 3. pytest: Unit Tests engine
   install on a python-enabled command line with `pip install -U pytest`
 
@@ -106,8 +101,6 @@ and then run:
 
  `pip install -e [Path/to/your/Teaser/Clone]` which will install the local version of TEASER.
 
-### Additional Explanations
-The [Institute of Energy Efficiency and Sustainable Building](https://www.e3d.rwth-aachen.de/go/id/iyld/?) published a parametric study of TEASER where all functions and  parameters used in TEASER are gathered and explained. The publication can be found [here](https://publications.rwth-aachen.de/record/749801/files/749801.pdf).
 
 ### How to contribute to the development of TEASER
 You are invited to contribute to the development of TEASER. You may report any issues by using the [Issues](https://github.com/RWTH-EBC/TEASER/issues) button.
@@ -122,7 +115,6 @@ The workflow for changes is described in our [Wiki](https://github.com/RWTH-EBC/
 
 ### TEASER related publications
 
-
 + 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),
@@ -132,6 +124,15 @@ Lauster M., Mans M., Osterhage T., Müller D.. BSO16, p.329-336, September 2016,
 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)
 
++ Refinement of Dynamic Non-Residential Building Archetypes Using Measurement Data and Bayesian Calibration
+Remmen P., Schäfer J., Müller D.. Building Simulation 2019, September 2019,
+[pdf](https://www.researchgate.net/publication/337925776_Refinement_of_Dynamic_Non-Residential_Building_Archetypes_Using_Measurement_Data_and_Bayesian_Calibration)
+
++ Selecting statistical indices for calibrating building energy models. Vogt, M., Remmen P., Lauster M., Fuchs M. , Müller D.. Building and Environment 144, pages 94-107, October 2018. [bibtex](https://github.com/RWTH-EBC/TEASER/tree/master/doc/cite_be.bib)
+
++ The [Institute of Energy Efficiency and Sustainable Building](https://www.e3d.rwth-aachen.de/go/id/iyld/?) published a parametric study of TEASER where all functions and  parameters used in TEASER are gathered and explained. The publication can be found [here](https://publications.rwth-aachen.de/record/749801/files/749801.pdf).
+
+
 ## License
 
 TEASER is released by RWTH Aachen University, E.ON Energy

doc/cite_be.bib

@@ -0,0 +1,13 @@
+@article{VOGT201894,
+title = "Selecting statistical indices for calibrating building energy models",
+journal = "Building and Environment",
+volume = "144",
+pages = "94 - 107",
+year = "2018",
+issn = "0360-1323",
+doi = "https://doi.org/10.1016/j.buildenv.2018.07.052",
+url = "http://www.sciencedirect.com/science/article/pii/S0360132318304608",
+author = "Marcus Vogt and Peter Remmen and Moritz Lauster and Marcus Fuchs and Dirk Müller",
+keywords = "Dynamic building energy simulation, Statistical indices, Automated model calibration, Measured energy data, Non-residential sector",
+abstract = "A well-known problem in the dynamic simulation of buildings energy consumption are the discrepancies between the simulated and measured data, which call for calibration techniques to obtain more accurate and reliable building models. The most recognized calibration techniques use statistical indices to assess and improve the quality of simulation models. While there are already well known statistical indices available to evaluate the simulation outputs, the combination of indices offers potential for further improvements in this field. To assess the procedure of calibrating building simulation models, we present a ranking of six tested statistical indices and their combinations (63 statistical metrics), produced by an automated evaluation procedure, in the specific case of calibrating to annual heat demand curves. The developed evaluation procedure is also able to account for eventual deterioration of other statistical metrics, which are not tuned during the calibration. We apply the new method in dynamic, hourly simulations to a use case with 200 buildings, for which extensive measurement data are available. Based on the generated ranking, we recommend using combinations of four statistical indices: the Coefficient of Variation of Root Mean Square Error (CV(RMSE)), the Normalized Mean Error (NME), the standardized contingency coefficient (Cχ2) and the coefficient of determination (R2). In our use case, these combinations lead to better results than the commonly used indices CV(RMSE) and Normalized Mean Bias Error (NMBE). In addition, we could show that it is beneficial to use another index for evaluation than for calibration, because it detects eventual deterioration of the simulation output results."
+}

setup.py

@@ -1,93 +1,87 @@
 from setuptools import setup
 
-setup(name='teaser',
-      version='0.6.9',
-      description='Tool for Energy Analysis and Simulation for '
-                  'Efficient Retrofit ',
-      url='https://github.com/RWTH-EBC/TEASER',
-      author='RWTH Aachen University, E.ON Energy Research Center, '
-             'Institute of Energy Efficient Buildings and Indoor Climate',
-      author_email='[email protected]',
-      license='MIT',
-      packages=[
-          'teaser',
-          'teaser.logic',
-          'teaser.logic.archetypebuildings',
-          'teaser.logic.archetypebuildings.tabula',
-          'teaser.logic.archetypebuildings.tabula.de',
-          'teaser.logic.archetypebuildings.bmvbs',
-          'teaser.logic.archetypebuildings.bmvbs.custom',
-          'teaser.logic.archetypebuildings.urbanrenet',
-          'teaser.logic.buildingobjects',
-          'teaser.logic.buildingobjects.boundaryconditions',
-          'teaser.logic.buildingobjects.buildingphysics',
-          'teaser.logic.buildingobjects.buildingsystems',
-          'teaser.logic.buildingobjects.calculation',
-          'teaser.logic.simulation',
-          'teaser.data',
-          'teaser.data.bindings',
-          'teaser.data.bindings.opengis',
-          'teaser.data.bindings.opengis.citygml',
-          'teaser.data.bindings.opengis.citygml.raw',
-          'teaser.data.bindings.opengis.misc',
-          'teaser.data.bindings.opengis.misc.raw',
-          'teaser.data.bindings.opengis.raw',
-          'teaser.data.bindings.schemas',
-          'teaser.data.bindings.v_0_3_9',
-          'teaser.data.bindings.v_0_4',
-          'teaser.data.bindings.v_0_5',
-          'teaser.data.bindings.v_0_6',
-          'teaser.data.input',
-          'teaser.data.input.inputdata',
-          'teaser.data.input.inputdata.weatherdata',
-          'teaser.data.output',
-          'teaser.data.output.texttemplate',
-          'teaser.data.output.modelicatemplate',
-          'teaser.data.output.modelicatemplate.AixLib',
-          'teaser.data.output.modelicatemplate.IBPSA',
-          'teaser.examples',
-          'teaser.examples.simulation',
-          'teaser.examples.verification',
-          'teaser.examples.examplefiles',
-          'teaser.examples.examplefiles.MelatenXML'],
-      package_data={
-          'teaser.data.input.inputdata': ['*.xml'],
-          'teaser.data.input.inputdata.weatherdata': [
-              'DEU_BW_Mannheim_107290_TRY2010_12_Jahr_BBSR.mos'],
-          'teaser.data.output.modelicatemplate': [
-              'package',
-              'package_order',
-              'conversion',
-              'modelica_language'],
-          'teaser.data.output.modelicatemplate.AixLib': [
-              'AixLib_Multizone',
-              'AixLib_ThermalZoneRecord_OneElement',
-              'AixLib_ThermalZoneRecord_TwoElement',
-              'AixLib_ThermalZoneRecord_ThreeElement',
-              'AixLib_ThermalZoneRecord_FourElement'],
-          'teaser.data.output.modelicatemplate.IBPSA': [
-              'IBPSA_OneElement',
-              'IBPSA_TwoElements',
-              'IBPSA_ThreeElements',
-              'IBPSA_FourElements'],
-          'teaser.data.output.texttemplate': [
-              'ReadableBuilding_OneElement',
-              'ReadableBuilding_TwoElement',
-              'ReadableBuilding_ThreeElement',
-              'ReadableBuilding_FourElement'],
-          'teaser.data.bindings.schemas': ['*.xsd'],
-          'teaser.examples.examplefiles': ['*.teaserXML', '*.gml'],
-          'teaser.examples.examplefiles.MelatenXML': ['*.xml']},
-      classifiers=[
-          'License :: OSI Approved :: MIT License',
-          'Operating System :: Microsoft :: Windows',
-          'Operating System :: POSIX :: Linux',
-          'Programming Language :: Python :: 2.7',
-          'Programming Language :: Python :: 3.3',
-          'Programming Language :: Python :: 3.4',
-          'Programming Language :: Python :: 3.5',
-          'Intended Audience :: Science/Research',
-          'Topic :: Software Development :: Code Generators',
-          'Topic :: Scientific/Engineering',
-          'Topic :: Utilities'],
-      install_requires=['mako', 'pyxb==1.2.5', 'pytest', 'scipy'])
+setup(
+    name="teaser",
+    version="0.7.0",
+    description="Tool for Energy Analysis and Simulation for " "Efficient Retrofit ",
+    url="https://github.com/RWTH-EBC/TEASER",
+    author="RWTH Aachen University, E.ON Energy Research Center, "
+    "Institute of Energy Efficient Buildings and Indoor Climate",
+    author_email="[email protected]",
+    license="MIT",
+    packages=[
+        "teaser",
+        "teaser.logic",
+        "teaser.logic.archetypebuildings",
+        "teaser.logic.archetypebuildings.tabula",
+        "teaser.logic.archetypebuildings.tabula.de",
+        "teaser.logic.archetypebuildings.tabula.dk",
+        "teaser.logic.archetypebuildings.bmvbs",
+        "teaser.logic.archetypebuildings.bmvbs.custom",
+        "teaser.logic.archetypebuildings.urbanrenet",
+        "teaser.logic.buildingobjects",
+        "teaser.logic.buildingobjects.buildingphysics",
+        "teaser.logic.buildingobjects.buildingsystems",
+        "teaser.logic.buildingobjects.calculation",
+        "teaser.logic.simulation",
+        "teaser.data",
+        "teaser.data.input",
+        "teaser.data.input.inputdata",
+        "teaser.data.input.inputdata.weatherdata",
+        "teaser.data.output",
+        "teaser.data.output.modelicatemplate",
+        "teaser.data.output.modelicatemplate.AixLib",
+        "teaser.data.output.modelicatemplate.IBPSA",
+        "teaser.examples",
+        "teaser.examples.verification",
+        "teaser.examples.examplefiles",
+    ],
+    package_data={
+        "teaser.data.input.inputdata": ["*.json"],
+        "teaser.data.input.inputdata.weatherdata": [
+            "DEU_BW_Mannheim_107290_TRY2010_12_Jahr_BBSR.mos",
+            "ASHRAE140.mos",
+        ],
+        "teaser.data.output.modelicatemplate": [
+            "package",
+            "package_order",
+            "conversion",
+            "modelica_language",
+        ],
+        "teaser.data.output.modelicatemplate.AixLib": [
+            "AixLib_Multizone",
+            "AixLib_ThermalZoneRecord_OneElement",
+            "AixLib_ThermalZoneRecord_TwoElement",
+            "AixLib_ThermalZoneRecord_ThreeElement",
+            "AixLib_ThermalZoneRecord_FourElement",
+        ],
+        "teaser.data.output.modelicatemplate.IBPSA": [
+            "IBPSA_OneElement",
+            "IBPSA_TwoElements",
+            "IBPSA_ThreeElements",
+            "IBPSA_FourElements",
+        ],
+        "teaser.data.output.texttemplate": [
+            "ReadableBuilding_OneElement",
+            "ReadableBuilding_TwoElement",
+            "ReadableBuilding_ThreeElement",
+            "ReadableBuilding_FourElement",
+        ],
+        "teaser.examples.examplefiles": ["*.json"],
+    },
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX :: Linux",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Intended Audience :: Science/Research",
+        "Topic :: Software Development :: Code Generators",
+        "Topic :: Scientific/Engineering",
+        "Topic :: Utilities",
+    ],
+    install_requires=["mako", "pytest", "pandas", "numpy"],
+)