openstudio-analysis 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a0b39d0cdc6f14fcccb994266696c90c554339a
-  data.tar.gz: 481952ae7dbcdfa049acd520cf8c45fc4f5e2f61
+  metadata.gz: 40fd5c10c4ff7f0c700a21e8863f9289810c529e
+  data.tar.gz: 9a923d85c9f7bac6f9a90f904b9ab81295c59460
 SHA512:
-  metadata.gz: 7e9c40f95f3ec9d0983fa13b5ca6fa87afe2da0ca4be3dc27ad867a76f46015c2a9b15bc086a797e6439af9f5a710a4b054c625e10dd0f2e828a15c0d9340b6b
-  data.tar.gz: d00b2e9634b441dd53b0ff05cb595be788f4d0baaa377206503f786f046a54cfa7f4ca12d49013457d2e42aa3d8ba7d898f52262ee797e5d8da9200493a6c25c
+  metadata.gz: 028780fc203beed4de73fd266b872d9b0a22d0eddd5cbeb5fd9119fe773a069b8dee881b28d4dd8cd75faad9bfab3cc747b5216c7808b9b7247ad79ed20f32d6
+  data.tar.gz: a6b386728b1c3454cfaa1f84f27eac33ed24e1587bbead6514ba34196e4fda5d9777312f3b1a45a7de3c5c10bcda247d448bcff036fe403daa8950407d44a1df

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 0.4.2
+-------------
+* Bug fix when adding measure from path, this now sets the correct argument name.
+* Fix namespace conflict with OpenStudio::Logger and OpenStudio::Time
+* Create method for saving the Analysis Zip file (save_analysis_zip)
+
 Version 0.4.1
 -------------
 * Bug fix to address the spec/files directory being prepended to the measures

data/lib/openstudio/analysis/algorithm_attributes.rb

@@ -1,4 +1,4 @@
-# OpenStudio::Analysis::Algorithm to define the algorithm parameters. The module and class names start to conflict
+# OpenStudio::Analysis::Algorithm define the algorithm parameters. The module and class names start to conflict
 # with OpenStudio's namespace. Be careful adding new classes without first making sure that the namespace conflict
 # is clear.
 module OpenStudio

data/lib/openstudio/analysis/formulation.rb

@@ -1,17 +1,23 @@
 # OpenStudio formulation class handles the generation of the OpenStudio Analysis format.
 module OpenStudio
   module Analysis
-    SeedModel = Struct.new(:path)
-    WeatherFile = Struct.new(:path)
+    SeedModel = Struct.new(:file)
+    WeatherFile = Struct.new(:file)
 
     class Formulation
       attr_reader :seed_model
       attr_reader :weather_file
+      attr_reader :analysis_type
       attr_accessor :display_name
       attr_accessor :workflow
       attr_accessor :algorithm
 
-      attr_reader :analysis_type
+      # the attributes below are used for packaging data into the analysis zip file
+      attr_reader :weather_files
+      attr_reader :seed_models
+      attr_reader :worker_inits
+      attr_reader :worker_finalizes
+      attr_reader :libraries
 
       # Create an instance of the OpenStudio::Analysis::Formulation
       #
@@ -26,6 +32,14 @@ module OpenStudio
         @weather_file = WeatherFile.new
         @seed_model = SeedModel.new
         @algorithm = OpenStudio::Analysis::AlgorithmAttributes.new
+
+        # Analysis Zip attributes
+        @weather_files = SupportFiles.new
+        @seed_models = SupportFiles.new
+        @worker_inits = SupportFiles.new
+        @worker_finalizes = SupportFiles.new
+        @libraries = SupportFiles.new
+        #@initialization_scripts = SupportFiles.new
       end
 
       # Initialize or return the current workflow object
@@ -43,16 +57,16 @@ module OpenStudio
       # Path to the seed model
       #
       # @param path [String] Path to the seed model. This should be relative.
-      def seed_model(path)
-        @seed_model = SeedModel.new(path: path)
+      def seed_model(file)
+        @seed_model = SeedModel.new(file)
       end
 
       # Path to the weather file (or folder). If it is a folder, then the measures will look for the weather file
       # by name in that folder.
       #
       # @param path [String] Path to the weather file or folder.
-      def weather_file(path)
-        @weather_file = WeatherFile.new(path: path)
+      def weather_file(file)
+        @weather_file = WeatherFile.new(file)
       end
 
       # Add an output of interest to the problem formulation
@@ -73,12 +87,12 @@ module OpenStudio
       # @option output_hash [Integer] :objective_function_group If grouping objective functions, then group ID. Default: nil
       def add_output(output_hash)
         output_hash = {
-          units: '',
-          objective_function: false,
-          objective_function_index: nil,
-          objective_function_target: nil,
-          objective_function_group: nil,
-          scaling_factor: nil
+            units: '',
+            objective_function: false,
+            objective_function_index: nil,
+            objective_function_target: nil,
+            objective_function_group: nil,
+            scaling_factor: nil
         }.merge(output_hash)
 
         # if the objective_function index is nil and the variable is an objective function, then increment and
@@ -99,19 +113,19 @@ module OpenStudio
         # fail 'Must define an analysis type' unless @analysis_type
         if version == 1
           h = {
-            analysis: {
-              display_name: @display_name,
-              name: @display_name.snake_case,
-              output_variables: @outputs,
-              problem: {
-                analysis_type: @analysis_type,
-                algorithm: algorithm.to_hash(version),
-                workflow: workflow.to_hash(version)
-              },
-              seed: @seed_model[:path],
-              weather_file: @weather_file[:path],
-              file_format_version: version
-            }
+              analysis: {
+                  display_name: @display_name,
+                  name: @display_name.snake_case,
+                  output_variables: @outputs,
+                  problem: {
+                      analysis_type: @analysis_type,
+                      algorithm: algorithm.to_hash(version),
+                      workflow: workflow.to_hash(version)
+                  },
+                  seed: @seed_model[:file],
+                  weather_file: @weather_file[:file],
+                  file_format_version: version
+              }
           }
 
           # This is a hack right now, but after the initial hash is created go back and add in the objective functions
@@ -140,11 +154,11 @@ module OpenStudio
           end
 
           h = {
-            data_point: {
-              set_variable_values: static_hash,
-              status: 'na',
-              uuid: SecureRandom.uuid
-            }
+              data_point: {
+                  set_variable_values: static_hash,
+                  status: 'na',
+                  uuid: SecureRandom.uuid
+              }
           }
           h
         end
@@ -152,9 +166,11 @@ module OpenStudio
 
       # save the file to JSON. Will overwrite the file if it already exists
       #
+      # @param filename [String] Name of file to create. It will create the directory and override the file if it exists.
       # @param version [Integer] Version of the format to return
       # @return [Boolean]
       def save(filename, version = 1)
+        FileUtils.mkdir_p File.dirname(filename) unless Dir.exist? File.dirname(filename)
         File.open(filename, 'w') { |f| f << JSON.pretty_generate(to_hash(version)) }
 
         true
@@ -169,6 +185,140 @@ module OpenStudio
 
         true
       end
+
+      # save the analysis zip file which contains the measures, seed model, weather file, and init/final scripts
+      #
+      # @param filename [String] Name of file to create. It will create the directory and override the file if it exists.
+      # @return [Boolean]
+      def save_zip(filename)
+        FileUtils.mkdir_p File.dirname(filename) unless Dir.exist? File.dirname(filename)
+
+        save_analysis_zip(filename)
+      end
+
+      private
+
+      # Package up the seed, weather files, and measures
+      def save_analysis_zip(filename)
+        def add_directory_to_zip(zipfile, local_directory, relative_zip_directory)
+          # puts "Add Directory #{local_directory}"
+          Dir[File.join("#{local_directory}", '**', '**')].each do |file|
+            # puts "Adding File #{file}"
+            zipfile.add(file.sub(local_directory, relative_zip_directory), file)
+          end
+          zipfile
+        end
+
+        FileUtils.rm_f(filename) if File.exist?(filename)
+
+        Zip::File.open(filename, Zip::File::CREATE) do |zf|
+
+          ## Weather files
+          # TODO: eventually remove the @weather_file attribute and grab the weather file out
+          # of the @weather_files
+          puts "Adding Support Files: Weather"
+          if @weather_file[:file] && !@weather_files.files.find { |f| @weather_file[:file] == f[:file] }
+            #manually add the weather file
+            puts "  Adding #{@weather_file[:file]}"
+            zf.add("./weather/#{File.basename(@weather_file[:file])}", @weather_file[:file])
+          end
+          @weather_files.each do |f|
+            puts "  Adding #{f[:file]}"
+            zf.add("./weather/#{File.basename(f[:file])}", f[:file])
+          end
+
+          ## Seed files
+          puts "Adding Support Files: Seed Models"
+          if @seed_model[:file] && !@seed_models.files.find { |f| @seed_model[:file] == f[:file] }
+            #manually add the weather file
+            puts "  Adding #{@seed_model[:file]}"
+            zf.add("./seed/#{File.basename(@seed_model[:file])}", @seed_model[:file])
+          end
+          @seed_models.each do |f|
+            puts "  Adding #{f[:file]}"
+            zf.add("./seed/#{File.basename(f[:file])}", f[:file])
+          end
+
+          puts "Adding Support Files: Libraries"
+          @libraries.each do |lib|
+            fail "Libraries must specify their 'library_name' as metadata which becomes the directory upon zip" unless lib[:metadata][:library_name]
+
+            if File.directory? lib[:file]
+              Dir[File.join(lib[:file], '**', '**')].each do |file|
+                puts "  Adding #{file}"
+                zf.add(file.sub(lib[:file], "./lib/#{lib[:metadata][:library_name]}/"), file)
+              end
+            else
+              # just add the file to the zip
+              puts "  Adding #{lib[:file]}"
+              zf.add(lib[:file], "./lib/#{File.basename(lib[:file])}", lib[:file])
+            end
+          end
+
+          puts "Adding Support Files: Worker Initialization Scripts"
+          index = 0
+          @worker_inits.each do |f|
+            ordered_file_name = "#{index.to_s.rjust(2, '0')}_#{File.basename(f[:file])}"
+            puts "  Adding #{f[:file]} as #{ordered_file_name}"
+            zf.add(f[:file].sub(f[:file], "./lib/worker_initialize/#{ordered_file_name}"), f[:file])
+
+            if f[:metadata][:args]
+              arg_file = "#{File.basename(ordered_file_name, '.*')}.args"
+              file = Tempfile.new('arg')
+              file.write(f[:metadata][:args])
+              zf.add("./lib/worker_initialize/#{arg_file}", file)
+              file.close
+            end
+
+            index += 1
+          end
+
+          puts "Adding Support Files: Worker Finalization Scripts"
+          index = 0
+          @worker_finalizes.each do |f|
+            ordered_file_name = "#{index.to_s.rjust(2, '0')}_#{File.basename(f[:file])}"
+            puts "  Adding #{f[:file]} as #{ordered_file_name}"
+            zf.add(f[:file].sub(f[:file], "./lib/worker_finalize/#{ordered_file_name}"), f[:file])
+
+            if f[:metadata][:args]
+              arg_file = "#{File.basename(ordered_file_name, '.*')}.args"
+              file = Tempfile.new('arg')
+              file.write(f[:metadata][:args])
+              zf.add("./lib/worker_finalize/#{arg_file}", file)
+              file.close
+            end
+
+            index += 1
+          end
+
+          ## Measures
+          puts "Adding Measures"
+          added_measures = []
+          # The list of the measures should always be there, but make sure they are uniq
+          @workflow.each do |measure|
+            measure_dir_to_add = measure.measure_definition_directory
+
+            next if added_measures.include? measure_dir_to_add
+
+            puts "  Adding #{File.basename(measure_dir_to_add)}"
+            Dir[File.join(measure_dir_to_add, '**')].each do |file|
+              if File.directory?(file)
+                if File.basename(file) == 'resources' || File.basename(file) == 'lib'
+                  add_directory_to_zip(zf, file, "./measures/#{measure.name}/#{File.basename(file)}")
+                else
+                  # puts "Skipping Directory #{File.basename(file)}"
+                end
+              else
+                # puts "Adding File #{file}"
+                # added_measures << measure_dir unless added_measures.include? measure_dir
+                zf.add(file.sub(measure_dir_to_add, "./measures/#{measure.name}/"), file)
+              end
+            end
+
+            added_measures << measure_dir_to_add
+          end
+        end
+      end
     end
   end
 end

data/lib/openstudio/analysis/server_api.rb

@@ -8,7 +8,7 @@ module OpenStudio
       def initialize(options = {})
         defaults = { hostname: 'http://localhost:8080' }
         options = defaults.merge(options)
-        @logger = Logger.new('faraday.log')
+        @logger = ::Logger.new('faraday.log')
 
         @hostname = options[:hostname]
 
@@ -79,7 +79,7 @@ module OpenStudio
       end
 
       def new_project(options = {})
-        defaults = { project_name: "Project #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}" }
+        defaults = { project_name: "Project #{::Time.now.strftime('%Y-%m-%d %H:%M:%S')}" }
         options = defaults.merge(options)
         project_id = nil
 

data/lib/openstudio/analysis/support_files.rb

@@ -0,0 +1,76 @@
+# OpenStudio::Analysis::SupportFiles is a container to hold other analysis files that may need to be packaged.
+# The most common use of support files are weather files, design day files, multiple seed files, worker initialization
+# scripts, worker finalization scripts, and general libraries
+module OpenStudio
+  module Analysis
+    class SupportFiles
+
+      attr_reader :files
+
+      # Create a new instance of the support file class
+      #
+      def initialize
+        @files = []
+      end
+
+      # Add a file to the support file list
+      #
+      # @param path_or_filename [String] Full path of the file to be added.
+      # @return [Boolean] Returns false if the file does not exist
+      def add(path_or_filename, metadata = {})
+        if !File.exist?(path_or_filename) && !Dir.exist?(path_or_filename)
+          fail "Path or file does not exist and cannot be added: #{path_or_filename}"
+        end
+
+        # only add if it isn't allready in the list
+        if @files.find_all { |f| f[:file] == path_or_filename }.empty?
+          @files << {file: path_or_filename, metadata: metadata}
+        end
+
+        true
+      end
+
+      # Add a glob path with the same metadata for all the items
+      #
+      # @param pattern [String] Pattern to glob. example: /home/user1/files/**/*.rb
+      # @return [Boolean] Returns false if the file does not exist
+      def add_files(pattern, metadata = {})
+        Dir[pattern].each do |f|
+          add(f, metadata)
+        end
+
+        true
+      end
+
+      # Access a file by an index
+      def [](index)
+        @files[index]
+      end
+
+      # Remove a file from the list
+      #
+      # @param filename [String] Full name of the file to remove
+      def remove(filename)
+        @files.delete_if { |f| f[:file] == filename }
+      end
+
+      # Return the number of files
+      #
+      # @return [Integer] Number of items
+      def size
+        @files.size
+      end
+
+      # Iterate over the files
+      def each
+        @files.each { |i| yield i }
+      end
+
+      # remove all the items
+      def clear
+        @files.clear
+      end
+
+    end
+  end
+end

data/lib/openstudio/analysis/version.rb

@@ -1,5 +1,5 @@
 module OpenStudio
   module Analysis
-    VERSION = '0.4.1'
+    VERSION = '0.4.2'
   end
 end

data/lib/openstudio/analysis/workflow.rb

@@ -124,6 +124,10 @@ module OpenStudio
         end
       end
 
+      # Iterate over all the WorkflowItems
+      def each
+        @items.each { |i| yield i }
+      end
       # Find the measure by its instance name
       #
       # @params instance_name [String] instance name of the measure

data/lib/openstudio/analysis/workflow_step.rb

@@ -54,7 +54,7 @@ module OpenStudio
       # @return [Boolean] True/false if it assigned it
       def argument_value(argument_name, value)
         a = @arguments.find_all { |a| a[:name] == argument_name }
-        fail "could not find argument_name of #{argument_name} in measure #{name}" if a.empty?
+        fail "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
         fail "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
 
         a = a.first
@@ -90,7 +90,7 @@ module OpenStudio
         distribution[:mode] = distribution[:mean] if distribution.key? :mean
 
         a = @arguments.find_all { |a| a[:name] == argument_name }
-        fail "could not find argument_name of #{argument_name} in measure #{name}" if a.empty?
+        fail "could not find argument_name of #{argument_name} in measure #{name}. Valid argument names are #{argument_names}." if a.empty?
         fail "more than one argument with the same name of #{argument_name} in measure #{name}" if a.size > 1
 
         if distribution_valid?(distribution)
@@ -264,7 +264,7 @@ module OpenStudio
             s.arguments << {
               display_name: arg[:display_name],
               display_name_short: arg[:display_name],
-              name: arg[:local_variable],
+              name: arg[:name],
               value_type: var_type,
               default_value: arg[:default_value],
               value: arg[:default_value]

data/lib/openstudio-analysis.rb

@@ -20,6 +20,7 @@ require 'openstudio/analysis/version'
 
 # analysis classes
 require 'openstudio/analysis'
+require 'openstudio/analysis/support_files'
 require 'openstudio/analysis/formulation'
 require 'openstudio/analysis/workflow'
 require 'openstudio/analysis/workflow_step'