openstudio-recommendation-engine 0.1.0

data/lib/openstudio/helpers/safe_load.rb

@@ -0,0 +1,39 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#  
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#  
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#####################################################################
+
+#load a model into OS & version translates, exiting and erroring if a problem is found
+module OpenStudio
+  def safe_load_model(model_path_string)
+    model_path = OpenStudio::Path.new(model_path_string)
+    if OpenStudio::exists(model_path)
+      versionTranslator = OpenStudio::OSVersion::VersionTranslator.new
+      model = versionTranslator.loadModel(model_path)
+      if model.empty?
+        puts "Version translation failed for #{model_path_string}"
+        exit
+      else
+        model = model.get
+      end
+    else
+      raise "#{model_path_string} couldn't be found"
+    end
+    return model
+  end
+  module_function :safe_load_model
+end

data/lib/openstudio/recommendation_engine/recommendation_engine.rb

@@ -0,0 +1,143 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#  
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#  
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#####################################################################
+
+module OpenStudio
+  module RecommendationEngine
+    class RecommendationEngine
+      def initialize(model, path_to_measures)
+        @model = model
+        @path_to_measures = path_to_measures
+        
+        init
+      end
+
+      def init
+        measure_checks = Dir.glob("#{@path_to_measures}/**/recommendation.rb")
+       
+        puts "List of measures: #{measure_checks.inspect}"
+        results = []
+        measure_checks.each do |measure|
+          require "#{File.expand_path(measure)}"
+
+          measure_class_name = File.basename(File.expand_path("../..",measure))
+          puts "measure class name is: #{measure_class_name}"
+          
+          m = measure_class_name.constantize.new
+          puts m.inspect
+          
+          # recommendation engine ?
+          #require "#{a.name}::MeasureApplciblitychere.new()."
+          
+          if @model
+            measure_check = Measure::MeasureApplicabilityChecker.new(@model)
+            measure_check.check_applicability  
+          else
+            raise "No model passed into the recommendation engine"
+          end
+          
+          
+          results << measure_check.result
+        end
+
+        return results
+
+      end
+
+    end
+  end
+
+
+end
+
+# Microsoft Windows [Version 6.1.7601]
+# Copyright (c) 2009 Microsoft Corporation.  All rights reserved.
+
+# C:\Users\aparker>irb
+# irb(main):001:0> require
+# ArgumentError: wrong number of arguments (0 for 1)
+# from (irb):1:in `require'
+# from (irb):1
+# irb(main):002:0> ^C
+# irb(main):002:0> exit
+# Terminate batch job (Y/N)? n
+
+# C:\Users\aparker>gem install parallel
+# Fetching: parallel-0.9.2.gem (100%)
+# Successfully installed parallel-0.9.2
+# 1 gem installed
+# Installing ri documentation for parallel-0.9.2...
+# Installing RDoc documentation for parallel-0.9.2...
+
+# C:\Users\aparker>irb
+# irb(main):001:0> Parallel.each(['a','b','c']){|a| puts a}
+# NameError: uninitialized constant Parallel
+# from (irb):1
+# irb(main):002:0> require 'parallel'
+# LoadError: no such file to load -- parallel
+# from (irb):2:in `require'
+# from (irb):2
+# irb(main):003:0> require 'rubygems'
+# => true
+# irb(main):004:0> require 'parallel'
+# => true
+# irb(main):005:0> Parallel.each(['a','b','c']){|a| puts a}
+# NotImplementedError: fork() function is unimplemented on this machine
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:291:in `fork'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:291:in `worker'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:279:in `create_workers'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:278:in `each'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:278:in `create_workers'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:242:in `work_in_processes'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:114:in `map'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:81:in `each'
+# from (irb):5
+# irb(main):006:0> Parallel.each(['a','b','c'], :in_threads => 3){|a| puts a}
+# abc
+
+
+# => ["a", "b", "c"]
+# irb(main):007:0> Parallel.each(['a','b','c'], :in_threads => 1){|a| puts a}
+# a
+# b
+# c
+# => ["a", "b", "c"]
+# irb(main):008:0> Parallel.each(['a','b','c'], :in_threads => 2){|a| puts wait 10}
+# NoMethodError: undefined method `wait' for main:Object
+# from (irb):8
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:386:in `call'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:386:in `call_with_index'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:229:in `work_in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:397:in `with_instrumentation'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:227:in `work_in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:221:in `loop'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:221:in `work_in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:65:in `in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:64:in `initialize'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:64:in `new'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:64:in `in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:63:in `times'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:63:in `in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:219:in `work_in_threads'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:112:in `map'
+# from C:/Ruby187/lib/ruby/gems/1.8/gems/parallel-0.9.2/lib/parallel.rb:81:in `each'
+# from (irb):8
+# from ♥:0irb(main):009:0> Parallel.each(['a','b','c'], :in_threads => 2){|Terminate batch job (Y/N)?
+# ^C
+# C:\Users\aparker>irb
+# irb(main):001:0>

data/lib/openstudio/recommendation_engine/version.rb

@@ -0,0 +1,24 @@
+######################################################################
+#  Copyright (c) 2008-2013, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+module OpenStudio
+  module RecommendationEngine
+    VERSION = "0.1.0"
+  end
+end

data/lib/recommendation_engine.rb

@@ -0,0 +1,17 @@
+require 'rubygems'   # for 1.8.7
+                    
+begin
+  require 'openstudio'
+  $openstudio_loaded = true
+rescue
+  $openstudio_loaded = false
+end
+
+require 'active_support/core_ext/string' # for constantize
+require 'parallel'
+require 'openstudio/recommendation_engine/recommendation_engine'
+require 'openstudio/recommendation_engine/version'
+require 'openstudio/helpers/safe_load'
+
+
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: openstudio-recommendation-engine
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nicholas Long
+- Andrew Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: parallel
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+description: This gem contains the framework needed to execute the recommendation engine on measures that have defined their recommendations.
+email: Nicholas.Long@nrel.gov
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/openstudio/helpers/safe_load.rb
+- lib/openstudio/recommendation_engine/recommendation_engine.rb
+- lib/openstudio/recommendation_engine/version.rb
+- lib/recommendation_engine.rb
+homepage: http://openstudio.nrel.gov
+licenses: 
+- LGPL
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: OpenStudio Recommendation EngineL
+test_files: []
+