tbd 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24c3c1ce27d2513d0f1529795e7016ad07a69e3499d5e79f7164698e1a16dc48
-  data.tar.gz: f23f7f85a54bcc551179ba751e826dc2951520e4ad0e17eaafad8fac01cea9fc
+  metadata.gz: 9d6373dd2c7851862ab62c368f9a08ba66b515028792278249e83cbc4ea82387
+  data.tar.gz: a4d02730e467fd836af97a2f4ca68f90c0e7b6aa53aabbbe2e7d5c53cd932e20
 SHA512:
-  metadata.gz: 02cb220811ddcc388c7ae20d17ffc2cfc0b64322605d5c571c2fbd1e325018ec44c7801b7aa0b0d7f2481ec0f0ebee25061130ccd7814f5badf7cb3b01fce625
-  data.tar.gz: 7cf328dca053b90d53c05f070c36f13a7ac9b9813435276ddaf9c14a4bc24e4d287ed7ffb698a6e3f1e5a71822b0f568bfa48155053620a3297d497a4cac5c21
+  metadata.gz: 1725c5ea9338e03765a5a49fc13b9525802330eecbbd6effdf8bbd71383e695c2ec4f38c536cdbd8b32f12929f216a164e28ddcd656c16937a1a03d1f15b97dc
+  data.tar.gz: 34bf72736719a22e7f2d19a6f937d7098417931ec748386615ef7ccb14ebc488e3a905d352c0ef94d0bbf8c7299e62899d4134529288b353cf32c4bd9afa2f0c

data/.github/workflows/pull_request.yml

@@ -6,22 +6,6 @@ on:
       - develop
 
 jobs:
-  test_300x:
-    runs-on: ubuntu-22.04
-    steps:
-    - name: Check out repository
-      uses: actions/checkout@v2
-    - name: Run Tests
-      run: |
-        echo $(pwd)
-        echo $(ls)
-        docker pull nrel/openstudio:3.0.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.0.0
-        docker exec -t test pwd
-        docker exec -t test ls
-        docker exec -t test bundle update
-        docker exec -t test bundle exec rake
-        docker kill test
   test_321x:
     runs-on: ubuntu-22.04
     steps:
@@ -38,38 +22,6 @@ jobs:
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
-  test_330x:
-    runs-on: ubuntu-22.04
-    steps:
-    - name: Check out repository
-      uses: actions/checkout@v2
-    - name: Run Tests
-      run: |
-        echo $(pwd)
-        echo $(ls)
-        docker pull nrel/openstudio:3.3.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.3.0
-        docker exec -t test pwd
-        docker exec -t test ls
-        docker exec -t test bundle update
-        docker exec -t test bundle exec rake
-        docker kill test
-  test_340x:
-    runs-on: ubuntu-22.04
-    steps:
-    - name: Check out repository
-      uses: actions/checkout@v2
-    - name: Run Tests
-      run: |
-        echo $(pwd)
-        echo $(ls)
-        docker pull nrel/openstudio:3.4.0
-        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.4.0
-        docker exec -t test pwd
-        docker exec -t test ls
-        docker exec -t test bundle update
-        docker exec -t test bundle exec rake
-        docker kill test
   test_351x:
     runs-on: ubuntu-22.04
     steps:
@@ -150,3 +102,19 @@ jobs:
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
+  test_3100x:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.10.0
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.10.0
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Denis Bourgeois & Dan Macumber
+Copyright (c) 2020-2025 Denis Bourgeois & Dan Macumber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,13 +5,11 @@ An [OpenStudio Measure](https://nrel.github.io/OpenStudio-user-documentation/ref
 ## Guide & Downloads
 
 Building professionals and energy modellers are encouraged to first consult the online [Guide](https://rd2.github.io/tbd/) - it provides an overview of the underlying theory, references, suggested OpenStudio workflows, etc. Users can download the latest _TBD_ version directly from the Guide itself, or under [releases](https://github.com/rd2/tbd/releases), or via NREL's [BCL](https://bcl.nrel.gov) (search for "bridging" or "rd2"). Questions can be posted on [UnmetHours](https://unmethours.com) - a very useful online resource for OpenStudio users. TBD is also available as a Ruby gem - add:  
-
 ```
 gem "tbd", git: "https://github.com/rd2/tbd", branch: "master"
 ```  
 
-... in a v2.1 [bundled](https://bundler.io) _Measure_ development environment "Gemfile" (or preferably as a _gemspec_ dependency), and then run:  
-
+... in a [bundled](https://bundler.io) _Measure_ development environment "Gemfile" (or preferably as a _gemspec_ dependency), and then run:  
 ```
 bundle install (or 'bundle update')
 ```
@@ -24,11 +22,11 @@ Bugs or new feature requests for _TBD_ should be submitted [here](https://github
 
 The installation and testing instructions in this section are for developers interested in exploring/tweaking a cloned/forked version of the source code. In an effort to _lighten_ TBD as a Ruby gem, only the most basic tests are deployed in this repository. More detailed tests are housed in a dedicated TBD [testing](https://github.com/rd2/tbd_tests) repo.
 
-TBD is systematically tested against updated OpenStudio versions (since v3.0.0). The following instructions refer to OpenStudio v3.6.1 (requiring Ruby v2.7.2), strictly as an example. Adapt the instructions for more recent versions - see OpenStudio's [compatibility matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix).
+TBD is systematically tested against updated OpenStudio versions (since v3.0.0). The following instructions refer to OpenStudio v3.8.0, which requires Ruby v3.2.2. Earlier OpenStudio versions require Ruby v2.7.2. Adapt instructions for older (or newer) versions - see OpenStudio's [compatibility matrix](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix).
 
 ### Windows Installation
 
-Either install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.7.2 (x64)](https://github.com/oneclick/rubyinstaller2/releases/tag/RubyInstaller-2.7.2-1/rubyinstaller-2.7.2-1-x64.exe), or preferably under [WSL2](https://gist.github.com/brgix/0d968d8f32c41f13300dc6769414df79). Run the following steps if going down the _RubyInstaller_ route. From the command line, check that the ruby installation returns the correct Ruby version:
+Either install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 3.2.2 (x64)](https://github.com/oneclick/rubyinstaller2/releases/download/RubyInstaller-3.2.2-1/rubyinstaller-3.2.2-1-x64.exe), or preferably under a [WSL2](https://gist.github.com/brgix/0d968d8f32c41f13300dc6769414df79) environment. Run the following steps if going down the _RubyInstaller_ route. From the command line, check that the ruby installation returns the correct Ruby version:  
 ```
 ruby -v
 ```
@@ -39,12 +37,11 @@ bundler -v
 gem install bundler -v 2.1
 ```
 
-Install the OpenStudio SDK [3.6.1](https://github.com/NREL/OpenStudio/releases/tag/v3.6.1), or the OpenStudio Application [1.6.0](https://github.com/openstudiocoalition/OpenStudioApplication/releases/tag/v1.6.0).
-
-Create a new file ```C:\Ruby27-x64\lib\ruby\site_ruby\openstudio.rb``` (path may be different depending on the environment), and edit it so it _points_ to your new OpenStudio installation:
+Install OpenStudio [3.10.0](https://github.com/NREL/OpenStudio/releases/tag/v3.10.0), or the OpenStudioApplication [1.10.0](https://github.com/openstudiocoalition/OpenStudioApplication/releases/tag/v1.10.0).
 
+Create a new file ```C:\Ruby32-x64\lib\ruby\site_ruby\openstudio.rb``` (path may be different depending on the environment), and edit it so it _points_ to your new OpenStudio installation:
 ```
-require 'C:\openstudio-3.6.1\Ruby\openstudio.rb'
+require 'C:\openstudio-3.10.0\Ruby\openstudio.rb'
 ```
 
 Verify your OpenStudio and Ruby configuration:
@@ -54,65 +51,62 @@ ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new"
 
 ### MacOS Installation
 
-MacOS already comes with Ruby, but likely not the right Ruby version for the desired OpenStudio measure development [environment](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix). Instructions here show how to install Ruby v2.7.2 alongside MacOS's own Ruby version. Although no longer officially supported, instructions for an OpenStudio v2.9.1 setup is described [here](https://github.com/rd2/tbd/blob/master/v291_MacOS.md).
+MacOS already comes with Ruby, but likely not the right Ruby version for the desired OpenStudio measure development [environment](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix). Instructions here show how to install Ruby v3.2.2 alongside MacOS's own Ruby version. Although no longer officially supported, instructions for an OpenStudio v2.9.1 setup is described [here](https://github.com/rd2/tbd/blob/master/v291_MacOS.md).
 
 From a Terminal, install [Homebrew](https://brew.sh/index) - nice for package distribution and management. Using Homebrew, install _rbenv_ (which allows users to manage multiple Ruby versions) and finally Ruby:
-
 ```
 brew install rbenv
 rbenv init
-rbenv install 2.7.2
-```
-Install [bundler](https://bundler.io) (if not already installed), great for managing Ruby gems and dependencies:
-
-```
-bundler -v
-gem install bundler -v 2.1
+rbenv install 3.2.2
 ```
 
 In the Terminal, check the Ruby version:
-
 ```
 ruby -v
 ```
 
-... should still report the current Ruby version used by MacOS. To ensure the right version is used for developing OpenStudio Measures, instruct _rbenv_ to switch Ruby version _locally_ within a user’s chosen directory (e.g. "sandbox361"):
-
+... should still report the current Ruby version used by MacOS. To ensure the right version is used for developing OpenStudio Measures, instruct _rbenv_ to switch Ruby version _locally_ within a user’s chosen directory (e.g. "sandbox380"):
 ```
-mkdir ~/Documents/sandbox361
-cd ~/Documents/sandbox361
-rbenv local 2.7.2
+mkdir ~/Documents/sandbox380
+cd ~/Documents/sandbox380
+rbenv local 3.2.2
 ruby -v
 ```
-… should report the desired _local_ Ruby version, to be used by default for anything under the "sandbox361" directory tree. To ensure both Ruby versions are operational and safe, run the following checkup twice - once from a user’s home (or ~/), then from within e.g. "sandbox361":
 
+… should now report the desired _local_ Ruby version, to be used by default for anything under the "sandbox380" directory tree. To ensure both Ruby versions are operational and safe, run the following checkup twice - once from a user’s home (or ~/), then from within e.g. "sandbox380":
 ```
 cd ~/
 ruby -ropen-uri -e 'eval URI.open("https://git.io/vQhWq").read'
-cd ~/Documents/sandbox361
+cd ~/Documents/sandbox380
 ruby -ropen-uri -e 'eval URI.open("https://git.io/vQhWq").read'
 ```
 
 If successful, one should get a ```Hooray!``` from both Ruby versions confirming valid communication with [Rubygems](https://rubygems.org/).
 
-Install the OpenStudio SDK [3.6.1](https://github.com/NREL/OpenStudio/releases/tag/v3.6.1), or the OpenStudio Application [1.6.0](https://github.com/openstudiocoalition/OpenStudioApplication/releases/tag/v1.6.0).
+[Bundler](https://bundler.io) is also required for managing Ruby gems and dependencies. With _rbenv_, the right _Bundler_ version should have been installed. If for whatever reason it wasn't installed:
+```
+bundler -v
+gem install bundler -v 2.4.10
+```
 
-Create a new file ```~/.rbenv/versions/2.7.2/lib/ruby/site_ruby/openstudio.rb```  (path may be different depending on the environment), and edit it so it _points_ to your new OpenStudio installation:
+Install OpenStudio [3.10.0](https://github.com/NREL/OpenStudio/releases/tag/v3.10.0), or the OpenStudio Application [1.10.0](https://github.com/openstudiocoalition/OpenStudioApplication/releases/tag/v1.10.0).
 
+Create a new file ```~/.rbenv/versions/3.2.2/lib/ruby/site_ruby/openstudio.rb``` (path may be different depending on the environment), and edit it so it _points_ to your new OpenStudio installation:
 ```
-require '/Applications/OpenStudio-3.6.1/Ruby/openstudio.rb'
+require '/Applications/OpenStudio-3.10.0/Ruby/openstudio.rb'
 ```
 
 Verify your local OpenStudio and Ruby configuration:
-
 ```
-cd ~/Documents/sandbox361
+cd ~/Documents/sandbox310
 ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new"
 ```
 
+Make sure you have latest version of _git_ (e.g. through Homebrew).
+
 ## Clone TBD
 
-Once done with either the Windows or MacOS setup, install the latest version of _git_ (e.g. through Homebrew), then ```git clone``` the TBD repo, e.g. under "sandbox361". Run the basic tests below to ensure the measure operates as expected.
+Once done with either the Windows or MacOS setup, ```git clone``` the TBD repo, e.g. under "sandbox380". Run the basic tests below to ensure the measure operates as expected.
 
 ## Complete list of test commands
 
@@ -127,14 +121,14 @@ bundle exec rake
 
 Install [Docker](https://docs.docker.com/desktop/#download-and-install).
 
-Pull the OpenStudio v3.6.1 Docker image:
+Pull the OpenStudio v3.10.0 Docker image:
 ```
-docker pull nrel/openstudio:3.6.1
+docker pull nrel/openstudio:3.10.0
 ```
 
 In the root repository:
 ```
-docker run --name test --rm -d -t -v ${PWD}:/work -w /work nrel/openstudio:3.6.1
+docker run --name test --rm -d -t -v ${PWD}:/work -w /work nrel/openstudio:3.10.0
 docker exec -t test bundle update
 docker exec -t test bundle exec rake
 docker kill test

data/lib/measures/tbd/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2024 Denis Bourgeois & Dan Macumber
+Copyright (c) 2020-2025 Denis Bourgeois & Dan Macumber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/measures/tbd/measure.rb

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2020-2024 Denis Bourgeois & Dan Macumber
+# Copyright (c) 2020-2025 Denis Bourgeois & Dan Macumber
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/measures/tbd/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>tbd_measure</name>
   <uid>8890787b-8c25-4dc8-8641-b6be1b6c2357</uid>
-  <version_id>70223737-c3ea-4df0-8506-67083c92fb6e</version_id>
-  <version_modified>2024-11-20T20:02:15Z</version_modified>
+  <version_id>0e1528a0-a176-4d46-82d9-d2da40c0abd7</version_id>
+  <version_modified>2025-09-11T11:27:14Z</version_modified>
   <xml_checksum>99772807</xml_checksum>
   <class_name>TBDMeasure</class_name>
   <display_name>Thermal Bridging and Derating - TBD</display_name>
@@ -464,7 +464,7 @@
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>5C9BFB50</checksum>
+      <checksum>3EBCA5DB</checksum>
     </file>
     <file>
       <filename>README.md</filename>
@@ -493,13 +493,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>A472E915</checksum>
+      <checksum>3FBDA0C2</checksum>
     </file>
     <file>
       <filename>geo.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>9FAC0CDC</checksum>
+      <checksum>5AB24CFB</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>
@@ -517,19 +517,19 @@
       <filename>oslog.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>8CD57B9A</checksum>
+      <checksum>586805C4</checksum>
     </file>
     <file>
       <filename>psi.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>4B7F3586</checksum>
+      <checksum>29905280</checksum>
     </file>
     <file>
       <filename>tbd.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>FCCCAE84</checksum>
+      <checksum>9E26251E</checksum>
     </file>
     <file>
       <filename>transformation.rb</filename>
@@ -541,13 +541,13 @@
       <filename>ua.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>626D3BE0</checksum>
+      <checksum>0CC24D82</checksum>
     </file>
     <file>
       <filename>utils.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>CBC3935D</checksum>
+      <checksum>6940D006</checksum>
     </file>
     <file>
       <filename>version.rb</filename>
@@ -565,7 +565,7 @@
       <filename>tbd_tests.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>2ECE06CA</checksum>
+      <checksum>9C76CD98</checksum>
     </file>
   </files>
 </measure>

data/lib/measures/tbd/resources/geo.rb

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2020-2024 Denis Bourgeois & Dan Macumber
+# Copyright (c) 2020-2025 Denis Bourgeois & Dan Macumber
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -310,23 +310,24 @@ module TBD
     end
 
     unless surface.construction.empty?
-      construction = surface.construction.get.to_LayeredConstruction
+      lc = surface.construction.get.to_LayeredConstruction
 
-      unless construction.empty?
-        construction = construction.get
-        lyr          = insulatingLayer(construction)
-        lyr[:index]  = nil unless lyr[:index].is_a?(Numeric)
-        lyr[:index]  = nil unless lyr[:index] >= 0
-        lyr[:index]  = nil unless lyr[:index] < construction.layers.size
+      unless lc.empty?
+        lc  = lc.get
+        lyr = insulatingLayer(lc)
 
-        if lyr[:index]
-          surf[:construction] = construction
+        if lyr[:index].is_a?(Integer) && lyr[:index].between?(0, lc.numLayers - 1)
+          surf[:construction] = lc
           # index: ... of layer/material (to derate) within construction
           # ltype: either :massless (RSi) or :standard (k + d)
           # r    : initial RSi value of the indexed layer to derate
           surf[:index] = lyr[:index]
           surf[:ltype] = lyr[:type ]
           surf[:r    ] = lyr[:r    ]
+        else
+          surf[:index] = nil
+          surf[:ltype] = nil
+          surf[:r    ] = 0.0
         end
       end
     end