tbd 3.4.4 → 3.5.0

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,14 @@
 --- !ruby/object:Gem::Specification
 name: tbd
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Denis Bourgeois & Dan Macumber
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2025-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: topolys
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/rd2/tbd
-  source_code_uri: https://github.com/rd2/tbd/tree/v3.4.4
+  source_code_uri: https://github.com/rd2/tbd/tree/v3.5.0
   bug_tracker_uri: https://github.com/rd2/tbd/issues
 post_install_message:
 rdoc_options: []