Issue2180 main boiler plant controller

.gitattributes

@@ -0,0 +1,11 @@
+libModelicaBuildingsEnergyPlus*.* filter=lfs diff=lfs merge=lfs -text
+ModelicaBuildingsEnergyPlus*.dll filter=lfs diff=lfs merge=lfs -text
+ModelicaBuildingsEnergyPlus*.lib filter=lfs diff=lfs merge=lfs -text
+libepfmi*.* filter=lfs diff=lfs merge=lfs -text
+libfmilib*.* filter=lfs diff=lfs merge=lfs -text
+fmilib_shared*.* filter=lfs diff=lfs merge=lfs -text
+epfmi*.* filter=lfs diff=lfs merge=lfs -text
+VCRUNTIME*.dll filter=lfs diff=lfs merge=lfs -text
+Buildings/Resources/src/ThermalZones/EnergyPlus/FMUs/Zones1.fmu filter=lfs diff=lfs merge=lfs -text
+Buildings/Resources/src/ThermalZones/EnergyPlus/FMUs/Zones3.fmu filter=lfs diff=lfs merge=lfs -text
+Buildings/Resources/bin/spawn-*/bin/spawn filter=lfs diff=lfs merge=lfs -text

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Open model '...'
+2. Run script '....'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Version**
+ - Modelica Buildings Library: [version or commit]
+ - Modelica simulation environment
+ - Operating system
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom-issue.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue
+about: Issues other than bug report or feature request
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/formatting.yml

@@ -0,0 +1,98 @@
+# Workflow for CI tests
+name: CI-documentation-and-format
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master, maint_*, release* ]
+  pull_request:
+    branches: [ master, maint_*, release* ]
+
+# Allows you to run this workflow manually from the Actions tab
+#  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+    working-directory: Buildings
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+
+  test-formatting:
+    # Skip if the commit message contains "ci skip"
+    if: "!contains(github.event.head_commit.message, 'ci skip')"
+
+    runs-on: ubuntu-18.04
+
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-python@v2
+        with:
+          python-version: '3.6' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+          architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+
+      - name: "Install pip"
+        run: pip3 install --upgrade pip wheel
+
+      - name: "Install sphinx and its dependencies"
+        run: pip3 install \
+          sphinx==2.1.2 \
+          sphinx-bootstrap-theme==0.7.1 \
+          sphinxcontrib-bibtex==0.4.2 \
+          sphinxcontrib-plantuml==0.17 \
+          alabaster==0.7.12 \
+          MarkupSafe==1.1.1 \
+          Pygments==2.4.2 \
+          snowballstemmer==1.9.0 \
+          docutils==0.15.2 \
+          Babel==2.7.0 \
+          requests==2.22.0 \
+          Jinja2==2.10.1 \
+          latexcodec==1.0.7 \
+          pybtex==0.22.2 \
+          pybtex-docutils==0.2.1 \
+          oset==0.1.3 \
+          PyYAML==5.1.2
+
+      - name: "Install BuildingsPy"
+        run: pip3 install git+https://github.com/lbl-srg/BuildingsPy@master
+
+      - name: "Test html syntax"
+        run : ../bin/runUnitTests.py --validate-html-only
+
+      - name: "Test experiment setup"
+        run : ../bin/runUnitTests.py --validate-experiment-setup
+
+      - name: "Test if package.order are correct"
+        run : |
+              python -c 'import buildingspy.development.refactor as r; r.write_package_order(".", recursive=True)'
+              git diff --exit-code .
+
+      - name: "Verify files for invalid strings"
+        run: ${GITHUB_WORKSPACE}/bin/verifyFiles.py
+
+      - name: "Verify that all OpenModelica scripts are up to date, and no old scripts exist"
+        run : |
+              rm Resources/Scripts/OpenModelica/compareVars/*.mos
+              python -c 'import buildingspy.development.regressiontest as u; u.Tester().writeOpenModelicaResultDictionary()'
+              git status --porcelain Resources/Scripts/OpenModelica
+              test -z "$(git status --porcelain Resources/Scripts/OpenModelica)"
+
+      - name: "Test user guide"
+        run : (cd Resources/Documentation/userGuide; make regressiontest)
+
+      - name: "Test heat pump documentation"
+        run : (cd Resources/src/fluid/heatpumps/calibration/doc; make regressiontest)
+
+      - name: "Check for UnitConversion package to be consistent with the script that generates it"
+        run : |
+              cd ..
+              python Buildings/Resources/src/Controls/OBC/UnitConversions/unit_converters.py
+              git diff --exit-code Buildings
+
+      - name: Check for UTF-8 BOM
+        run: "! find . -name '*.mo' -print0 | xargs -0 grep -l $'^\\xEF\\xBB\\xBF' | grep ."

.gitignore

@@ -37,6 +37,7 @@ funnel_comp
 # CMake build directory
 ######################################
 /build
+Buildings/Resources/src/fmi-library/build
 
 
 # Temporary files generated by emacs
@@ -69,3 +70,6 @@ Buildings/Resources/src/fluid/heatpumps/calibration/doc/build/doctrees
 # Spawn temporary directories
 #########################################
 tmp-eplus-*
+eplus*
+sqlite*
+*/EnergyPlus-simulation*

.travis.yml

@@ -1,10 +1,17 @@
+os: Linux
 dist: bionic
 
 language: python
 
 python:
   - "3.6"
 
+branches:
+  only:
+    - master
+    - /^maint_.*$/
+    - release
+
 cache: pip
 
 notifications:
@@ -19,38 +26,86 @@ services:
 
 env:
   global:
-    - ENERGYPLUS_VERSION=EnergyPlus-9.3.0-baff08990c-Linux-x86_64
+    - ENERGYPLUS_VERSION=EnergyPlus-9.5.0-de239b2e5f-Linux-Ubuntu18.04-x86_64
     - MODELICA_JSON_VERSION=6d950c3592fa021aa914ba4ff34a67cbb69962c6
     - MODELICA_JSON_HOME=${TRAVIS_BUILD_DIR}/modelica-json
 
   jobs:
-    - TEST_ARG="make test-documentation test-experiment-setup test-autogenerated-files test-verify-files"
-    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Controls.OBC\""
-    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Controls.OBC\""
-    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Controls.OBC\""
+    - TEST_ARG="make test-cdl-conformance"
+    - TEST_ARG="make test-energyplus-validations"
+    - TEST_ARG="make test-bestest test-spawn-portability"
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Air,Examples}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Air,Examples}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.{Air,Examples}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.EnergyPlus\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.EnergyPlus\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.EnergyPlus\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.Detailed.{BaseClasses,Constructions,Examples}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.BESTEST\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.BESTEST\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.BESTEST\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.{Initialization,LBNL_71T,TestConditionalConstructions}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.{Initialization,LBNL_71T,TestConditionalConstructions}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.Detailed.Validation.{Initialization,LBNL_71T,TestConditionalConstructions}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.Detailed.FLEXLAB\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.Detailed.FLEXLAB\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.Detailed.FLEXLAB\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.ThermalZones.ReducedOrder\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.ThermalZones.ReducedOrder\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.ThermalZones.ReducedOrder\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Applications,Experimental}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Applications,Experimental}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.{Applications,Experimental}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Fluid.{Actuators,BaseClasses,Boilers,Chillers,CHPs,Delays}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{Examples,FMI,FixedResistances,Geothermal}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{Examples,FMI,FixedResistances,Geothermal}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Fluid.{Examples,FMI,FixedResistances,Geothermal}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Interfaces}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Interfaces}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Fluid.{HeatExchangers,HeatPumps,Interfaces}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Fluid.{MassExchangers,MixingVolumes,Movers,Sensors,SolarCollectors,Sources,Storage,Utilities}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Electrical\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Electrical\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Electrical\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.{Airflow,BoundaryConditions,Controls}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.HeatTransfer\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.HeatTransfer\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.HeatTransfer\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.{Obsolete.Controls,Occupants,Media}\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.{Obsolete.Controls,Occupants,Media}\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.{Obsolete.Controls,Occupants,Media}\""
+    - TEST_ARG="make test-dymola    PACKAGE=\"Buildings.Utilities\""
+    - TEST_ARG="make test-optimica  PACKAGE=\"Buildings.Utilities\""
+    - TEST_ARG="make test-jmodelica PACKAGE=\"Buildings.Utilities\""
+    - TEST_ARG="make test-omc"
 
 before_install:
   - sudo apt-get -y install python3.6-minimal  # Provides /usr/bin/python3.6m
   - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
-  - if [[ "$TEST_ARG" == *test-dymola* ]]; then
-       docker pull "$DOCKER_USERNAME"/travis_ubuntu-1804_dymola:2021-x86_64;
+  - if [[ "$TEST_ARG" == *test-dymola* || "$TEST_ARG" == *test-bestest* || "$TEST_ARG" == *spawn-portability* ]]; then
+       docker pull "$DOCKER_USERNAME"/travis_ubuntu-1804_dymola:2022-x86_64;
        cp Buildings/Resources/Scripts/travis/dymola/dymola $HOME/bin/;
     fi;
   - if [[ "$TEST_ARG" == *test-optimica* ]]; then
-       docker pull "$DOCKER_USERNAME"/travis-ubuntu-1804-optimica;
+       docker pull "$DOCKER_USERNAME"/travis-ubuntu-1804-optimica:r19089;
        cp Buildings/Resources/Scripts/travis/optimica/jm_ipython.sh $HOME/bin/jm_ipython.sh;
     fi;
   - if [[ "$TEST_ARG" == *test-jmodelica* ]]; then
        docker pull "$DOCKER_USERNAME"/ubuntu-1804_jmodelica_trunk;
        cp Buildings/Resources/Scripts/travis/jmodelica/jm_ipython.sh $HOME/bin/jm_ipython.sh;
     fi;
   - if [[ "$TEST_ARG" == *test-energyplus* ]]; then
-      wget --no-verbose https://github.com/NREL/EnergyPlus/releases/download/v9.3.0/${ENERGYPLUS_VERSION}.tar.gz;
+      wget --no-verbose https://github.com/NREL/EnergyPlus/releases/download/v9.5.0/${ENERGYPLUS_VERSION}.tar.gz;
       tar xzf ${ENERGYPLUS_VERSION}.tar.gz;
       rm ${ENERGYPLUS_VERSION}.tar.gz;
-      mv -v ${ENERGYPLUS_VERSION}/energyplus ${ENERGYPLUS_VERSION}/EnergyPlus;
-      file ${ENERGYPLUS_VERSION}/EnergyPlus
-      ls -l ${ENERGYPLUS_VERSION}
       echo "Installed EnergyPlus in ${PWD}/${ENERGYPLUS_VERSION}";
     fi;
   - if [[ "$TEST_ARG" == *test-cdl-conformance* ]]; then
@@ -64,38 +119,22 @@ before_install:
       cd -;
       echo "Installed modelica-json in ${MODELICA_JSON_HOME}";
     fi;
+  - if [[ "$TEST_ARG" == *test-omc* ]]; then
+       docker pull "$DOCKER_USERNAME"/ubuntu-2004-omc:1.18.0;
+    fi;
 
 # Install dependencies
 # For sphinx, we need to install specific package versions, otherwise
 # the html output may have small formatting differences which causes
 # the test to fail
 install:
-  - pip3 install --upgrade pip setuptools wheel
+  - pip3 install --upgrade pip wheel
   - pip3 install --only-binary=numpy,scipy,matplotlib numpy==1.13.3 scipy==0.19.1 matplotlib==2.1.0
-  - if [[ "$TEST_ARG" == *test-documentation* ]]; then
-      pip3 install sphinx==2.1.2 \
-        sphinx-bootstrap-theme==0.7.1 \
-        sphinxcontrib-bibtex==0.4.2 \
-        sphinxcontrib-plantuml==0.17 \
-        alabaster==0.7.12 \
-        MarkupSafe==1.1.1 \
-        Pygments==2.4.2 \
-        snowballstemmer==1.9.0 \
-        docutils==0.15.2 \
-        Babel==2.7.0 \
-        requests==2.22.0 \
-        Jinja2==2.10.1 \
-        latexcodec==1.0.7 \
-        pybtex==0.22.2
-        pybtex-docutils==0.2.1 \
-        oset==0.1.3 \
-        PyYAML==5.1.2;
-    fi;
+  - pip3 install git+https://github.com/lbl-srg/BuildingsPy@master
   - if [[ "$TEST_ARG" == *test-energyplus* ]]; then
       export PATH=${PATH}:${TRAVIS_BUILD_DIR}/${ENERGYPLUS_VERSION};
       pip3 install pandas==1.0.1;
     fi;
-  - pip3 install git+https://github.com/lbl-srg/BuildingsPy@master
 
 # Execute tests
 script: