openstudio-analysis 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce67306a44fa45d81b14281b40e5e9d311333b83c4741fff3dc735d05fb273d
-  data.tar.gz: b7786960a5d47cfacfea90db7c86fa3f5d25ae66185cb004ec59edcd8449d267
+  metadata.gz: fc59c73e27b32b06db2f67f981af1a23c0f415da10ee476dabe0b9a90de0bfd6
+  data.tar.gz: 875f5b5a4047f6e97246030b570c14902c940a61b909627cd605565ab0531c05
 SHA512:
-  metadata.gz: 6324de334d0b870124f373020b54d8493ca91c3d74d441f5adf8c12dd762ec51d042bd9528fe1b5db8b52844007ba887c2a50ea373615fcf800c5bf6fc501e80
-  data.tar.gz: dfbe7fa89ec24428a0864d55dc14d48c368665fe541e572729af1cb95b034c9555543e54da0cf4827744d8c3fd813a8905f33878a2352b4fc85f8a98506ea6ee
+  metadata.gz: 90646bf5489ba4ea2b9a1b748efee310da650ea367fac91426287d1b7898aaf9b08989e2ea0c8dd81efe6642e80c562ddc797bb7a5c37a895f2548830755dcf8
+  data.tar.gz: c5106d321b8e4860017f801e1df137a333bfd6874656e29cb589d7e7ad24e6ad7e602ee7286591023c3a6f7b44b60a14ea8b1064cbc48f675019098ec0a1e8c7

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 1.3.2
+-------------
+* Add more paths to the measures dir list 
+
+Version 1.3.1
+-------------
+* Add method to delete a Variable 
+
 Version 1.3.0
 -------------
 * Create an OSA from an OSW

data/lib/openstudio/analysis/algorithm_attributes.rb

@@ -50,7 +50,8 @@ module OpenStudio
       end
 
       # these are the allowed analysis types
-      ANALYSIS_TYPES = ['spea_nrel', 'rgenoud', 'nsga_nrel', 'lhs', 'preflight', 'morris', 'sobol', 'doe', 'fast99', 'ga', 'gaisl', 'single_run', 'repeat_run', 'batch_run']
+      ANALYSIS_TYPES = ['diag', 'doe', 'fast99', 'ga', 'gaisl', 'lhs', 'morris', 'nsga_nrel', 'optim',
+                        'preflight', 'pso', 'repeat_run', 'rgenoud', 'single_run', 'sobol', 'spea_nrel']
 
       def set_attribute(attribute_name, attribute_value)
         @attributes[attribute_name] = attribute_value

data/lib/openstudio/analysis/formulation.rb

@@ -367,8 +367,8 @@ module OpenStudio
       #  /seeds
       #  /weather
       #
-      def convert_osw(osw_filename)
-        #load OSW so we can loop over [:steps]
+      def convert_osw(osw_filename, *measure_paths)
+        # load OSW so we can loop over [:steps]
         if File.exist? osw_filename  #will this work for both rel and abs paths?
           osw = JSON.parse(File.read(osw_filename), symbolize_names: true)
           @osw_path = File.expand_path(osw_filename)
@@ -376,10 +376,44 @@ module OpenStudio
           raise "Could not find workflow file #{osw_filename}"
         end
         
-        #set the weather and seed files if set in OSW
-        self.weather_file = osw[:weather_file] ? osw[:weather_file] : nil
-        self.seed_model = osw[:seed_file] ? osw[:seed_file] : nil
+        # set the weather and seed files if set in OSW
+        # use :file_paths and look for files to set
+        if osw[:file_paths]        
+          # seed_model, check if in OSW and not found in path search already
+          if osw[:seed_file]
+            osw[:file_paths].each do |path|
+              puts "searching for seed at: #{File.join(File.expand_path(path), osw[:seed_file])}"
+              if File.exist?(File.join(File.expand_path(path), osw[:seed_file]))
+                puts "found seed_file: #{osw[:seed_file]}"
+                self.seed_model = File.join(File.expand_path(path), osw[:seed_file])
+                break
+              end
+            end  
+          else 
+            warn "osw[:seed_file] is not defined"            
+          end
+
+          # weather_file, check if in OSW and not found in path search already
+          if osw[:weather_file]
+            osw[:file_paths].each do |path|
+              puts "searching for weather at: #{File.join(File.expand_path(path), osw[:weather_file])}"
+              if File.exist?(File.join(File.expand_path(path), osw[:weather_file]))
+                puts "found weather_file: #{osw[:weather_file]}"
+                self.weather_file = File.join(File.expand_path(path), osw[:weather_file])
+                break
+              end 
+            end
+          else 
+            warn "osw[:weather_file] is not defined"            
+          end
 
+        # file_paths is not defined in OSW, so warn and try to set 
+        else
+          warn ":file_paths is not defined in the OSW."
+          self.weather_file = osw[:weather_file] ? osw[:weather_file] : nil
+          self.seed_model = osw[:seed_file] ? osw[:seed_file] : nil
+        end
+        
         #set analysis_type default to Single_Run
         self.analysis_type = 'single_run'
 
@@ -394,9 +428,26 @@ module OpenStudio
           #get measure directory
           measure_dir = step[:measure_dir_name]
           measure_name = measure_dir.split("measures/").last
+          puts "measure_dir_name: #{measure_name}"
           #get XML
-          measure_dir_abs_path = File.join(File.dirname(File.expand_path(osw_filename)),measure_dir)
-          xml = parse_measure_xml(File.join(measure_dir_abs_path, '/measure.xml'))       
+          # Loop over possible user defined *measure_paths, including the dir of the osw_filename path and :measure_paths, to find the measure, 
+          # then set measure_dir_abs_path to that path
+          measure_dir_abs_path = ''
+          paths_to_parse = [File.dirname(osw_filename), osw[:measure_paths], *measure_paths].flatten.compact.map { |path| File.join(File.expand_path(path), measure_dir, 'measure.xml') }
+          puts "searching for xml's in: #{paths_to_parse}"
+          xml = {}
+          paths_to_parse.each do |path|
+            if File.exist?(path)
+              puts "found xml: #{path}"
+              xml = parse_measure_xml(path)
+              if !xml.empty?
+                measure_dir_abs_path = path
+                break
+              end
+            end          
+          end
+          raise "measure #{measure_name} not found" if xml.empty?
+          puts ""          
           #add check for previous names _+1
           count = 1
           name = xml[:name]
@@ -417,13 +468,17 @@ module OpenStudio
           #1. find measure in @workflow
           m = @workflow.find_measure(name)
           #2. loop thru osw args
-          step[:arguments].each do |k,v|
-            #check if argument is in measure, otherwise setting argument_value will crash
-            raise "OSW arg: #{k} is not in Measure: #{name}" if m.arguments.find_all { |a| a[:name] == k.to_s }.empty?
-            #set measure arg to match osw arg
-            m.argument_value(k.to_s, v)
+          #check if the :argument is missing from the measure step, it shouldnt be but just in case give a clean message
+          if step[:arguments].nil?
+            raise "measure #{name} step has no arguments: #{step}"
+          else          
+            step[:arguments].each do |k,v|
+              #check if argument is in measure, otherwise setting argument_value will crash
+              raise "OSW arg: #{k} is not in Measure: #{name}" if m.arguments.find_all { |a| a[:name] == k.to_s }.empty?
+              #set measure arg to match osw arg
+              m.argument_value(k.to_s, v)
+            end
           end
-          
         end
       end
 
@@ -454,32 +509,58 @@ module OpenStudio
           puts 'Adding Support Files: Weather'
           #check if weather file exists.  use abs path.  remove leading ./ from @weather_file path if there.
           #check if path is already absolute
-          if File.exists?(@weather_file[:file])
-            puts "  Adding #{@weather_file[:file]}"
-            zf.add("weather/#{File.basename(@weather_file[:file])}", @weather_file[:file])
-          #make absolute path and check for file  
-          elsif File.exists?(File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, '')))
-            puts "  Adding #{File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))}"
-            zf.add("weather/#{File.basename(@weather_file[:file])}", File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, '')))
+          if @weather_file[:file]
+            if File.exists?(@weather_file[:file])
+              puts "  Adding #{@weather_file[:file]}"
+              #zf.add("weather/#{File.basename(@weather_file[:file])}", @weather_file[:file])
+              base_name = File.basename(@weather_file[:file], ".*")
+              puts "base_name: #{base_name}"
+              #convert backslash on windows to forward slash so Dir.glob will work (in case user uses \)
+              weather_dirname = File.dirname(@weather_file[:file]).gsub("\\", "/")
+              puts "weather_dirname: #{weather_dirname}"
+              Dir.glob(File.join(weather_dirname, "#{base_name}.*")) do |file_path|
+                puts "file_path: #{file_path}"
+                puts "zip path: weather/#{File.basename(file_path)}"
+                zf.add("weather/#{File.basename(file_path)}", file_path)
+              end
+            #make absolute path and check for file  
+            elsif File.exists?(File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, '')))
+              puts "  Adding: #{File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))}"
+              #zf.add("weather/#{File.basename(@weather_file[:file])}", File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, '')))
+              base_name = File.basename(@weather_file[:file].sub(/^\.\//, ''), ".*")
+              puts "base_name2: #{base_name}"
+              weather_dirname = File.dirname(File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))).gsub("\\", "/")
+              puts "weather_dirname: #{weather_dirname}"
+              Dir.glob(File.join(weather_dirname, "#{base_name}.*")) do |file_path|
+                puts "file_path2: #{file_path}"
+                puts "zip path2: weather/#{File.basename(file_path)}"
+                zf.add("weather/#{File.basename(file_path)}", file_path)
+              end
+            else
+              raise "weather_file[:file] does not exist at: #{File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))}"
+            end
           else
-            raise "Weather file does not exist at: #{File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))}"
-          end 
+            warn "weather_file[:file] is not defined"
+          end              
 
           ## Seed files
           puts 'Adding Support Files: Seed Models'
-          #check if weather file exists.  use abs path.  remove leading ./ from @seed_model path if there.
+          #check if seed file exists.  use abs path.  remove leading ./ from @seed_model path if there.
           #check if path is already absolute
-          if File.exists?(@seed_model[:file])
-            puts "  Adding #{@seed_model[:file]}"
-            zf.add("seeds/#{File.basename(@seed_model[:file])}", @seed_model[:file])
-          #make absolute path and check for file  
-          elsif File.exists?(File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, '')))
-            puts "  Adding #{File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))}"
-            zf.add("seeds/#{File.basename(@seed_model[:file])}", File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, '')))
+          if @seed_model[:file]
+            if File.exists?(@seed_model[:file])
+              puts "  Adding #{@seed_model[:file]}"
+              zf.add("seeds/#{File.basename(@seed_model[:file])}", @seed_model[:file])
+            #make absolute path and check for file  
+            elsif File.exists?(File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, '')))
+              puts "  Adding #{File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))}"
+              zf.add("seeds/#{File.basename(@seed_model[:file])}", File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, '')))
+            else
+              raise "seed_file[:file] does not exist at: #{File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))}"
+            end        
           else
-            raise "Seed file does not exist at: #{File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))}"
-          end        
-
+            warn "seed_file[:file] is not defined"
+          end 
           puts 'Adding Support Files: Libraries'
           @libraries.each do |lib|
             raise "Libraries must specify their 'library_name' as metadata which becomes the directory upon zip" unless lib[:metadata][:library_name]

data/lib/openstudio/analysis/version.rb

@@ -37,6 +37,6 @@ module OpenStudio
   module Analysis
     # format should be ^.*\-{1}[a-z]+[0-9]+
     # for example: -rc1, -beta6, -customusecase0
-    VERSION = '1.3.0'.freeze
+    VERSION = '1.3.2'.freeze
   end
 end

data/lib/openstudio/analysis/workflow_step.rb

@@ -129,6 +129,16 @@ module OpenStudio
         v
       end
 
+      def remove_variable(variable_name)
+        v_index = @variables.find_index { |v| v[:argument][:name] == variable_name }
+        if v_index
+          @variables.delete_at(v_index)
+          return true
+        else
+          return false
+        end
+      end
+      
       # Tag a measure's argument as a variable.
       #
       # @param argument_name [String] The instance_name of the measure argument that is to be tagged. This is the same name as the argument's variable in the measure.rb file.
@@ -224,12 +234,18 @@ module OpenStudio
           end
 
           # fix everything to support the legacy version
-          hash[:variables] = @variables
+          # we need to make a deep copy since multiple calls to .to_hash deletes :type, :mode, etc below
+          # and we still want those args to be avail for future calls, but not end up in the final OSA hash.
+          # without this, the v.delete() below (line ~278-281) will remove :type from @variables. 
+          # this would be okay if there was only 1 call to .to_hash. but thats not guaranteed
+          variables_dup = Marshal.load(Marshal.dump(@variables))
+          hash[:variables] = variables_dup
 
           # Clean up the variables to match the legacy format
           hash[:variables].each_with_index do |v, index|
             v[:variable_type] == 'pivot' ? v[:pivot] = true : v[:variable] = true
             v[:static_value] = v[:argument][:default_value] unless v[:static_value]
+            @variables[index][:static_value] = v[:static_value]
 
             v[:uncertainty_description] = {}
             # In Version 0.5 the _uncertain text will be removed from distribution

data/lib/openstudio/helpers/utils.rb

@@ -54,11 +54,11 @@ def parse_measure_xml(measure_xml_filename)
 
   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 : ''
+      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']&.text || ''
     }
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-analysis
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Nicholas Long
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
+date: 2023-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl