tbd 3.4.3 → 3.4.5

data/lib/measures/tbd/tests/tbd_tests.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/tbd/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
@@ -722,15 +722,10 @@ module TBD
       kva = true unless surface.surfacePropertyExposedFoundationPerimeter.empty?
       surface.resetAdjacentFoundation
       surface.resetSurfacePropertyExposedFoundationPerimeter
-      next unless surface.isGroundSurface
       next     if surface.outsideBoundaryCondition.capitalize == boundary
+      next unless surface.outsideBoundaryCondition.capitalize == "Foundation"
 
-      lc = surface.construction.empty? ? nil : surface.construction.get
       surface.setOutsideBoundaryCondition(boundary)
-      next if boundary == "Ground"
-      next if lc.nil?
-
-      surface.setConstruction(lc) if surface.construction.empty?
     end
 
     perimeters = model.getSurfacePropertyExposedFoundationPerimeters
@@ -834,11 +829,16 @@ module TBD
     edges.each do |code1, edge|
       edge[:surfaces].keys.each do |id|
         next unless floors.key?(id)
+
         next unless floors[id][:boundary].downcase == "foundation"
         next     if floors[id].key?(:kiva)
 
-        floors[id][:kiva   ] = :slab # initially slabs-on-grade
-        floors[id][:exposed] = 0.0   # slab-on-grade or walkout perimeter
+        # Initially set as slab-on-grade. Track 'exposed foundation perimeter'.
+        #   - outdoor wall/slab-on-grade edge lengths
+        #   - outdoor wall/basement slab walkout edge lengths
+        #   - basement wall/basement slab edge lengths
+        floors[id][:kiva   ] = :slab
+        floors[id][:exposed] = 0.0
 
         # Loop around current edge.
         edge[:surfaces].keys.each do |i|
@@ -847,8 +847,9 @@ module TBD
           next unless walls[i][:boundary].downcase == "foundation"
           next     if walls[i].key?(:kiva)
 
-          floors[id][:kiva] = :basement
-          walls[i  ][:kiva] = id
+          floors[id][:kiva   ]  = :basement
+          floors[id][:exposed] += edge[:length]
+          walls[i  ][:kiva   ]  = id
         end
 
         # Loop around current edge.
@@ -862,7 +863,7 @@ module TBD
 
         # Loop around other floor edges.
         edges.each do |code2, e|
-          next if code1 == code2 #  skip - same edge
+          next if code1 == code2 # skip - same edge
 
           e[:surfaces].keys.each do |i|
             next unless i == id # good - same floor
@@ -873,8 +874,9 @@ module TBD
               next unless walls[ii][:boundary].downcase == "foundation"
               next     if walls[ii].key?(:kiva)
 
-              floors[id][:kiva] = :basement
-              walls[ii ][:kiva] = id
+              floors[id][:kiva   ]  = :basement
+              walls[ii ][:kiva   ]  = id
+              floors[id][:exposed] += e[:length]
             end
 
             e[:surfaces].keys.each do |ii|
@@ -889,6 +891,7 @@ module TBD
 
         foundation = OpenStudio::Model::FoundationKiva.new(model)
         foundation.setName("KIVA Foundation Floor #{id}")
+
         floor = model.getSurfaceByName(id)
         kiva  = false if floor.empty?
         next          if floor.empty?

data/lib/tbd/psi.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
@@ -1678,8 +1678,8 @@ module TBD
     # around edge with respect to a reference vector (perpendicular to the
     # edge), +clockwise as one is looking in the opposite position of the edge
     # vector. For instance, a vertical edge has a reference vector pointing
-    # North - surfaces eastward of the edge are (0°,180°], while surfaces
-    # westward of the edge are (180°,360°].
+    # North - surfaces eastward of the edge are (0deg,180deg], while surfaces
+    # westward of the edge are (180deg,360deg].
     #
     # Much of the following code is of a topological nature, and should ideally
     # (or eventually) become available functionality offered by Topolys. Topolys
@@ -1741,7 +1741,7 @@ module TBD
 
           angle  = reference_V.angle(farthest_V)
           angle  = 0 if angle.nil?
-          adjust = false # adjust angle [180°, 360°] if necessary
+          adjust = false # adjust angle [180deg, 360deg] if necessary
 
           if vertical
             adjust = true if east.dot(farthest_V) < -TOL

data/lib/tbd/ua.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
@@ -422,8 +422,8 @@ module TBD
   # @param [Hash] s TBD surfaces (keys: Openstudio surface names)
   # @option s [Bool] :deratable whether surface is deratable, s[][:deratable]
   # @option s [:wall, :ceiling, :floor] :type TBD surface type
-  # @option s [#to_f] :heating applicable heating setpoint temperature in °C
-  # @option s [#to_f] :cooling applicable cooling setpoint temperature in °C
+  # @option s [#to_f] :heating applicable heating setpoint temperature in C
+  # @option s [#to_f] :cooling applicable cooling setpoint temperature in C
   # @option s [Hash] :windows TBD surface-specific windows e.g. s[][:windows]
   # @option s [Hash] :doors TBD surface-specific doors
   # @option s [Hash] :skylights TBD surface-specific skylights
@@ -466,7 +466,7 @@ module TBD
       ref = 1 / 5.46
       ref = 1 / 3.60 if surface[:type] == :wall
 
-      # Adjust for lower heating setpoint (assumes -25°C design conditions).
+      # Adjust for lower heating setpoint (assumes -25C design conditions).
       ref *= 43 / (heating + 25) if heating < 18 && cooling > 40
 
       surface[:ref] = ref
@@ -628,8 +628,8 @@ module TBD
     end
 
     # Set up 2x heating setpoint (HSTP) "blocks" (or bins):
-    #   bloc1: spaces/zones with HSTP >= 18°C
-    #   bloc2: spaces/zones with HSTP < 18°C
+    #   bloc1: spaces/zones with HSTP >= 18C
+    #   bloc2: spaces/zones with HSTP < 18C
     #   (ref: 2021 Quebec energy code 3.3. UA' trade-off methodology)
     #   (... can be extended in the future to cover other standards)
     #
@@ -1000,7 +1000,7 @@ module TBD
       model  = "* modèle : #{ua[:file]}"    if ua.key?(:file)  && lang == :fr
       model += " (v#{ua[:version]})"        if ua.key?(:version)
       report << model                   unless model.empty?
-      report << "* TBD : v3.4.3"
+      report << "* TBD : v3.4.5"
       report << "* date : #{ua[:date]}"
 
       if lang == :en

data/lib/tbd/version.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
@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module TBD
-  VERSION = "3.4.3".freeze # TBD release version
+  VERSION = "3.4.5".freeze
 end

data/lib/tbd.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/tbd.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.metadata                 = {}
 
   s.add_dependency             "topolys",     "~> 0"
-  s.add_dependency             "osut",        "~> 0"
+  s.add_dependency             "osut",        "~> 0.7.0"
   s.add_dependency             "json-schema", "~> 4"
 
   s.add_development_dependency "bundler",     "~> 2.1"

data/tbd.schema.json

@@ -267,15 +267,15 @@
           "type": "number"
         },
         "corner": {
-          "title": "Any wall corner [0°,135°) or (225°,360°] PSI",
+          "title": "Any wall corner [0deg,135deg) or (225deg,360deg] PSI",
           "type": "number"
         },
         "cornerconcave": {
-          "title": "Concave wall corner [0°,135°) PSI",
+          "title": "Concave wall corner [0deg,135deg) PSI",
           "type": "number"
         },
         "cornerconvex": {
-          "title": "Convex wall corner (225°,360°] PSI",
+          "title": "Convex wall corner (225deg,360deg] PSI",
           "type": "number"
         },
         "balcony": {
@@ -655,12 +655,12 @@
           "type": "object",
           "properties": {
             "bloc1": {
-              "title": "heating setpoints >= 18°C",
+              "title": "heating setpoints >= 18C",
               "type": "object",
               "$ref": "#/definitions/UaBlock"
             },
             "bloc2": {
-              "title": "heating setpoints < 18°C",
+              "title": "heating setpoints < 18C",
               "type": "object",
               "$ref": "#/definitions/UaBlock"
             }

data/v291_MacOS.md

@@ -1,15 +1,14 @@
 _We reiterate that building professionals and energy modellers 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"). Those instead interested in exploring/tweaking the source code (cloned or forked versions of TBD) can follow the Windows or MacOS Ruby setup described in TBD's [README](https://github.com/rd2/tbd#readme)._
 
-_The MacOS instructions below specifically target (older) Ruby v2.2.5 environments, needed for developing OpenStudio [v2.9.1](https://github.com/NREL/OpenStudio/releases/tag/v2.9.1) measures - the most up-to-date version that remains [compatible](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix) with [SketchUp Make 2017](https://help.sketchup.com/en/downloading-older-versions). More recent OpenStudio versions (e.g. v3.6.1) can - to a large degree - safely translate older .osm files. Although TBD (and Topolys) are systematically tested against updated OpenStudio versions (v2.9.1 onwards), the following Ruby v2.2.5 setup is no longer tested or maintained. Nonetheless, it may be of some help for the more adventurous of you._
+_The MacOS instructions below specifically target (older) Ruby v2.2.5 environments, needed for developing OpenStudio [v2.9.1](https://github.com/NREL/OpenStudio/releases/tag/v2.9.1) measures - the most up-to-date version that remains [compatible](https://github.com/NREL/OpenStudio/wiki/OpenStudio-SDK-Version-Compatibility-Matrix) with [SketchUp Make 2017](https://help.sketchup.com/en/downloading-older-versions). More recent OpenStudio versions (e.g. v3.8.0) can - to a large degree - safely translate older .osm files. Although TBD (and Topolys) are systematically tested against updated OpenStudio versions (v2.9.1 onwards), the following Ruby v2.2.5 setup is no longer tested or maintained. Nonetheless, it may be of some help for the more adventurous of you._
 
 
 ## v2.9.1 MacOS Instructions
 _tested Catalina 10.15.4 up to Big Sur 11.4_
 
-OpenStudio v2.9.1 measures require Ruby v2.2.5, which is several iterations behind the default Ruby v2.6 version available on any recently-purchased Mac. Although it is common to develop/test using more than one Ruby version, some effort is nonetheless required for older vintages: v2.2.5 is no longer officially supported, it requires the deprecated OpenSSL-1.0 (not 1.1), etc. To help Mac users (and potentially Linux users as well), the following steps are recommended (although architecture-specific tweaks may be required).
+OpenStudio v2.9.1 measures require Ruby v2.2.5, which is several iterations behind the default Ruby v2.6 version available on any recently-purchased Mac. Although it is common to develop/test using more than one Ruby version, some effort is nonetheless required for older vintages: v2.2.5 is way past its shelf-life, it requires the deprecated OpenSSL-1.0 (not 1.1), etc. To help Mac users (and potentially Linux users as well), the following steps are recommended (although architecture-specific tweaks may be required).
 
 From a Terminal, install [Homebrew](https://brew.sh/index) - nice for package distribution and management. With a few tweaks, it will handle most package downloads, dependencies, etc. Using Homebrew, install OpenSSL-1.0, and then _rbenv_ (which allows users to manage multiple Ruby versions). One way of doing it:
-
 ```
 brew install rbenv/tap/openssl@1.0
 ```
@@ -17,7 +16,6 @@ brew install rbenv/tap/openssl@1.0
 By _tapping_, Homebrew provides a way to access third-party repositories that are no longer officially supported by Homebrew, like Ruby v2.2.5 and OpenSSL-1.0. The above instruction tells Homebrew to install compatible versions of OpenSSL-1.0 with _rbenv_ (e.g. 1.0.2t, 1.0.2u).
 
 Next, ensure that Homebrew and _rbenv_ use OpenSSL-1.0 for future, local Ruby development. Edit (or create) a user’s local _~/.zshrc_ file (instructions here are provided for _zsh_, the default macOS Terminal shell interface - _bash_ users: adapt!), by pasting-in the following:
-
 ```
 eval "$(rbenv init - zsh)"
 export PATH="/usr/local/opt/openssl@1.0/bin:$PATH"
@@ -28,48 +26,29 @@ export RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix openssl@1.0)"
 ```
 
 There’s probably more there than necessary, but it should do the trick for the next few steps, and/or for future work. Quit the Terminal and start a new one, or simply _source_ the zshrc file:
-
 ```
 source ~/.zshrc
 ```
 
 Make sure the right OpenSSL version is recognized, and then instruct Homebrew to switch over to it:
-
 ```
 openssl version
 brew switch openssl 1.0.2t
 ```
 
 … or whatever Openssl 1.0 version was installed, e.g. 1.0.2u. Then install _ruby-build_, _rbenv_ and finally Ruby v2.2.5:
-
 ```
 brew install ruby-build
 brew install rbenv
 rbenv install 2.2.5
 ```
 
-Install a compatible version of [bundler](https://bundler.io), great for managing Ruby gems and dependencies:
-
-```
-gem install bundler -v 1.17.3
-```
-In some cases, (temporarily) switching over to an insecure ```http``` connection to rubygems.org (instead of the default ```https```) may be required:
-```
-gem source -r https://rubygems.org/
-gem source -a http://rubygems.org/
-gem install bundler -v 1.17.3
-gem source -r http://rubygems.org/
-gem source -a https://rubygems.org/
-```
-
 In the Terminal, check the Ruby version:
-
 ```
 ruby -v
 ```
 
 ... should still report the current Ruby version used by macOS (e.g. ```system``` or ```2.6```). To ensure Ruby v2.2.5 is used for developing OpenStudio v2.9.1-compatible measures, instruct _rbenv_ to use Ruby v2.2.5 _locally_ within a user’s chosen directory (e.g. "sandbox291"):
-
 ```
 mkdir ~/Documents/sandbox291
 cd ~/Documents/sandbox291
@@ -78,7 +57,6 @@ ruby -v
 ```
 
 … should now report ```2.2.5``` as the local Ruby version, to be used by default for anything under the "sandbox291" 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., "sandbox291":
-
 ```
 cd ~/
 ruby -ropen-uri -e 'eval open("https://git.io/vQhWq").read'
@@ -88,21 +66,34 @@ ruby -ropen-uri -e 'eval 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/), yet with their specific RubyGems and OpenSSL versions, as well as their own SSL certificates.
 
-Install OpenStudio [v2.9.1](https://github.com/NREL/OpenStudio/releases/tag/v2.9.1).
+[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 1.17.3
+```
+
+In some cases, (temporarily) switching over to an insecure ```http``` connection to rubygems.org (instead of the default ```https```) may be required:
+```
+gem source -r https://rubygems.org/
+gem source -a http://rubygems.org/
+gem install bundler -v 1.17.3
+gem source -r http://rubygems.org/
+gem source -a https://rubygems.org/
+```
 
-Then create the file _~/.rbenv/versions/2.2.5/lib/ruby/site_ruby/openstudio.rb_, and edit it so it _points_ to your new OpenStudio installation:
+Install OpenStudio [v2.9.1](https://github.com/NREL/OpenStudio/releases/tag/v2.9.1).
 
+Create a new file ```~/.rbenv/versions/2.2.5/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-2.9.1/Ruby/openstudio.rb'
 ```
 
 Verify your local OpenStudio and Ruby configuration:
-
 ```
 cd ~/Documents/sandbox291
 ruby -e "require 'openstudio'" -e "puts OpenStudio::Model::Model.new"
 ```
 
-Install the latest version of _git_ (e.g. through Homebrew), and ```git clone``` the TBD measure under e.g., "sandbox291".
+Make sure you have latest version of _git_ (e.g. through Homebrew), then ```git clone``` the TBD measure under e.g., "sandbox291".
 
 Run the basic [tests](https://github.com/rd2/tbd#complete-list-of-test-commands) to ensure the measure operates as expected.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tbd
 version: !ruby/object:Gem::Version
-  version: 3.4.3
+  version: 3.4.5
 platform: ruby
 authors:
 - Denis Bourgeois & Dan Macumber
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: topolys
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -166,9 +165,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/rd2/tbd
-  source_code_uri: https://github.com/rd2/tbd/tree/v3.4.3
+  source_code_uri: https://github.com/rd2/tbd/tree/v3.4.5
   bug_tracker_uri: https://github.com/rd2/tbd/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Thermal Bridging and Derating (for OpenStudio)
 test_files: []