openstudio-analysis 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b307b715407bd74c16e687f0acfe025555e232cab093d493ddfec92930208928
-  data.tar.gz: b03f1c1c73cbd0c7ec95033e91874d9a4ec6ff267ca038877a04d18ec8772f7d
+  metadata.gz: 8b57a1b469c94255be338f754cd6b450e3c059210ec05897d9b0d6825904e6f7
+  data.tar.gz: a663a6646924dde02c9b45ce6d9761d5b5aed59ef2f3067ceab4d6786c09259d
 SHA512:
-  metadata.gz: ba82343b9d2bc7e35439d1583ee39b6938459e1fd0f83cd6993ab1e6e71dcf185f2da7fedb62d4b02267664576c42b941e22e3fcf673ac321812998ca60bd07d
-  data.tar.gz: 4a8aad3e2348fa63e25c6aa07e496b75a79be7b9aa2af92075c1e63524296e60150169f0c9e732c13cd962b6c701e16a16b50474e7005fb3cbf7e090981ee7df
+  metadata.gz: 20acbefdd350cb6706814d39e513f92abee35dc32538e61aabc209b2c17b3059ecfe2c5ce1dd5489e15d5dd20d5c5af686c74228f54038e187b1956830de3012
+  data.tar.gz: c37631b399d554ba2115d1946280a20d40766a26e1521c0e301ed79722c5e77d05974140691823119e93d7b29d0a04765251ffb8089300e6444037b9ee4d1074

data/CHANGELOG.md

@@ -1,13 +1,34 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 1.3.3
+-------------
+* Add arguments to .save_osa_zip() to add all files in weather and/or seed directories to zip file. defaults to false.
+
+Version 1.3.2
+-------------
+* Add array of search paths to .convert_osw() to find measures in various directories.
+* warn if :weather_file and :seed_model are not defined.
+* use :file_paths in the OSW to search for :seed_model and :weather_file.
+* add .stat and .ddy files to analysis.zip if in same directory as .epw defined in :weather_file.
+* use :measure_paths in OSW to search for measures. 
+
 Version 1.3.1
 -------------
-* Add method to delete a Variable 
+* Add method to delete a Variable:  **analysis.remove_variable()**
+* fix bug related to multiple calls to analysis.to_hash deleting variables
+* Add PSO and Optim to allowed algorithms 
 
 Version 1.3.0
 -------------
-* Create an OSA from an OSW
+* Create an OSA from an OSW:  **analysis.convert_osw()**
+* Add output variables and objective functions:  **analysis.add_output()**
+* Add server initialization and finalization scripts: **analysis.server_scripts.add()**
+* Set algorithm attributes:  **analysis.algorithm.set_attribute()**
+* Set algorithm type:  **analysis.analysis_type()**
+* Add additional library/data files:  **analysis.libraries.add()**
+* create analysis.json:  **File.write('analysis.json',JSON.pretty_generate(analysis.to_hash))**
+* create analysis.zip:  **analysis.save_osa_zip('analysis.zip')**
 
 Version 1.2.0
 -------------

data/lib/openstudio/analysis/formulation.rb

@@ -351,12 +351,12 @@ module OpenStudio
       end
       
       
-      def save_osa_zip(filename)
+      def save_osa_zip(filename, all_weather_files = false, all_seed_files = false)
         filename += '.zip' if File.extname(filename) == ''
 
         FileUtils.mkdir_p File.dirname(filename) unless Dir.exist? File.dirname(filename)
 
-        save_analysis_zip_osa(filename)
+        save_analysis_zip_osa(filename, all_weather_files, all_seed_files)
       end
       
       # convert an OSW to an OSA
@@ -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
 
@@ -432,12 +487,11 @@ module OpenStudio
       # New format for OSAs. Package up the seed, weather files, and measures
       # filename is the name of the file to be saved. ex: analysis.zip
       # it will parse the OSA and zip up all the files defined in the workflow
-      def save_analysis_zip_osa(filename)
+      def save_analysis_zip_osa(filename, all_weather_files = false, all_seed_files = false)
         def add_directory_to_zip_osa(zipfile, local_directory, relative_zip_directory)
           puts "Add Directory #{local_directory}"
           Dir[File.join(local_directory.to_s, '**', '**')].each do |file|
             puts "Adding File #{file}"
-            
             zipfile.add(file.sub(local_directory, relative_zip_directory), file)
           end
           zipfile
@@ -448,38 +502,89 @@ module OpenStudio
         puts "osw_path: #{@osw_path}"
         osw_full_path = File.dirname(File.expand_path(@osw_path))
         puts "osw_full_path: #{osw_full_path}"
-        
+
         Zip::File.open(filename, create: true) do |zf|
-          ## Weather files
+         ## Weather files
           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(/^\.\//, '')))
+          # check if weather file exists.  use abs path.  remove leading ./ from @weather_file path if there.
+          # check if path is already absolute
+          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}"
+              # If all_weather_files is true, add all files in the directory to the zip.
+              # Otherwise, add only files that match the base name.
+              file_pattern = all_weather_files ? "*" : "#{base_name}.*"
+              Dir.glob(File.join(weather_dirname, file_pattern)) 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}"
+              file_pattern = all_weather_files ? "*" : "#{base_name}.*"
+              Dir.glob(File.join(weather_dirname, file_pattern)) 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])
+              if all_seed_files
+                seed_dirname = File.dirname(@seed_model[:file]).gsub("\\", "/")
+                puts "seed_dirname: #{seed_dirname}"
+                Dir.glob(File.join(seed_dirname, '*')) do |file_path|
+                  next if file_path == @seed_model[:file] # Skip if the file is the same as @seed_model[:file] so not added twice
+                  puts "file_path: #{file_path}"
+                  puts "zip path: seeds/#{File.basename(file_path)}"
+                  zf.add("seeds/#{File.basename(file_path)}", file_path)
+                end              
+              end
+            #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 all_seed_files
+                seed_dirname = File.dirname(File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))).gsub("\\", "/")
+                puts "seed_dirname: #{seed_dirname}"
+                Dir.glob(File.join(seed_dirname, '*')) do |file_path|
+                  next if file_path == File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, '')) # Skip if the file is the same as @seed_model[:file] so not added twice
+                  puts "file_path: #{file_path}"
+                  puts "zip path: seeds/#{File.basename(file_path)}"
+                  zf.add("seeds/#{File.basename(file_path)}", file_path)
+                end              
+              end
+            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.1'.freeze
+    VERSION = '1.3.3'.freeze
   end
 end

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.1
+  version: 1.3.3
 platform: ruby
 authors:
 - Nicholas Long
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl