tbd 3.2.3 → 3.4.0

data/lib/tbd/version.rb

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2020-2023 Denis Bourgeois & Dan Macumber
+# Copyright (c) 2020-2024 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.2.3".freeze
+  VERSION = "3.4.0".freeze # TBD release version
 end

data/lib/tbd.rb

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2020-2023 Denis Bourgeois & Dan Macumber
+# Copyright (c) 2020-2024 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
@@ -22,72 +22,52 @@
 
 require "openstudio"
 
-begin
-  # Try to load from the Topolys gem.
+begin # try to load from the Topolys gem
   require "topolys"
-
-  # puts "... relying on the Topolys gem"
 rescue LoadError
   require_relative "topolys/model"
   require_relative "topolys/geometry"
   require_relative "topolys/transformation"
   require_relative "topolys/version"
-
-  # puts "... fallback to local Topolys files"
 end
 
-begin
-  # Try to load from the OSlg gem.
+begin # try to load from the Topolys gem
   require "oslg"
-
-  # puts "... relying on the OSlg gem"
 rescue LoadError
   require_relative "oslg/oslog"
   require_relative "osut/version"
-
-  # puts "... fallback to local OSlg files"
 end
 
-begin
-  # Try to load from the OSut gem.
+begin # try to load from the Topolys gem
   require "osut"
-
-  # puts "... relying on the OSut gem"
 rescue LoadError
   require_relative "osut/utils"
   require_relative "osut/version"
-
-  # puts "... fallback to local OSut files"
 end
 
-begin
-  # Try to load from the TBD gem.
+begin # try to load from the Topolys gem
   require "tbd/psi"
   require "tbd/geo"
   require "tbd/ua"
   require "tbd/version"
-
-  # puts "... relying on the TBD gem"
 rescue LoadError
   require_relative "tbd/psi"
   require_relative "tbd/geo"
   require_relative "tbd/ua"
   require_relative "tbd/version"
-
-  # puts "... fallback to local TBD files"
 end
 
 module TBD
-  extend OSut         #                                     OpenStudio utilities
-
-  TOL  = OSut::TOL
-  TOL2 = OSut::TOL2
-  DBG  = OSut::DEBUG  #   mainly to flag invalid arguments for devs (buggy code)
-  INF  = OSut::INFO   #           informs TBD user of measure success or failure
-  WRN  = OSut::WARN   # e.g. WARN users of 'iffy' .osm inputs (yet not critical)
-  ERR  = OSut::ERR    #                            e.g. flag invalid .osm inputs
-  FTL  = OSut::FATAL  #                     e.g. invalid TBD JSON format/entries
-  NS   = "nameString" #                   OpenStudio IdfObject nameString method
+  extend OSut         # OpenStudio utilities
+
+  TOL  = OSut::TOL    # default distance tolerance (m)
+  TOL2 = OSut::TOL2   # default area tolerance (m2)
+  DBG  = OSut::DEBUG  # github.com/rd2/oslg
+  INF  = OSut::INFO   # github.com/rd2/oslg
+  WRN  = OSut::WARN   # github.com/rd2/oslg
+  ERR  = OSut::ERR    # github.com/rd2/oslg
+  FTL  = OSut::FATAL  # github.com/rd2/oslg
+  NS   = "nameString" # OpenStudio IdfObject nameString method
 
   extend TBD
 end

data/tbd.gemspec

@@ -25,11 +25,11 @@ Gem::Specification.new do |s|
   s.bindir                   = "exe"
   s.require_paths            = ["lib"]
   s.executables              = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.required_ruby_version    = [">= 2.5.0", "< 2.7.3"]
+  s.required_ruby_version    = [">= 2.5.0", "< 3"]
   s.metadata                 = {}
 
   s.add_dependency             "topolys",     "~> 0"
-  s.add_dependency             "osut",        "~> 0.3.0"
+  s.add_dependency             "osut",        "~> 0"
   s.add_dependency             "json-schema", "~> 2.7.0"
 
   s.add_development_dependency "bundler",     "~> 2.1"

data/tbd.schema.json

@@ -99,55 +99,171 @@
           "type": "number"
         },
         "parapet": {
-          "title": "Roof/wall edge PSI",
+          "title": "Parapet/overhang edge PSI",
           "type": "number"
         },
         "parapetconcave": {
-          "title": "Concave roof/wall edge PSI",
+          "title": "Concave parapet/overhang edge PSI",
           "type": "number"
         },
         "parapetconvex": {
-          "title": "Convex roof/wall edge PSI",
+          "title": "Convex parapet/overhang edge PSI",
+          "type": "number"
+        },
+        "roof": {
+          "title": "Roof/wall (other than parapet/overhang) edge PSI",
+          "type": "number"
+        },
+        "roofconcave": {
+          "title": "Concave (other than parapet/overhang) roof/wall edge PSI",
+          "type": "number"
+        },
+        "roofconvex": {
+          "title": "Convex (other than parapet/overhang) roof/wall edge PSI",
+          "type": "number"
+        },
+        "ceiling": {
+          "title": "Intermediate ceiling (not floor) edge PSI",
+          "type": "number"
+        },
+        "ceilingconcave": {
+          "title": "Concave intermediate ceiling (not floor) edge PSI",
+          "type": "number"
+        },
+        "ceilingconvex": {
+          "title": "Convex intermediate ceiling (not floor) edge PSI",
           "type": "number"
         },
         "fenestration": {
-          "title": "Window, door, skylight perimeter PSI",
+          "title": "Window or glazed door perimeter PSI",
           "type": "number"
         },
         "head": {
-          "title": "Aperture head/lintel PSI",
+          "title": "Window or glazed door header/lintel PSI",
           "type": "number"
         },
         "headconcave": {
-          "title": "Concave aperture head/lintel PSI",
+          "title": "Concave window or glazed door header/lintel PSI",
           "type": "number"
         },
         "headconvex": {
-          "title": "Convex aperture head/lintel PSI",
+          "title": "Convex window or glazed door header/lintel PSI",
           "type": "number"
         },
         "sill": {
-          "title": "Aperture sill/base PSI",
+          "title": "Window or glazed door sill/threshold PSI",
           "type": "number"
         },
         "sillconcave": {
-          "title": "Concave aperture sill/base PSI",
+          "title": "Concave window or glazed door sill/threshold PSI",
           "type": "number"
         },
         "sillconvex": {
-          "title": "Convex aperture sill/base PSI",
+          "title": "Convex window or glazed door sill/threshold PSI",
           "type": "number"
         },
         "jamb": {
-          "title": "Aperture jamb/side PSI",
+          "title": "Window or glazed door side jamb PSI",
           "type": "number"
         },
         "jambconcave": {
-          "title": "Concave aperture jamb/side PSI",
+          "title": "Concave window or glazed door side jamb PSI",
           "type": "number"
         },
         "jambconvex": {
-          "title": "Convex aperture jamb/side PSI",
+          "title": "Convex window or glazed door side jamb PSI",
+          "type": "number"
+        },
+        "door": {
+          "title": "Opaque door perimeter PSI",
+          "type": "number"
+        },
+        "doorhead": {
+          "title": "Opaque door header/lintel PSI",
+          "type": "number"
+        },
+        "doorheadconcave": {
+          "title": "Concave opaque door header/lintel PSI",
+          "type": "number"
+        },
+        "doorheadconvex": {
+          "title": "Convex opaque door header/lintel PSI",
+          "type": "number"
+        },
+        "doorsill": {
+          "title": "Opaque door sill/threshold PSI",
+          "type": "number"
+        },
+        "doorsillconcave": {
+          "title": "Concave opaque door sill/threshold PSI",
+          "type": "number"
+        },
+        "doorsillconvex": {
+          "title": "Convex opaque door sill/threshold PSI",
+          "type": "number"
+        },
+        "doorjamb": {
+          "title": "Opaque door side jamb PSI",
+          "type": "number"
+        },
+        "doorjambconcave": {
+          "title": "Concave opaque door side jamb PSI",
+          "type": "number"
+        },
+        "doorjambconvex": {
+          "title": "Convex opaque door side jamb PSI",
+          "type": "number"
+        },
+        "skylight": {
+          "title": "Skylight perimeter PSI",
+          "type": "number"
+        },
+        "skylighthead": {
+          "title": "Skylight header/lintel PSI",
+          "type": "number"
+        },
+        "skylightheadconcave": {
+          "title": "Concave skylight header/lintel PSI",
+          "type": "number"
+        },
+        "skylightheadconvex": {
+          "title": "Convex skylight header/lintel PSI",
+          "type": "number"
+        },
+        "skylightsill": {
+          "title": "Skylight sill/threshold PSI",
+          "type": "number"
+        },
+        "skylightsillconcave": {
+          "title": "Concave skylight sill/threshold PSI",
+          "type": "number"
+        },
+        "skylightsillconvex": {
+          "title": "Convex skylight sill/threshold PSI",
+          "type": "number"
+        },
+        "skylightjamb": {
+          "title": "Skylight side jamb PSI",
+          "type": "number"
+        },
+        "skylightjambconcave": {
+          "title": "Concave skylight side jamb PSI",
+          "type": "number"
+        },
+        "skylightjambconvex": {
+          "title": "Convex skylight side jamb PSI",
+          "type": "number"
+        },
+        "spandrel": {
+          "title": "Spandrel/other edge PSI",
+          "type": "number"
+        },
+        "spandrelconcave": {
+          "title": "Concave spandrel/other edge PSI",
+          "type": "number"
+        },
+        "spandrelconvex": {
+          "title": "Convex spandrel/other edge PSI",
           "type": "number"
         },
         "corner": {
@@ -174,6 +290,18 @@
           "title": "Convex floor/balcony edge PSI ",
           "type": "number"
         },
+        "balconysill": {
+          "title": "Floor/balcony/sill edge PSI ",
+          "type": "number"
+        },
+        "balconysillconcave": {
+          "title": "Concave floor/balcony/sill edge PSI ",
+          "type": "number"
+        },
+        "balconysillconvex": {
+          "title": "Convex floor/balcony/sill edge PSI ",
+          "type": "number"
+        },
         "party": {
           "title": "Party wall edge PSI",
           "type": "number"
@@ -194,7 +322,7 @@
           "title": "Concave floor/foundation edge PSI",
           "type": "number"
         },
-        "gradecovex": {
+        "gradeconvex": {
           "title": "Convex floor/foundation edge PSI",
           "type": "number"
         },
@@ -250,6 +378,12 @@
             "parapet",
             "parapetconcave",
             "parapetconvex",
+            "roof",
+            "roofconcave",
+            "roofconvex",
+            "ceiling",
+            "ceilingconcave",
+            "ceilingconvex",
             "fenestration",
             "head",
             "headconcave",
@@ -260,12 +394,38 @@
             "jamb",
             "jambconcave",
             "jambconvex",
+            "door",
+            "doorhead",
+            "doorheadconcave",
+            "doorheadconvex",
+            "doorsill",
+            "doorsillconcave",
+            "doorsillconvex",
+            "doorjamb",
+            "doorjambconcave",
+            "doorjambconvex",
+            "skylight",
+            "skylighthead",
+            "skylightheadconcave",
+            "skylightheadconvex",
+            "skylightsill",
+            "skylightsillconcave",
+            "skylightsillconvex",
+            "skylightjamb",
+            "skylightjambconcave",
+            "skylightjambconvex",
+            "spandrel",
+            "spandrelconcave",
+            "spandrelconvex",
             "corner",
             "cornerconcave",
             "cornerconvex",
             "balcony",
             "balconyconcave",
             "balconyconvex",
+            "balconysill",
+            "balconysillconcave",
+            "balconysillconvex",
             "party",
             "partyconcave",
             "partyconvex",
@@ -355,6 +515,10 @@
           "title": "PSI-set identifier",
           "type": "string"
         },
+        "parapet": {
+          "title": "wall-roof edge as parapet",
+          "type": "boolean"
+        },
         "khis": {
           "title": "Surface-hosted point thermal bridges",
           "type": "array",
@@ -397,12 +561,16 @@
         "psi": {
           "title": "PSI-set identifier",
           "type": "string"
+        },
+        "parapet": {
+          "title": "wall-roof edge as parapet",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
+      "minProperties": 2,
       "required": [
-        "id",
-        "psi"
+        "id"
       ]
     },
     "SpaceType": {
@@ -416,12 +584,16 @@
         "psi": {
           "title": "PSI-set identifier",
           "type": "string"
+        },
+        "parapet": {
+          "title": "wall-roof edge as parapet",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
+      "minProperties": 2,
       "required": [
-        "id",
-        "psi"
+        "id"
       ]
     },
     "Story": {
@@ -435,12 +607,16 @@
         "psi": {
           "title": "PSI-set identifier",
           "type": "string"
+        },
+        "parapet": {
+          "title": "wall-roof edge as parapet",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
+      "minProperties": 2,
       "required": [
-        "id",
-        "psi"
+        "id"
       ]
     },
     "Building": {
@@ -450,9 +626,14 @@
         "psi": {
           "title": "PSI-set identifier",
           "type": "string"
+        },
+        "parapet": {
+          "title": "wall-roof edge as parapet",
+          "type": "boolean"
         }
       },
       "additionalProperties": false,
+      "minProperties": 1,
       "required": [
         "psi"
       ]
@@ -556,6 +737,9 @@
         "corners": {
           "type": "string"
         },
+        "balconies": {
+          "type": "string"
+        },
         "grade": {
           "type": "string"
         },

data/v291_MacOS.md

@@ -1,8 +1,6 @@
-_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")._
+_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)._
 
-_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.4.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._
+_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._
 
 
 ## v2.9.1 MacOS Instructions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tbd
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.4.0
 platform: ruby
 authors:
 - Denis Bourgeois & Dan Macumber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2024-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: topolys
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ files:
 - ".github/workflows/pull_request.yml"
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - Gemfile
 - LICENSE.md
 - README.md
@@ -129,6 +130,10 @@ files:
 - json/tbd_seb_n2.json
 - json/tbd_seb_n4.json
 - json/tbd_warehouse10.json
+- json/tbd_warehouse17.json
+- json/tbd_warehouse18.json
+- json/tbd_warehouse4.json
+- json/tbd_z5.json
 - lib/measures/tbd/LICENSE.md
 - lib/measures/tbd/README.md
 - lib/measures/tbd/README.md.erb
@@ -161,7 +166,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/rd2/tbd
-  source_code_uri: https://github.com/rd2/tbd/tree/v3.2.3
+  source_code_uri: https://github.com/rd2/tbd/tree/v3.4.0
   bug_tracker_uri: https://github.com/rd2/tbd/issues
 post_install_message:
 rdoc_options: []
@@ -174,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="