Issue465 multizone office simple hydronic finalize

.travis.yml

@@ -72,6 +72,9 @@ jobs:
   - python: 3.9
     install: pip install --upgrade pip && pip install pandas==1.2.5 numpy==1.20.2 matplotlib==3.3.4 requests==2.25.1
     script: cd testing && make build_jm_image && make test_twozone_apartment_hydronic
+  - python: 3.9
+    install: pip install --upgrade pip && pip install pandas==1.2.5 numpy==1.20.2 matplotlib==3.3.4 requests==2.25.1
+    script: cd testing && travis_wait 90 make test_multizone_office_simple_hydronic_no_compile
   - python: 3.9
     install: pip install --upgrade pip && pip install pandas==1.2.5 numpy==1.20.2 matplotlib==3.3.4 requests==2.25.1
     script: cd testing && make build_jm_image && travis_wait 90 make test_multizone_office_simple_air ARG="-s test_peak_heat_day,test_typical_heat_day"

contributors.md

@@ -7,6 +7,8 @@ Thank you to all who have provided guidance on the development of this software.
 - Dave Biagioni, National Renewable Energy Laboratory
 - David Blum, Lawrence Berkeley National Laboratory
 - Yan Chen, Pacific Northwest National Laboratory
+- Roel De Coninck, dnergy
+- Iago Cupeiro Figueroa, Cupeiro Sinte, dnergy
 - Konstantin Filonenko, University of Southern Denmark
 - Gauthier-Clerc Francois, Pure Control
 - Valentin Gavan, ENGIE
@@ -17,6 +19,7 @@ Thank you to all who have provided guidance on the development of this software.
 - Yanfei Li, National Renewable Energy Laboratory
 - Nicholas Long, National Renewable Energy Laboratory
 - Robert Lutes, Pacific Northwest National Laboratory
+- Bart Merema, dnergy
 - Kefei Mo, Pacific Northwest National Laboratory
 - Erik Paulson, Independent
 - Matt Robinson, University of Colorado - Boulder

parsing/parser.py

@@ -19,7 +19,12 @@
 from data.data_manager import Data_Manager
 import warnings
 
-def parse_instances(model_path, file_name):
+if 'MODELICAPATH' in os.environ:
+    modelicapath=os.environ['MODELICAPATH']
+else:
+    modelicapath=os.path.abspath('.')
+
+def parse_instances(model_path, file_name, tool='JModelica'):
     '''Parse the signal exchange block class instances using fmu xml.
 
     Parameters
@@ -29,6 +34,9 @@ def parse_instances(model_path, file_name):
     file_name : list
         Path(s) to modelica file and required libraries not on MODELICAPATH.
         Passed to file_name parameter of pymodelica.compile_fmu() in JModelica.
+    tool : str, optional
+        FMU compilation tool. "JModelica" or "OCT" supported.
+        Default is "JModelica".
 
     Returns
     -------
@@ -42,7 +50,12 @@ def parse_instances(model_path, file_name):
     '''
 
     # Compile fmu
-    fmu_path = compile_fmu(model_path, file_name, jvm_args="-Xmx8g", target='cs')
+    if tool == 'JModelica':
+        fmu_path = compile_fmu(model_path, file_name, jvm_args="-Xmx8g", target='cs')
+    elif tool == 'OCT':
+        fmu_path = compile_fmu(model_path, file_name, modelicapath=modelicapath, jvm_args="-Xmx8g", target='cs')
+    else:
+        raise ValueError('Tool {0} unknown.'.format(tool))
     # Load fmu
     fmu = load_fmu(fmu_path)
     # Check version
@@ -105,7 +118,7 @@ def parse_instances(model_path, file_name):
 
     return instances, signals
 
-def write_wrapper(model_path, file_name, instances):
+def write_wrapper(model_path, file_name, instances, tool='JModelica'):
     '''Write the wrapper modelica model and export as fmu
 
     Parameters
@@ -118,6 +131,9 @@ def write_wrapper(model_path, file_name, instances):
     instances : dict
         Dictionary of overwrite and read block class instance lists.
         {'Overwrite': [str], 'Read': [str]}
+    tool : str, optional
+        FMU compilation tool. "JModelica" or "OCT" supported.
+        Default is "JModelica".
 
     Returns
     -------
@@ -179,18 +195,28 @@ def write_wrapper(model_path, file_name, instances):
             # End file -- with hard line ending
             f.write('end wrapped;\n')
         # Export as fmu
-        fmu_path = compile_fmu('wrapped', [wrapped_path]+file_name, jvm_args="-Xmx8g", target='cs')
+        if tool == 'JModelica':
+            fmu_path = compile_fmu('wrapped', [wrapped_path]+file_name, jvm_args="-Xmx8g", target='cs')
+        elif tool == 'OCT':
+            fmu_path = compile_fmu('wrapped', [wrapped_path]+file_name, modelicapath=modelicapath, jvm_args="-Xmx8g", target='cs')
+        else:
+            raise ValueError('Tool {0} unknown.'.format(tool))
     # If there are not, write and export wrapper model
     else:
         # Warn user
         warnings.warn('No signal exchange block instances found in model.  Exporting model as is.')
         # Compile fmu
-        fmu_path = compile_fmu(model_path, file_name, jvm_args="-Xmx8g", target='cs')
+        if tool == 'JModelica':
+            fmu_path = compile_fmu(model_path, file_name, jvm_args="-Xmx8g", target='cs')
+        elif tool == 'OCT':
+            fmu_path = compile_fmu(model_path, file_name, modelicapath=modelicapath, jvm_args="-Xmx8g", target='cs')
+        else:
+            raise ValueError('Tool {0} unknown.'.format(tool))
         wrapped_path = None
 
     return fmu_path, wrapped_path
 
-def export_fmu(model_path, file_name):
+def export_fmu(model_path, file_name, tool='JModelica'):
     '''Parse signal exchange blocks and export boptest fmu and kpi json.
 
     Parameters
@@ -200,6 +226,9 @@ def export_fmu(model_path, file_name):
     file_name : list
         Path(s) to modelica file and required libraries not on MODELICAPATH.
         Passed to file_name parameter of pymodelica.compile_fmu() in JModelica.
+    tool : str, optional
+        FMU compilation tool. "JModelica" or "OCT" supported.
+        Default is "JModelica".
 
     Returns
     -------
@@ -211,9 +240,9 @@ def export_fmu(model_path, file_name):
     '''
 
     # Get signal exchange instances and kpi signals
-    instances, signals = parse_instances(model_path, file_name)
+    instances, signals = parse_instances(model_path, file_name, tool)
     # Write wrapper and export as fmu
-    fmu_path, _ = write_wrapper(model_path, file_name, instances)
+    fmu_path, _ = write_wrapper(model_path, file_name, instances, tool)
     # Write kpi json
     kpi_path = os.path.join(os.getcwd(), 'kpis.json')
     with open(kpi_path, 'w') as f:

releasenotes.md

@@ -18,6 +18,10 @@ Released on xx/xx/xxxx.
 - Fix unit tests for possible false passes in certain test cases. This is for [#620](https://github.com/ibpsa/project1-boptest/issues/620).
 
 
+**The following new test cases have been added:**
+
+- ``multizone_office_simple_hydronic``, a 2-zone typical office building in Brussels, Belgium, served by fan-coil units for space heating and cooling, air handling units for space ventilation, an air-source heat pump for hot water production, and an air-cooled chiller for chilled water production. This is for [#465](https://github.com/ibpsa/project1-boptest/issues/465).
+
 ## BOPTEST v0.5.0
 
 Released on 10/04/2023.

testcases/README.md

@@ -10,7 +10,8 @@ This directory contains test cases for BOPTEST.  A summary of available test cas
 | ``bestest_air``| BESTEST Case 900 room model with idealized fan coil unit.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**:<br />``'peak_heat_day'``, <br />``'typical_heat_day'``, <br />``'peak_cool_day'``, <br />``'typical_cool_day'``, <br />``'mix_day'``|
 | ``bestest_hydronic``| BESTEST Case 900 room model with gas boiler and radiator.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
 | ``bestest_hydronic_heat_pump``| BESTEST Case 900 room model, scaled by four in floor area, that uses a heat pump as heating production system and floor heating as heating emission system.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
-| ``twozone_apartment_hydronic``| Low energy consumption two room aparment in Milan. Only heating is considered. The generation system is a heat pump and the emission system is floor heating. |**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
-| ``multizone_residential_hydronic``| Multi-zone residential hydronic model with gas boiler, radiators, and ideal cooling system. |**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
+| ``twozone_apartment_hydronic``| Low energy consumption 2 zone apartment in Milan. Only heating is considered. The generation system is a heat pump and the emission system is floor heating. |**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
+| ``multizone_residential_hydronic``| Multi-zone (8 zones) residential hydronic model with gas boiler, radiators, and ideal cooling system. |**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
 | ``singlezone_commercial_hydronic``| Single-zone commercial building model representing a university building with district heating source, zone radiator, occupancy based on real data, and air handling unit providing fresh air with CO2 control and heat recovery. |**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**: <br />``'peak_heat_day'``, <br />``'typical_heat_day'``|
-| ``multizone_office_simple_air`` | Multi-zone commercial building model based on U.S. DOE medium office building with single-duct VAV with terminal reheat, air-cooled chiller, and air-to-water heat pump.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**:<br />``'peak_heat_day'``, <br />``'typical_heat_day'``, <br />``'peak_cool_day'``, <br />``'typical_cool_day'``, <br />``'mix_day'``|
+| ``multizone_office_simple_hydronic`` | Multi-zone (2 zones) commercial office building model with fan coil units for space heating and cooling, air handling units for ventilation, with air-to-water heat pump and air-cooled chilled.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**:<br />``'peak_heat_day'``, <br />``'typical_heat_day'``, <br />``'peak_cool_day'``, <br />``'typical_cool_day'``, <br />``'mix_day'``|
+| ``multizone_office_simple_air`` | Multi-zone (5 zones) commercial building model based on U.S. DOE medium office building with single-duct VAV with terminal reheat, air-cooled chiller, and air-to-water heat pump.|**Electricity Prices**: <br />``'constant'``, <br />``'dynamic'``, <br />``'highly_dynamic'``<br />**Time Periods**:<br />``'peak_heat_day'``, <br />``'typical_heat_day'``, <br />``'peak_cool_day'``, <br />``'typical_cool_day'``, <br />``'mix_day'``|