Merge pull request #1280 from NREL/develop

v3.3.0 release

.github/pull_request_template.md

@@ -9,6 +9,6 @@ Not all may apply:
 - [ ] Tests (and test files) have been updated
 - [ ] Documentation has been updated
   - [ ] If related to resstock-estimation, checklist includes [data dictionary](https://github.com/NREL/resstock/tree/develop/resources/data/dictionary), [source report](https://github.com/NREL/resstock/tree/develop/project_national/resources/source_report.csv), [options saturation](https://github.com/NREL/resstock/tree/develop/project_national/resources/options_saturations.csv), [options_lookup](https://github.com/NREL/resstock/blob/develop/resources/options_lookup.tsv).
-- [ ] Changelog has been updated
+- [ ] Add to the [changelog_dev.rst file](https://github.com/NREL/resstock/tree/develop/docs/read_the_docs/source/changelog/changelog_dev.rst)
 - [ ] `openstudio tasks.rb update_measures` has been run
 - [ ] No unexpected regression test changes on CI (checked comparison artifacts)

.github/workflows/add_to_project.yml

@@ -15,7 +15,7 @@ jobs:
     name: Add pull request or issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@v0.3.0
+      - uses: actions/add-to-project@v1.0.0
         with:
           project-url: https://github.com/orgs/NREL/projects/38
           github-token: ${{ secrets.GHB_TOKEN }}

.github/workflows/config.yml

@@ -7,11 +7,18 @@ on:
     types: [ synchronize, opened ]
   workflow_dispatch:
 
+env:
+  OPENSTUDIO_VER: "3.8.0"
+  OPENSTUDIO_SHA: "f953b6fcaf"
+  OPENSTUDIO_PLATFORM: "Ubuntu-20.04-x86_64"
+  OPENSTUDIO_EXT: "deb"
+  OPENSTUDIO_URL: "https://github.com/NREL/OpenStudio/releases/download/v3.8.0"
+
 jobs:
   format-files:
     runs-on: ubuntu-latest    
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
       - name: Format Files
@@ -22,7 +29,7 @@ jobs:
           mv sorted_options_lookup.tsv resources/options_lookup.tsv # Sort on first two columns
 
       - name: Upload formatted options_lookup 
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: resources/options_lookup.tsv
           name: options_lookup
@@ -31,9 +38,9 @@ jobs:
     runs-on: ubuntu-latest
     needs: [format-files]
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.8.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -42,7 +49,7 @@ jobs:
           rm -f Gemfile.lock && bundle install
 
       - name: Download formatted options_lookup
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: resources
           name: options_lookup
@@ -60,13 +67,13 @@ jobs:
           bundle exec rake unit_tests:measure_tests
 
       - name: Upload feature samples
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: resources/buildstock.csv
           name: feature_samples
 
       - name: Store code coverage
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: coverage
           name: coverage
@@ -75,9 +82,9 @@ jobs:
     runs-on: ubuntu-latest
     needs: [unit-tests]
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.8.0
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -98,7 +105,7 @@ jobs:
           pip3 install --progress-bar off pandas pyyaml
 
       - name: Download formatted options_lookup
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: resources
           name: options_lookup
@@ -108,49 +115,50 @@ jobs:
           python3 test/update_yml_precomputed_files.py
 
       - name: Run run_analysis.rb
-        run: |
+        run: |          
           bundle exec rake workflow:analysis_tests
 
       - name: Upload precomputed buildstocks
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: test/tests_yml_files/yml_precomputed*/buildstock*.csv
           name: precomputed_buildstocks
 
       - name: Upload run_analysis.rb results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             project_national/results-Baseline.csv
             project_testing/results-Baseline.csv
-            project_national/results-AllUpgrades.csv
-            project_testing/results-AllUpgrades.csv
+            project_national/results-PackageUpgrade.csv
+            project_testing/results-PackageUpgrade.csv
           name: run_analysis_results_csvs
 
   integration-tests:
     runs-on: ubuntu-latest
     needs: [unit-tests]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
       - name: Download and Install OpenStudio
         run: |
-          wget -q https://github.com/NREL/OpenStudio/releases/download/v3.7.0/OpenStudio-3.7.0+d5269793f1-Ubuntu-20.04-x86_64.deb
-          sudo apt install -y ./OpenStudio-3.7.0+d5269793f1-Ubuntu-20.04-x86_64.deb
+          export OS_DEBFILE="OpenStudio-$OPENSTUDIO_VER+$OPENSTUDIO_SHA-$OPENSTUDIO_PLATFORM.$OPENSTUDIO_EXT"
+          wget -q $OPENSTUDIO_URL/$OS_DEBFILE
+          sudo apt install -y ./$OS_DEBFILE
           openstudio openstudio_version
           which openstudio
 
       - name: Download formatted options_lookup
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: resources
           name: options_lookup
 
       - name: Run buildstockbatch
         run: |
-          pip install git+https://github.com/NREL/buildstockbatch.git@v2023.10.0
+          pip install git+https://github.com/NREL/buildstockbatch.git@develop
           
           buildstock_local project_national/national_baseline.yml
           buildstock_local project_testing/testing_baseline.yml
@@ -178,15 +186,15 @@ jobs:
           python test/process_bsb_analysis.py
 
       - name: Upload integration results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             baseline
             upgrades
           name: feature_results
 
       - name: Upload buildstockbatch results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: |
             project_national/national_baseline/results_csvs/results_up00.csv
@@ -206,18 +214,18 @@ jobs:
     runs-on: ubuntu-latest
     needs: [analysis-tests, integration-tests]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
       - name: Download buildstockbatch results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: buildstockbatch
           name: buildstockbatch_results_csvs
 
       - name: Download run_analysis results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: run_analysis
           name: run_analysis_results_csvs
@@ -234,34 +242,34 @@ jobs:
     runs-on: ubuntu-latest
     needs: [integration-tests]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.base.sha }}
 
       - name: Upload base results
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: test/base_results
           name: base_results
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
       - name: Download base results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: base_results
           name: base_results
 
       - name: Download feature samples
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: samples
           name: feature_samples
 
       - name: Download feature results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: results
           name: feature_results
@@ -306,16 +314,16 @@ jobs:
           python test/compare.py -a timeseries -b base_results/upgrades/timeseries -f results/upgrades/timeseries -e test/base_results/comparisons/upgrades/timeseries
 
       - name: Upload comparisons
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           path: test/base_results/comparisons
           name: comparisons
 
   update-results:
     runs-on: ubuntu-latest
-    needs: [integration-tests]
+    needs: [analysis-tests, integration-tests]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.head_ref }}
 
@@ -326,25 +334,25 @@ jobs:
           sudo -E apt-get install -y wget unzip python3-sphinx-rtd-theme
 
       - name: Download feature samples
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: samples
           name: feature_samples
 
       - name: Download feature results
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: results
           name: feature_results
 
       - name: Download formatted options_lookup
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: resources
           name: options_lookup
 
       - name: Download precomputed buildstocks
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           path: test/tests_yml_files
           name: precomputed_buildstocks
@@ -355,10 +363,11 @@ jobs:
           ruby docs/read_the_docs/source/workflow_inputs/create_characteristics_rst.rb
           ruby docs/read_the_docs/source/workflow_outputs/csv_tables.rb
           cd docs/read_the_docs
+          pip install changelog
           make html SPHINXOPTS="-W --keep-going -n"
 
       - name: Save Docs
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: documentation
           path: docs/read_the_docs/_build/html/