openstudio-analysis 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc59c73e27b32b06db2f67f981af1a23c0f415da10ee476dabe0b9a90de0bfd6
-  data.tar.gz: 875f5b5a4047f6e97246030b570c14902c940a61b909627cd605565ab0531c05
+  metadata.gz: 8b57a1b469c94255be338f754cd6b450e3c059210ec05897d9b0d6825904e6f7
+  data.tar.gz: a663a6646924dde02c9b45ce6d9761d5b5aed59ef2f3067ceab4d6786c09259d
 SHA512:
-  metadata.gz: 90646bf5489ba4ea2b9a1b748efee310da650ea367fac91426287d1b7898aaf9b08989e2ea0c8dd81efe6642e80c562ddc797bb7a5c37a895f2548830755dcf8
-  data.tar.gz: c5106d321b8e4860017f801e1df137a333bfd6874656e29cb589d7e7ad24e6ad7e602ee7286591023c3a6f7b44b60a14ea8b1064cbc48f675019098ec0a1e8c7
+  metadata.gz: 20acbefdd350cb6706814d39e513f92abee35dc32538e61aabc209b2c17b3059ecfe2c5ce1dd5489e15d5dd20d5c5af686c74228f54038e187b1956830de3012
+  data.tar.gz: c37631b399d554ba2115d1946280a20d40766a26e1521c0e301ed79722c5e77d05974140691823119e93d7b29d0a04765251ffb8089300e6444037b9ee4d1074

data/CHANGELOG.md

@@ -1,17 +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 more paths to the measures dir list 
+* 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
@@ -487,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
@@ -503,27 +502,30 @@ 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
+          # 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 \)
+              # 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  
+              # 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(/^\.\//, '')))
@@ -531,7 +533,8 @@ module OpenStudio
               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|
+              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)
@@ -541,7 +544,7 @@ module OpenStudio
             end
           else
             warn "weather_file[:file] is not defined"
-          end              
+          end
 
           ## Seed files
           puts 'Adding Support Files: Seed Models'
@@ -551,16 +554,37 @@ module OpenStudio
             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
             warn "seed_file[:file] is not defined"
-          end 
+          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.2'.freeze
+    VERSION = '1.3.3'.freeze
   end
 end

metadata

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