openstudio-analysis 1.0.2 → 1.1.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b20988ab4ac3ee624237e08382bb0730e8242268256533d5f373628fd513ec
-  data.tar.gz: 61ebb4020671713ee54d6d843a51fbbf44a16bba668c87164666df3e36d71ed2
+  metadata.gz: d4dc6517c0ebfd5341ebb89a066ce4371f37aa7a2c20f01e8b36965b33b8b230
+  data.tar.gz: '08f4e8886d1dba3d984a77e03163938d7b957e798e9cdb0122378a8d5f2b2ebc'
 SHA512:
-  metadata.gz: 802b9da31d550ed7f43d549b8fbd8bcdb5f5e7b30febbb48983a276039973c1342ea33e9ccbe7742759cd65c16443fd12a2e58420ba0260dfba7ebdff216d14c
-  data.tar.gz: d97c2aca92f03def5f2ab2b1cb323816689a03bcf6096dd68d6f8e8dd4bd7d9b801ef35027a756c6c954a46401008e9fe1e3168eea107f6f2edceb88c333e376
+  metadata.gz: 73d3b0a51379bc817574aee43db86d3aca220ebdc52b8e7be3a58107ac840c41b00ec084954ed33fdd36626650697b9ed26316756ebd09a33d2317273ec123c9
+  data.tar.gz: 4ec8ab47fbb526354addb1c492078bb0e3a791635e8f42ef7e95a82024db97d40c741558fa3b43f4391e00c6f2bfbf02662147157a48196b688bc4e3a9c66854

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'spec/files/measures/**/*'
     - 'spec/files/measures_second_path/**/*'
     - 'spec/files/worker_init/*'
+    - 'update_license.rb'
 
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.5.1  
-before_install: gem install bundler -v 1.17.1
+  - 2.5.1
+before_install: gem install bundler -v 2.1

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 OpenStudio Analysis Gem Change Log
 ==================================
+
+Version 1.1.0 (Unreleased)
+--------------------------
+* Allow for blank :seed, :weather_file and :workflow sections of OSA
+
+Version 1.0.6
+-------------
+* Always include ../lib to the file paths to search
+
+Version 1.0.5
+-------------
+* Upgrade to latest BCL (0.6.1)
+* Remove the need for the measure.json (which has been deprecated in BCL gem). Now parses the measure.xml.
+* Upgrade Faraday (1.0.1)
+* Remove dependency on Nokogiri.
+
+Version 1.0.4
+-------------
+* Update dependency Nokogiri
+
+Version 1.0.3
+-------------
+* Update dependencies roo and rubyzip
+
 Version 1.0.2
 -------------
 * Updates required for OpenStudio 3x

data/Gemfile

@@ -3,8 +3,7 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'colored', '~> 1.2'
-gem 'dencity'
-gem 'openstudio-aws', '0.4.2'
+gem 'openstudio-aws', '~> 0.4.2'
 
 group :test do
   # Don't install coveralls on window because requires devkit for json
@@ -12,7 +11,4 @@ group :test do
     gem 'coveralls', require: false
   end
   gem 'ci_reporter_rspec'
-  gem 'rspec', '~> 3.4'
-  gem 'rubocop'
-  gem 'rubocop-checkstyle_formatter'
 end

data/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC. All rights reserved.
+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/Rakefile

@@ -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-analysis.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:
@@ -70,6 +70,7 @@ require 'openstudio/analysis/translator/workflow'
 # helpers / core_ext
 require 'openstudio/helpers/string'
 require 'openstudio/helpers/hash'
+require 'openstudio/helpers/utils'
 
 # weather file parsing
 require 'openstudio/weather/epw'

data/lib/openstudio/analysis.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:
@@ -130,35 +130,31 @@ module OpenStudio
             new_wfi[:description] = wf[:description] if wf[:description]
             new_wfi[:arguments] = []
 
-            if wf[:arguments]
-              wf[:arguments].each do |arg|
-                wfi_arg = {}
-                wfi_arg[:display_name] = arg[:display_name] if arg[:display_name]
-                wfi_arg[:display_name_short] = arg[:display_name_short] if arg[:display_name_short]
-                wfi_arg[:name] = arg[:name] if arg[:name]
-                wfi_arg[:data_type] = arg[:value_type] if arg[:value_type]
-                wfi_arg[:default_value] = nil
-                wfi_arg[:description] = ''
-                wfi_arg[:display_units] = '' # should be haystack compatible unit strings
-                wfi_arg[:units] = '' # should be haystack compatible unit strings
+            wf[:arguments]&.each do |arg|
+              wfi_arg = {}
+              wfi_arg[:display_name] = arg[:display_name] if arg[:display_name]
+              wfi_arg[:display_name_short] = arg[:display_name_short] if arg[:display_name_short]
+              wfi_arg[:name] = arg[:name] if arg[:name]
+              wfi_arg[:data_type] = arg[:value_type] if arg[:value_type]
+              wfi_arg[:default_value] = nil
+              wfi_arg[:description] = ''
+              wfi_arg[:display_units] = '' # should be haystack compatible unit strings
+              wfi_arg[:units] = '' # should be haystack compatible unit strings
 
-                new_wfi[:arguments] << wfi_arg
-              end
+              new_wfi[:arguments] << wfi_arg
             end
 
-            if wf[:variables]
-              wf[:variables].each do |arg|
-                wfi_var = {}
-                wfi_var[:display_name] = arg[:argument][:display_name] if arg[:argument][:display_name]
-                wfi_var[:display_name_short] = arg[:argument][:display_name_short] if arg[:argument][:display_name_short]
-                wfi_var[:name] = arg[:argument][:name] if arg[:argument][:name]
-                wfi_var[:default_value] = nil
-                wfi_var[:data_type] = arg[:argument][:value_type] if arg[:argument][:value_type]
-                wfi_var[:description] = ''
-                wfi_var[:display_units] = arg[:units] if arg[:units]
-                wfi_var[:units] = '' # should be haystack compatible unit strings
-                new_wfi[:arguments] << wfi_var
-              end
+            wf[:variables]&.each do |arg|
+              wfi_var = {}
+              wfi_var[:display_name] = arg[:argument][:display_name] if arg[:argument][:display_name]
+              wfi_var[:display_name_short] = arg[:argument][:display_name_short] if arg[:argument][:display_name_short]
+              wfi_var[:name] = arg[:argument][:name] if arg[:argument][:name]
+              wfi_var[:default_value] = nil
+              wfi_var[:data_type] = arg[:argument][:value_type] if arg[:argument][:value_type]
+              wfi_var[:description] = ''
+              wfi_var[:display_units] = arg[:units] if arg[:units]
+              wfi_var[:units] = '' # should be haystack compatible unit strings
+              new_wfi[:arguments] << wfi_var
             end
 
             measure_metadata << new_wfi

data/lib/openstudio/analysis/algorithm_attributes.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/analysis/formulation.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/analysis/server_api.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:
@@ -152,10 +152,8 @@ module OpenStudio
         response = @conn.get "/projects/#{project_id}.json"
         if response.status == 200
           analyses = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
-          if analyses[:analyses]
-            analyses[:analyses].each do |analysis|
-              analysis_ids << analysis[:_id]
-            end
+          analyses[:analyses]&.each do |analysis|
+            analysis_ids << analysis[:_id]
           end
         end
 
@@ -467,16 +465,12 @@ module OpenStudio
 
             formulation_json[:analysis][:problem][:workflow].each do |wf|
               wf[:uuid] = SecureRandom.uuid
-              if wf[:arguments]
-                wf[:arguments].each do |arg|
-                  arg[:uuid] = SecureRandom.uuid
-                end
+              wf[:arguments]&.each do |arg|
+                arg[:uuid] = SecureRandom.uuid
               end
-              if wf[:variables]
-                wf[:variables].each do |var|
-                  var[:uuid] = SecureRandom.uuid
-                  var[:argument][:uuid] = SecureRandom.uuid if var[:argument]
-                end
+              wf[:variables]&.each do |var|
+                var[:uuid] = SecureRandom.uuid
+                var[:argument][:uuid] = SecureRandom.uuid if var[:argument]
               end
             end
           else

data/lib/openstudio/analysis/support_files.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/analysis/translator/datapoints.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:
@@ -58,7 +58,7 @@ module OpenStudio
         attr_accessor :name
         attr_reader :analysis_name
 
-        require 'nokogiri'
+        require 'rexml/document'
 
         # Pass in the filename to read
         def initialize(csv_filename)
@@ -368,16 +368,16 @@ module OpenStudio
           data = []
           measures.each_with_index do |measure, measure_index|
             data[measure_index] = {}
-            measure_xml, measure_type = find_measure(measure.to_s)
+            measure_parsed = find_measure(measure.to_s)
 
-            raise "Could not find measure #{measure} xml in measure_paths: '#{@measure_paths.join("\n")}'" unless measure_xml
+            raise "Could not find measure #{measure} xml in measure_paths: '#{@measure_paths.join("\n")}'" unless measure_parsed
             measure_data = {}
-            measure_data[:classname] = measure_xml.xpath('/measure/class_name').text
-            measure_data[:name] = measure_xml.xpath('/measure/name').text
-            measure_data[:display_name] = measure_xml.xpath('/measure/display_name').text
-            measure_data[:measure_type] = measure_type
-            measure_data[:uid] = measure_xml.xpath('/measure/uid').text
-            measure_data[:version_id] = measure_xml.xpath('/measure/version_id').text
+            measure_data[:classname] = measure_parsed[:classname]
+            measure_data[:name] = measure_parsed[:name]
+            measure_data[:display_name] = measure_parsed[:display_name]
+            measure_data[:measure_type] = measure_parsed[:measure_type]
+            measure_data[:uid] = measure_parsed[:uid]
+            measure_data[:version_id] = measure_parsed[:version_id]
             data[measure_index][:measure_data] = measure_data
             data[measure_index][:vars] = []
             vars = measure_map[measure]
@@ -389,8 +389,8 @@ module OpenStudio
               next if var.to_s == 'None'
               var_hash = {}
               found_arg = nil
-              measure_xml.xpath('/measure/arguments/argument').each do |arg|
-                if var.to_s == '__SKIP__' || arg.xpath('name').text == var.to_s
+              measure_parsed[:arguments].each do |arg|
+                if var.to_s == '__SKIP__' || arg[:name] == var.to_s
                   found_arg = arg
                   break
                 end
@@ -404,8 +404,8 @@ module OpenStudio
                 var_type = 'boolean'
                 var_units = ''
               else
-                var_type = found_arg.xpath('type').text.downcase
-                var_units = found_arg.xpath('units')
+                var_type = found_arg[:variable_type].downcase
+                var_units = found_arg[:units]
               end
 
               var_hash[:name] = var.to_s
@@ -437,7 +437,8 @@ module OpenStudio
               var_hash[:distribution][:type] = 'discrete'
               var_hash[:distribution][:units] = var_hash[:units]
               if var_hash[:type] == 'choice'
-                var_hash[:distribution][:enumerations] = found_arg.xpath('choices/choice').map { |s| s.xpath('value').text }
+                # var_hash[:distribution][:enumerations] = found_arg.xpath('choices/choice').map { |s| s.xpath('value').text }
+                # This would need to be updated if we want to do this again... sorry.
               elsif var_hash[:type] == 'bool'
                 var_hash[:distribution][:enumerations] = []
                 var_hash[:distribution][:enumerations] << true
@@ -447,13 +448,13 @@ module OpenStudio
             end
             data[measure_index][:args] = []
 
-            measure_xml.xpath('/measure/arguments/argument').each do |arg_xml|
+            measure_parsed[:arguments].each do |arg_xml|
               arg = {}
-              arg[:value_type] = arg_xml.xpath('type').text.downcase
-              arg[:name] = arg_xml.xpath('name').text.downcase
-              arg[:display_name] = arg_xml.xpath('display_name').text.downcase
+              arg[:value_type] = arg_xml[:variable_type]
+              arg[:name] = arg_xml[:name]
+              arg[:display_name] = arg_xml[:display_name].downcase
               arg[:display_name_short] = arg[:display_name]
-              arg[:default_value] = arg_xml.xpath('default_value').text.downcase
+              arg[:default_value] = arg_xml[:default_value].downcase
               arg[:value] = arg[:default_value]
               data[measure_index][:args] << arg
             end
@@ -470,27 +471,12 @@ module OpenStudio
             measure_xml = File.join(mp, measure_name, 'measure.xml')
             measure_rb = File.join(mp, measure_name, 'measure.rb')
             if File.exist?(measure_xml) && File.exist?(measure_rb)
-              return Nokogiri::XML File.read(measure_xml), parse_measure_type(measure_rb)
+              measure_parsed = parse_measure_xml(measure_xml)
+              return measure_parsed
             end
           end
 
-          return nil, nil
-        end
-
-        def parse_measure_type(measure_filename)
-          measure_string = File.read(measure_filename)
-
-          if measure_string =~ /OpenStudio::Ruleset::WorkspaceUserScript/
-            return 'EnergyPlusMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::ModelUserScript/
-            return 'RubyMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::ReportingUserScript/
-            return 'ReportingMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::UtilityUserScript/
-            return 'UtilityUserScript'
-          else
-            raise "measure type is unknown with an inherited class in #{measure_filename}"
-          end
+          return nil
         end
       end
     end

data/lib/openstudio/analysis/translator/excel.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:
@@ -536,7 +536,7 @@ module OpenStudio
                 tmp_m_name = SecureRandom.uuid
               end
               # Only add models if the row is flagged
-              if row[0] && row[0].casecmp('model').zero?
+              if row[0]&.casecmp('model')&.zero?
                 model_path = row[3]
                 unless (Pathname.new model_path).absolute?
                   model_path = File.expand_path(File.join(@root_path, model_path))

data/lib/openstudio/analysis/translator/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:
@@ -65,14 +65,15 @@ module OpenStudio
           @osw_version = '0.0.1'
           @options = options
           @file_paths = options[:file_paths] ? options[:file_paths] : []
+          @file_paths << '../lib'
           @measure_paths = options[:measure_paths] ? options[:measure_paths] : []
 
           # Initialize static inputs from the OSA
-          @seed_file = File.basename(@osa[:seed][:path])
+          !@osa[:seed].nil? ? @seed_file = File.basename(@osa[:seed][:path]) : @seed_file = ''
           if @options[:seed]
             @seed_file = @options[:seed]
           end
-          @weather_file = File.basename(@osa[:weather_file][:path])
+          !@osa[:weather_file].nil? ? @weather_file = File.basename(@osa[:weather_file][:path]) : @weather_file = ''
           @osa_id = @osa[:_id]
           @steps = []
           @osa[:problem][:workflow].each_with_index do |step, i|
@@ -80,11 +81,9 @@ module OpenStudio
             step_hash[:measure_dir_name] = File.basename(step[:measure_definition_directory])
             step_hash[:arguments] = {}
             # Measures can have no arguments -- make sure to catch it
-            if @osa[:problem][:workflow][i][:arguments]
-              @osa[:problem][:workflow][i][:arguments].each do |arg|
-                next if arg[:value].nil?
-                step_hash[:arguments][arg[:name].to_sym] = arg[:value]
-              end
+            @osa[:problem][:workflow][i][:arguments]&.each do |arg|
+              next if arg[:value].nil?
+              step_hash[:arguments][arg[:name].to_sym] = arg[:value]
             end
             step_hash[:name] = step[:name] if step[:name]
             step_hash[:description] = step[:description] if step[:description]
@@ -98,7 +97,7 @@ module OpenStudio
             step_hash[:modeler_description] = step[:modeler_description] if step[:modeler_description]
             step_hash[:taxonomy] = step[:taxonomy] if step[:taxonomy]
             step_hash[:measure_type] = step[:measure_type]
-            step_hash[:measure_type] = 'ModelMeasure' if step_hash[:measure_type] == 'RubyMeasure'
+            step_hash[:measure_type] = 'ModelMeasure'
             @steps << step_hash
           end
         end
@@ -160,12 +159,10 @@ module OpenStudio
         def process_datapoints(osd_filename_array)
           r = []
           osd_filename_array.each do |osd_file|
-            begin
-              r << process_datapoint(osd_file)
-            rescue StandardError => e
-              r << nil
-              puts "Warning: Failed to process datapoint #{osd_file} with error #{e.message} in #{e.backtrace.join('\n')}"
-            end
+            r << process_datapoint(osd_file)
+          rescue StandardError => e
+            r << nil
+            puts "Warning: Failed to process datapoint #{osd_file} with error #{e.message} in #{e.backtrace.join('\n')}"
           end
 
           r

data/lib/openstudio/analysis/version.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:
@@ -35,6 +35,8 @@
 
 module OpenStudio
   module Analysis
-    VERSION = '1.0.2'.freeze
+    # format should be ^.*\-{1}[a-z]+[0-9]+
+    # for example: -rc1, -beta6, -customusecase0
+    VERSION = '1.1.0-rc1'.freeze
   end
 end