tbd 3.0.0

data/lib/tbd/version.rb

@@ -0,0 +1,25 @@
+# MIT License
+#
+# Copyright (c) 2020-2022 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+module TBD
+  VERSION = "3.0.0".freeze
+end

data/lib/tbd.rb

@@ -0,0 +1,93 @@
+# MIT License
+#
+# Copyright (c) 2020-2022 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require "openstudio"
+
+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.
+  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.
+  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.
+  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 TBD
+end

data/tbd.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tbd/version"
+
+Gem::Specification.new do |s|
+  # Specify which files should be added to the gem when it is released.
+  # "git ls-files -z" loads files in the RubyGem that have been added into git.
+  s.files                 = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  s.name                     = "tbd"
+  s.version                  = TBD::VERSION
+  s.license                  = "MIT"
+  s.summary                  = "Thermal Bridging and Derating (for OpenStudio)"
+  s.description              = "An OpenStudio Measure that autodetects major " \
+                               "thermal bridges in a model, and then derates " \
+                               "outside-facing, opaque surface constructions."
+  s.authors                  = ["Denis Bourgeois & Dan Macumber"]
+  s.email                    = ["denis@rd2.ca"]
+  s.platform                 = Gem::Platform::RUBY
+  s.homepage                 = "https://github.com/rd2/tbd"
+  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.metadata                 = {}
+
+  s.add_dependency             "topolys",     "~> 0"
+  s.add_dependency             "osut",        "~> 0"
+  s.add_dependency             "json-schema", "~> 2.7.0"
+
+  s.add_development_dependency "bundler",     "~> 2.1"
+  s.add_development_dependency "rake",        "~> 13.0"
+  s.add_development_dependency "rspec",       "~> 3.11"
+  s.add_development_dependency "parallel",    "~> 1.19.2"
+
+  s.metadata["homepage_uri"   ] =    s.homepage
+  s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}"
+  s.metadata["bug_tracker_uri"] = "#{s.homepage}/issues"
+end