openstudio-analysis 1.0.2 → 1.1.0.pre.rc1

data/lib/openstudio/analysis/workflow.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -53,8 +53,7 @@ module OpenStudio
         @items.clear
       end
 
-      # Add a measure to the workflow from a path. Inside the path it is expecting to have a measure.json file
-      # if not, the BCL gem is used to create the measure.json file.
+      # Add a measure to the workflow from a path. This will parse the measure.xml which must exist.
       #
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with uni que names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
@@ -69,19 +68,11 @@ module OpenStudio
         end
 
         if Dir.exist?(local_path_to_measure) && File.directory?(local_path_to_measure)
-          # Watch out for namespace conflicts (use ::BCL)
-          b = ::BCL::ComponentMethods.new
           measure_hash = nil
-          unless File.exist?(File.join(local_path_to_measure, 'measure.json'))
-            measure_hash = b.parse_measure_file(nil, File.join(local_path_to_measure, measure_filename))
-            File.open(File.join(local_path_to_measure, 'measure.json'), 'w') { |f| f << JSON.pretty_generate(measure_hash) }
-            warn("measure.json not found in #{local_path_to_measure}, will parse measure file using BCL gem")
-          end
-
-          if measure_hash.nil? && File.exist?(File.join(local_path_to_measure, 'measure.json'))
-            measure_hash = JSON.parse(File.read(File.join(local_path_to_measure, 'measure.json')), symbolize_names: true)
-          elsif measure_hash.nil?
-            raise 'measure.json was not found and was not automatically created'
+          if File.exist?(File.join(local_path_to_measure, 'measure.xml'))
+            measure_hash = parse_measure_xml(File.join(local_path_to_measure, 'measure.xml'))
+          else
+            raise 'Could not find measure.xml'
           end
 
           add_measure(instance_name, instance_display_name, local_path_to_measure, measure_hash)
@@ -92,12 +83,12 @@ module OpenStudio
         @items.last
       end
 
-      # Add a measure from the custom hash format without reading the measure.rb or measure.json file
+      # Add a measure from the custom hash format without reading the measure.rb or measure.xml file
       #
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @param local_path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
-      # @param measure_metadata [Hash] Format of the measure.json
+      # @param measure_metadata [Hash] Format of the measure.xml in JSON format
       # @return [Object] Returns the measure that was added as an OpenStudio::AnalysisWorkflowStep object
       def add_measure(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
         @items << OpenStudio::Analysis::WorkflowStep.from_measure_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
@@ -110,7 +101,7 @@ module OpenStudio
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @param local_path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
-      # @param measure_metadata [Hash] Format of the measure.json
+      # @param measure_metadata [Hash] Format of the measure.xml in JSON format
       # @return [Object] Returns the measure that was added as an OpenStudio::AnalysisWorkflowStep object
       def add_measure_from_analysis_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
         @items << OpenStudio::Analysis::WorkflowStep.from_analysis_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
@@ -271,29 +262,30 @@ module OpenStudio
 
         o = OpenStudio::Analysis::Workflow.new
 
-        h[:workflow].each do |wf|
-          puts "Adding measure #{wf[:name]}"
-
-          # Go though the defined measure paths and try and find the local measure
-          local_measure_dir = nil
-          if wf[:measure_definition_directory_local] && Dir.exist?(wf[:measure_definition_directory_local])
-            local_measure_dir = wf[:measure_definition_directory_local]
-          else
-            # search in the measure paths for the measure
-            OpenStudio::Analysis.measure_paths.each do |p|
-              test_dir = File.join(p, File.basename(wf[:measure_definition_directory]))
-              if Dir.exist?(test_dir)
-                local_measure_dir = test_dir
-                break
+        if h[:workflow]
+          h[:workflow].each do |wf|
+            puts "Adding measure #{wf[:name]}"
+
+            # Go though the defined measure paths and try and find the local measure
+            local_measure_dir = nil
+            if wf[:measure_definition_directory_local] && Dir.exist?(wf[:measure_definition_directory_local])
+              local_measure_dir = wf[:measure_definition_directory_local]
+            else
+              # search in the measure paths for the measure
+              OpenStudio::Analysis.measure_paths.each do |p|
+                test_dir = File.join(p, File.basename(wf[:measure_definition_directory]))
+                if Dir.exist?(test_dir)
+                  local_measure_dir = test_dir
+                  break
+                end
               end
             end
-          end
 
-          raise "Could not find local measure when loading workflow for #{wf[:measure_definition_class_name]} in #{File.basename(wf[:measure_definition_directory])}. You may have to add measure paths to OpenStudio::Analysis.measure_paths" unless local_measure_dir
+            raise "Could not find local measure when loading workflow for #{wf[:measure_definition_class_name]} in #{File.basename(wf[:measure_definition_directory])}. You may have to add measure paths to OpenStudio::Analysis.measure_paths" unless local_measure_dir
 
-          o.add_measure_from_analysis_hash(wf[:name], wf[:display_name], local_measure_dir, wf)
+            o.add_measure_from_analysis_hash(wf[:name], wf[:display_name], local_measure_dir, wf)
+          end
         end
-
         o
       end
 

data/lib/openstudio/analysis/workflow_step.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -60,7 +60,7 @@ module OpenStudio
         @name = ''
         @display_name = ''
 
-        # The type of item being added (RubyMeasure, EnergyPlusMeasure, ...)
+        # The type of item being added (ModelMeasure, EnergyPlusMeasure, ...)
         @type = nil
 
         @measure_definition_class_name = nil
@@ -267,15 +267,12 @@ module OpenStudio
       #
       # @param instance_name [String] Machine name of the instance
       # @param instance_display_name [String] Display name of the instance
-      # @param path_to_measure [String] This is the local path to the measure directroy, relative or absolute. It is used when zipping up all the measures.
-      # @param hash [Hash] Measure hash in the format of the measure.json (from the Analysis Spreadsheet project)
+      # @param path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
+      # @param hash [Hash] Measure hash in the format of a converted measure.xml hash (from the Analysis Spreadsheet project)
       # @param options [Hash] Optional arguments
       # @option options [Boolean] :ignore_not_found Do not raise an exception if the measure could not be found on the machine
       # @return [Object] Returns the OpenStudio::Analysis::WorkflowStep
       def self.from_measure_hash(instance_name, instance_display_name, path_to_measure, hash, options = {})
-        # TODO: Validate the hash
-        # TODO: validate that the measure exists?
-
         if File.directory? path_to_measure
           path_to_measure = File.join(path_to_measure, 'measure.rb')
         end
@@ -312,40 +309,36 @@ module OpenStudio
         # do not allow the choice variable_type
 
         s.type = hash[:measure_type] # this is actually the measure type
-        if hash[:arguments]
-          hash[:arguments].each do |arg|
-            # warn the user to we need to deprecate variable_type and use value_type (which is what os server uses)
-            var_type = arg[:variable_type] ? arg[:variable_type].downcase : arg[:value_type]
-
-            if var_type == 'choice'
-              # WARN the user that the measure had a "choice data type"
-              var_type = 'string'
-            end
+        hash[:arguments]&.each do |arg|
+          # warn the user to we need to deprecate variable_type and use value_type (which is what os server uses)
+          var_type = arg[:variable_type] ? arg[:variable_type].downcase : arg[:value_type]
 
-            s.arguments << {
-              display_name: arg[:display_name],
-              display_name_short: arg[:display_name_short],
-              name: arg[:name],
-              value_type: var_type,
-              default_value: arg[:default_value],
-              value: arg[:default_value]
-            }
+          if var_type == 'choice'
+            # WARN the user that the measure had a "choice data type"
+            var_type = 'string'
           end
+
+          s.arguments << {
+            display_name: arg[:display_name],
+            display_name_short: arg[:display_name_short],
+            name: arg[:name],
+            value_type: var_type,
+            default_value: arg[:default_value],
+            value: arg[:default_value]
+          }
         end
 
         # Load the arguments of variables, but do not make them variables. This format is more about arugments, than variables
-        if hash[:variables]
-          hash[:variables].each do |variable|
-            # add the arguments first
-            s.arguments << {
-              display_name: variable[:argument][:display_name],
-              display_name_short: variable[:argument][:display_name_short],
-              name: variable[:argument][:name],
-              value_type: variable[:argument][:value_type],
-              default_value: variable[:argument][:default_value],
-              value: variable[:argument][:default_value]
-            }
-          end
+        hash[:variables]&.each do |variable|
+          # add the arguments first
+          s.arguments << {
+            display_name: variable[:argument][:display_name],
+            display_name_short: variable[:argument][:display_name_short],
+            name: variable[:argument][:name],
+            value_type: variable[:argument][:value_type],
+            default_value: variable[:argument][:default_value],
+            value: variable[:argument][:default_value]
+          }
         end
 
         s
@@ -356,7 +349,7 @@ module OpenStudio
       # @param instance_name [String] Machine name of the instance
       # @param instance_display_name [String] Display name of the instance
       # @param path_to_measure [String] This is the local path to the measure directroy, relative or absolute. It is used when zipping up all the measures.
-      # @param hash [Hash] Measure hash in the format of the measure.json (from the Analysis Spreadsheet project)
+      # @param hash [Hash] Measure hash in the format of the measure.xml converted to JSON (from the Analysis Spreadsheet project)
       # @param options [Hash] Optional arguments
       # @option options [Boolean] :ignore_not_found Do not raise an exception if the measure could not be found on the machine
       # @return [Object] Returns the OpenStudio::Analysis::WorkflowStep
@@ -398,51 +391,47 @@ module OpenStudio
         s.measure_definition_version_uuid = hash[:measure_definition_version_uuid]
 
         s.type = hash[:measure_type] # this is actually the measure type
-        if hash[:arguments]
-          hash[:arguments].each do |arg|
-            # warn the user to we need to deprecate variable_type and use value_type (which is what os server uses)
-            var_type = arg[:value_type]
-
-            if var_type == 'choice'
-              # WARN the user that the measure had a "choice data type"
-              var_type = 'string'
-            end
+        hash[:arguments]&.each do |arg|
+          # warn the user to we need to deprecate variable_type and use value_type (which is what os server uses)
+          var_type = arg[:value_type]
 
-            s.arguments << {
-              display_name: arg[:display_name],
-              display_name_short: arg[:display_name_short],
-              name: arg[:name],
-              value_type: var_type,
-              default_value: arg[:default_value],
-              value: arg[:value]
-            }
+          if var_type == 'choice'
+            # WARN the user that the measure had a "choice data type"
+            var_type = 'string'
           end
+
+          s.arguments << {
+            display_name: arg[:display_name],
+            display_name_short: arg[:display_name_short],
+            name: arg[:name],
+            value_type: var_type,
+            default_value: arg[:default_value],
+            value: arg[:value]
+          }
         end
 
-        if hash[:variables]
-          hash[:variables].each do |variable|
-            # add the arguments first
-            s.arguments << {
-              display_name: variable[:argument][:display_name],
-              display_name_short: variable[:argument][:display_name_short],
-              name: variable[:argument][:name],
-              value_type: variable[:argument][:value_type],
-              default_value: variable[:argument][:default_value],
-              value: variable[:argument][:default_value]
-            }
-
-            var_options = {}
-            var_options[:variable_type] = variable[:variable_type]
-            var_options[:variable_display_name_short] = variable[:display_name_short]
-            var_options[:static_value] = variable[:static_value]
-            distribution = variable[:uncertainty_description]
-            distribution[:minimum] = variable[:minimum]
-            distribution[:mean] = distribution[:attributes].find { |a| a[:name] == 'modes' }[:value]
-            distribution[:maximum] = variable[:maximum]
-            distribution[:standard_deviation] = distribution[:attributes].find { |a| a[:name] == 'stddev' }[:value]
-            distribution[:step_size] = distribution[:attributes].find { |a| a[:name] == 'delta_x' }[:value]
-            s.make_variable(variable[:argument][:name], variable[:display_name], distribution, var_options)
-          end
+        hash[:variables]&.each do |variable|
+          # add the arguments first
+          s.arguments << {
+            display_name: variable[:argument][:display_name],
+            display_name_short: variable[:argument][:display_name_short],
+            name: variable[:argument][:name],
+            value_type: variable[:argument][:value_type],
+            default_value: variable[:argument][:default_value],
+            value: variable[:argument][:default_value]
+          }
+
+          var_options = {}
+          var_options[:variable_type] = variable[:variable_type]
+          var_options[:variable_display_name_short] = variable[:display_name_short]
+          var_options[:static_value] = variable[:static_value]
+          distribution = variable[:uncertainty_description]
+          distribution[:minimum] = variable[:minimum]
+          distribution[:mean] = distribution[:attributes].find { |a| a[:name] == 'modes' }[:value]
+          distribution[:maximum] = variable[:maximum]
+          distribution[:standard_deviation] = distribution[:attributes].find { |a| a[:name] == 'stddev' }[:value]
+          distribution[:step_size] = distribution[:attributes].find { |a| a[:name] == 'delta_x' }[:value]
+          s.make_variable(variable[:argument][:name], variable[:display_name], distribution, var_options)
         end
 
         s

data/lib/openstudio/helpers/hash.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/lib/openstudio/helpers/string.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/{spec/openstudio/server_api_spec.rb → lib/openstudio/helpers/utils.rb}

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -33,36 +33,34 @@
 # EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 # *******************************************************************************
 
-require 'spec_helper'
+require 'rexml/document'
 
-describe OpenStudio::Analysis::ServerApi do
-  before :all do
-    @host = 'http://localhost:8080'
-  end
-
-  context 'create a new object instance' do
-    before(:all) do
-      @api = OpenStudio::Analysis::ServerApi.new
-    end
+def parse_measure_xml(measure_xml_filename)
+  measure_hash = {}
+  xml_to_parse = File.open(measure_xml_filename)
+  xml_root = REXML::Document.new(xml_to_parse).root
 
-    it 'should set the default host to localhost' do
-      expect(@api.hostname).to eq(@host)
-    end
+  # pull out some information
+  measure_hash[:classname] = xml_root.elements['//measure/class_name'].text
+  measure_hash[:name] = xml_root.elements['//measure/name'].text
+  measure_hash[:display_name] = xml_root.elements['//measure/display_name'].text
+  measure_hash[:display_name_titleized] = measure_hash[:name].titleize
+  measure_hash[:measure_type] = xml_root.elements['//measure/attributes/attribute[name="Measure Type"]/value'].text
+  measure_hash[:description] = xml_root.elements['//measure/description'].text
+  measure_hash[:modeler_description] = xml_root.elements['//measure/modeler_description'].text
+  measure_hash[:uid] = xml_root.elements['//measure/uid'].text
+  measure_hash[:version_id] = xml_root.elements['//measure/version_id'].text
+  measure_hash[:arguments] = []
 
-    # it 'should load a new analysis' do
-    #  file = File.expand_path(File.join('spec/files/analysis/examples/medium_office_example.json'))
-    #  #file = file.gsub("/", "\\")
-    #  options = { formulation_file: file}
-    #  # puts options
-    #  @api.new_analysis('a-project-id', options)
-    # end
+  REXML::XPath.each(xml_root, '//measure/arguments/argument') do |arg|
+    measure_hash[:arguments] << {
+      name: arg.elements['name'].text,
+      display_name: arg.elements['display_name'].text,
+      variable_type: arg.elements['type'].text.downcase,
+      default_value: arg.elements['default_value'].text,
+      units: arg.elements['units'] ? arg.elements['units'].text : ''
+    }
   end
 
-  context 'test not localhost' do
-    it 'should have a not localhost URL' do
-      options = { hostname: 'http://abc.def.ghi' }
-      api = OpenStudio::Analysis::ServerApi.new(options)
-      expect(api.hostname).to eq(options[:hostname])
-    end
-  end
+  measure_hash
 end

data/lib/openstudio/weather/epw.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:

data/openstudio-analysis.gemspec

@@ -1,6 +1,5 @@
 lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'openstudio/analysis/version'
 
 Gem::Specification.new do |s|
@@ -9,26 +8,30 @@ Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.authors = ['Nicholas Long']
   s.email = ['Nicholas.Long@nrel.gov']
+
   s.homepage = 'http://openstudio.nrel.gov'
   s.summary = 'Create JSON, ZIP to communicate with OpenStudio Distributed Analysis in the Cloud'
   s.description = 'Basic classes for generating the files needed for OpenStudio-Server'
   s.license = 'BSD'
 
-  s.required_ruby_version = '~> 2.5.1'
-  s.required_rubygems_version = '>= 1.3.6'
-
-  s.files         = `git ls-files -z`.split("\x0")
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'bcl', '~> 0.5.8'
+  s.required_ruby_version = '~> 2.5.0'
+
+  s.add_dependency 'bcl', '~> 0.6.1'
   s.add_dependency 'dencity', '~> 0.1.0'
-  s.add_dependency 'faraday', '~> 0.14'
-  s.add_dependency 'nokogiri', '~> 1.8.2' 
-  s.add_dependency 'roo', '~> 2.7.1'
-  s.add_dependency 'rubyzip', '~> 1.2'
+  s.add_dependency 'faraday', '~> 1.0.1'
+  s.add_dependency 'roo', '~> 2.8.3'
+  s.add_dependency 'rubyzip', '~> 2.3.0'
   s.add_dependency 'semantic', '~> 1.4'
 
-  s.add_development_dependency 'rake', '~> 12.3.1'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.9'
+  s.add_development_dependency 'rubocop', '~> 0.54.0'
+  s.add_development_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
 end