openstudio-analysis 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57c83c75eb61c8b4253907c07d2f4cc1eaa6939aa27c30dc5fdae7bc0bd551f
-  data.tar.gz: c2299fdd5b78dfc58792c4bf35aa621f2a4e1db862e2e5b3fcd93107ee7f82ae
+  metadata.gz: b307b715407bd74c16e687f0acfe025555e232cab093d493ddfec92930208928
+  data.tar.gz: b03f1c1c73cbd0c7ec95033e91874d9a4ec6ff267ca038877a04d18ec8772f7d
 SHA512:
-  metadata.gz: eac9ee6feee2103b9fe6b9529116f5939145198b8dee8ea9c7094ea5fe0d61e47fb009882c73b0770c152c997f319c5202c56266c6bbd84ca3775a2a98b1074c
-  data.tar.gz: ac4167112ffa932916d99c765d1486e184ad154f65e49b70b56d99b458bb3a3458371687450e031cc6d0afa92318e647c4756625dd5ef1f097937a50c0d43e88
+  metadata.gz: ba82343b9d2bc7e35439d1583ee39b6938459e1fd0f83cd6993ab1e6e71dcf185f2da7fedb62d4b02267664576c42b941e22e3fcf673ac321812998ca60bd07d
+  data.tar.gz: 4a8aad3e2348fa63e25c6aa07e496b75a79be7b9aa2af92075c1e63524296e60150169f0c9e732c13cd962b6c701e16a16b50474e7005fb3cbf7e090981ee7df

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 1.3.1
+-------------
+* Add method to delete a Variable 
+
+Version 1.3.0
+-------------
+* Create an OSA from an OSW
+
 Version 1.2.0
 -------------
 * master -> main

data/LICENSE.md

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

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -39,12 +39,20 @@
 module OpenStudio
   module Analysis
     class AlgorithmAttributes
-      # Create a new instance of an algorithm
+      # Create a new instance of the parameters for an algorithm 
       #
       def initialize
-        @attributes = {}
+        @attributes = {
+        "seed": nil,
+        "failed_f_value": 1000000000000000000,
+        "debug_messages": 1
+        }
       end
 
+      # these are the allowed analysis types
+      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
         begin

data/lib/openstudio/analysis/formulation.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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,6 +58,7 @@ module OpenStudio
       attr_accessor :display_name
       attr_accessor :workflow
       attr_accessor :algorithm
+      attr_accessor :osw_path
 
       # the attributes below are used for packaging data into the analysis zip file
       attr_reader :weather_files
@@ -65,6 +66,7 @@ module OpenStudio
       attr_reader :worker_inits
       attr_reader :worker_finalizes
       attr_reader :libraries
+      attr_reader :server_scripts
 
       # Create an instance of the OpenStudio::Analysis::Formulation
       #
@@ -74,7 +76,7 @@ module OpenStudio
         @display_name = display_name
         @analysis_type = nil
         @outputs = []
-
+        @workflow = OpenStudio::Analysis::Workflow.new
         # Initialize child objects (expect workflow)
         @weather_file = WeatherFile.new
         @seed_model = SeedModel.new
@@ -86,20 +88,22 @@ module OpenStudio
         @worker_inits = SupportFiles.new
         @worker_finalizes = SupportFiles.new
         @libraries = SupportFiles.new
-        # @initialization_scripts = SupportFiles.new
-      end
-
-      # Initialize or return the current workflow object
-      #
-      # @return [Object] An OpenStudio::Analysis::Workflow object
-      def workflow
-        @workflow ||= OpenStudio::Analysis::Workflow.new
+        @server_scripts = ServerScripts.new
       end
-
+     
       # Define the type of analysis which is going to be running
       #
       # @param name [String] Name of the algorithm/analysis. (e.g. rgenoud, lhs, single_run)
-      attr_writer :analysis_type
+      # allowed values are ANALYSIS_TYPES = ['spea_nrel', 'rgenoud', 'nsga_nrel', 'lhs', 'preflight', 
+      #                                      'morris', 'sobol', 'doe', 'fast99', 'ga', 'gaisl', 
+      #                                      'single_run', 'repeat_run', 'batch_run']
+      def analysis_type=(value)
+        if OpenStudio::Analysis::AlgorithmAttributes::ANALYSIS_TYPES.include?(value)
+          @analysis_type = value
+        else
+          raise "Invalid analysis type. Allowed types: #{OpenStudio::Analysis::AlgorithmAttributes::ANALYSIS_TYPES}"
+        end
+      end
 
       # Path to the seed model
       #
@@ -133,29 +137,43 @@ module OpenStudio
       # @option output_hash [Float] :scaling_factor How to scale the objective function(s). Default: nil
       # @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
-        }.merge(output_hash)
-
-        # Check if the name is already been added. Note that if the name is added again, it will not update any of
-        # the fields
-        exist = @outputs.select { |o| o[:name] == output_hash[:name] }
-        if exist.empty?
+        # Check if the name is already been added.
+        exist = @outputs.find_index { |o| o[:name] == output_hash[:name] }
+        # if so, update the fields but keep objective_function_index the same
+        if exist
+          original = @outputs[exist]
+          if original[:objective_function] && !output_hash[:objective_function]
+            return @outputs
+          end
+          output = original.merge(output_hash)
+          output[:objective_function_index] = original[:objective_function_index]
+          @outputs[exist] = output
+        else
+          output = {
+            units: '',
+            objective_function: false,
+            objective_function_index: nil,
+            objective_function_target: nil,
+            #set default to nil or 1 if objective_function is true and this is not set
+            objective_function_group: (output_hash[:objective_function] ? 1 : nil),
+            scaling_factor: nil,
+            #set default to false or true if objective_function is true and this is not set
+            visualize: (output_hash[:objective_function] ? true : false),
+            metadata_id: nil,
+            export: true,
+          }.merge(output_hash)
+          #set display_name default to be name if its not set
+          output[:display_name] = output_hash[:display_name] ? output_hash[:display_name] : output_hash[:name]
+          #set display_name_short default to be display_name if its not set, this can be null if :display_name not set
+          output[:display_name_short] = output_hash[:display_name_short] ? output_hash[:display_name_short] : output_hash[:display_name]
           # if the variable is an objective_function, then increment and
           # assign and objective function index
-          if output_hash[:objective_function]
+          if output[:objective_function]
             values = @outputs.select { |o| o[:objective_function] }
-            output_hash[:objective_function_index] = values.size # size is already +1
-          else
-            output_hash[:objective_function] = false
+            output[:objective_function_index] = values.size
           end
 
-          @outputs << output_hash
+          @outputs << output
         end
 
         @outputs
@@ -215,6 +233,16 @@ module OpenStudio
           end
 
           h[:analysis][:file_format_version] = version
+          h[:analysis][:cli_debug] = "--debug"
+          h[:analysis][:cli_verbose] = "--verbose"
+          h[:analysis][:run_workflow_timeout] = 28800
+          h[:analysis][:upload_results_timeout] = 28800
+          h[:analysis][:initialize_worker_timeout] = 28800
+          #-BLB I dont think this does anything. server_scripts are run if they are in 
+          #the /scripts/analysis or /scripts/data_point directories
+          #but nothing is ever checked in the OSA.
+          #
+          h[:analysis][:server_scripts] = {}
 
           # This is a hack right now, but after the initial hash is created go back and add in the objective functions
           # to the the algorithm as defined in the output_variables list
@@ -321,9 +349,209 @@ module OpenStudio
 
         save_analysis_zip(filename)
       end
+      
+      
+      def save_osa_zip(filename)
+        filename += '.zip' if File.extname(filename) == ''
+
+        FileUtils.mkdir_p File.dirname(filename) unless Dir.exist? File.dirname(filename)
+
+        save_analysis_zip_osa(filename)
+      end
+      
+      # convert an OSW to an OSA
+      # osw_filename is the full path to the OSW file
+      # assumes the associated files and directories are in the same location
+      #  /example.osw
+      #  /measures
+      #  /seeds
+      #  /weather
+      #
+      def convert_osw(osw_filename)
+        #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)
+        else
+          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 analysis_type default to Single_Run
+        self.analysis_type = 'single_run'
+
+        #loop over OSW 'steps' and map over measures
+        #there is no name/display name in the OSW. Just measure directory name
+        #read measure.XML from directory to get name / display name
+        #increment name by +_1 if there are duplicates
+        #add measure
+        #change default args to osw arg values 
+        
+        osw[:steps].each do |step|
+          #get measure directory
+          measure_dir = step[:measure_dir_name]
+          measure_name = measure_dir.split("measures/").last
+          #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'))       
+          #add check for previous names _+1
+          count = 1
+          name = xml[:name]
+          display_name = xml[:display_name]
+          loop do
+            measure = @workflow.find_measure(name)
+            break if measure.nil?
+
+            count += 1
+            name = "#{xml[:name]}_#{count}"
+            display_name = "#{xml[:display_name]} #{count}"
+          end   
+          #Add Measure to workflow
+          @workflow.add_measure_from_path(name, display_name, measure_dir_abs_path)  #this forces to an absolute path which seems constent with PAT
+          #@workflow.add_measure_from_path(name, display_name, measure_dir)  #this uses the path in the OSW which could be relative          
+          
+          #Change the default argument values to the osw values
+          #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)
+          end
+          
+        end
+      end
 
       private
 
+      # 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 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
+        end
+        #delete file if exists
+        FileUtils.rm_f(filename) if File.exist?(filename)
+        #get the full path to the OSW, since all Files/Dirs should be in same directory as the OSW
+        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
+          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(/^\.\//, '')))
+          else
+            raise "Weather file does not exist at: #{File.join(osw_full_path,@weather_file[:file].sub(/^\.\//, ''))}"
+          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 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(/^\.\//, '')))
+          else
+            raise "Seed file does not exist at: #{File.join(osw_full_path,@seed_model[:file].sub(/^\.\//, ''))}"
+          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]
+
+            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: Server Scripts'
+          @server_scripts.each_with_index do |f, index|
+            if f[:init_or_final] == 'finalization'
+              file_name = 'finalization.sh'
+            else
+              file_name = 'initialization.sh'
+            end
+            if f[:server_or_data_point] == 'analysis'
+              new_name = "scripts/analysis/#{file_name}"
+            else
+              new_name = "scripts/data_point/#{file_name}"
+            end
+            puts "  Adding #{f[:file]} as #{new_name}"
+            zf.add(new_name, f[:file])
+
+            if f[:arguments]
+              arg_file = "#{(new_name.sub(/\.sh\z/, ''))}.args"
+              puts "  Adding arguments as #{arg_file}"
+              file = Tempfile.new('arg')
+              file.write(f[:arguments])
+              zf.add(arg_file, file)
+              file.close
+            end
+          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_local
+
+            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'
+                  #remove leading ./ from measure_definition_directory path if there.
+                  add_directory_to_zip_osa(zf, file, "#{measure.measure_definition_directory.sub(/^\.\//, '')}/#{File.basename(file)}")
+                end
+              else
+                puts "    Adding File #{file}"
+                #remove leading ./ from measure.measure_definition_directory string with regex .sub(/^\.\//, '')
+                zip_path_for_measures = file.sub(measure_dir_to_add, measure.measure_definition_directory.sub(/^\.\//, ''))
+                #puts "    zip_path_for_measures: #{zip_path_for_measures}"
+                zf.add(zip_path_for_measures, file)
+              end
+            end
+
+            added_measures << measure_dir_to_add
+          end
+        end
+      end
+      
+      #keep legacy function
       # Package up the seed, weather files, and measures
       def save_analysis_zip(filename)
         def add_directory_to_zip(zipfile, local_directory, relative_zip_directory)
@@ -399,17 +627,17 @@ module OpenStudio
           @worker_finalizes.each_with_index do |f, index|
             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], "./scripts/worker_finalization/#{ordered_file_name}"), f[:file])
+            zf.add(f[:file].sub(f[:file], "scripts/worker_finalization/#{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("./scripts/worker_finalization/#{arg_file}", file)
+              zf.add("scripts/worker_finalization/#{arg_file}", file)
               file.close
             end
           end
-
+          
           ## Measures
           puts 'Adding Measures'
           added_measures = []

data/lib/openstudio/analysis/server_api.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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_scripts.rb

@@ -0,0 +1,138 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES
+# GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+# OpenStudio::Analysis::ServerScripts is a container to hold the analysis and data_point server scripts.
+module OpenStudio
+  module Analysis
+    class ServerScripts
+      attr_reader :files
+
+      # Create a new instance of the Server Scripts file class
+      # Server scripts are run at either the analysis or data_point level and are either initialization or finalization
+      # file: full path to the script
+      # arguments: array of arguments for the script
+      # init_or_final: specify either 'initialization' or 'finalization'
+      # server_or_data_point: specify either 'analysis' or 'data_point'
+      #
+      def initialize
+        @files = []
+      end
+
+      def add(file, arguments, init_or_final = 'initialization', server_or_data_point = 'data_point')
+      
+        file_path = File.expand_path(file)
+        if !File.exist?(file_path)
+          raise ArgumentError, "File at '#{file_path}' does not exist"
+        end
+    
+        if init_or_final != 'initialization' && init_or_final != 'finalization'
+          raise ArgumentError, "init_or_final must be 'initialization' or 'finalization'"
+        end
+        
+        if server_or_data_point != 'analysis' && server_or_data_point != 'data_point'
+          raise ArgumentError, "server_or_data_point must be 'analysis' or 'data_point'"
+        end
+        
+        if !arguments.is_a?(Array)
+          raise ArgumentError, "arguments must be an array"
+        end
+    
+        file = {
+          file: file_path,
+          arguments: arguments,
+          init_or_final: init_or_final,
+          server_or_data_point: server_or_data_point
+        }
+        @files << file
+        true
+      end
+      
+      # Check if the array is empty
+      def empty?
+        @files.empty?
+      end
+
+      # Return the first
+      def first
+        @files.first
+      end
+
+      # Return the last
+      def last
+        @files.last
+      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
+
+      # Iterate over the files with index
+      def each_with_index
+        @files.each_with_index { |d, index| yield d, index }
+      end
+
+      # remove all the items
+      def clear
+        @files.clear
+      end
+
+      # find the first object. There has to be a better way to do this. Can I just inherit an array?
+      def find
+        @files.find { |i| yield i }
+      end
+      
+    end
+  end
+end

data/lib/openstudio/analysis/support_files.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/excel.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/workflow.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/version.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -37,6 +37,6 @@ module OpenStudio
   module Analysis
     # format should be ^.*\-{1}[a-z]+[0-9]+
     # for example: -rc1, -beta6, -customusecase0
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.3.1'.freeze
   end
 end

data/lib/openstudio/analysis/workflow.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/workflow_step.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -50,6 +50,11 @@ module OpenStudio
       attr_accessor :measure_definition_name_xml
       attr_accessor :measure_definition_uuid
       attr_accessor :measure_definition_version_uuid
+      attr_accessor :uuid
+      attr_accessor :version_uuid
+      attr_accessor :description
+      attr_accessor :taxonomy
+      
       attr_reader :arguments
       attr_reader :variables
 
@@ -71,6 +76,10 @@ module OpenStudio
         @measure_definition_name_xml = nil
         @measure_definition_uuid = nil
         @measure_definition_version_uuid = nil
+        @uuid = nil
+        @version_uuid = nil
+        @description = nil
+        #@taxonomy = nil #BLB dont do this now
         @arguments = []
 
         @arguments << {
@@ -120,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.
@@ -215,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
@@ -305,6 +330,10 @@ module OpenStudio
         s.measure_definition_name_xml = hash[:name_xml]
         s.measure_definition_uuid = hash[:uid]
         s.measure_definition_version_uuid = hash[:version_id]
+        s.uuid = hash[:uid]
+        s.version_uuid = hash[:version_id]
+        s.description = hash[:description]
+        #s.taxonomy = hash[:taxonomy]   #BLB dont do this now
 
         # do not allow the choice variable_type
 
@@ -318,13 +347,30 @@ module OpenStudio
             var_type = 'string'
           end
 
+          
+          if var_type.downcase == 'double'
+            default_value = arg[:default_value].to_f
+          elsif var_type.downcase == 'integer'
+            default_value = arg[:default_value].to_i  
+          elsif var_type.downcase == 'boolean'
+            default_value = (arg[:default_value].downcase == "true")  #convert the string 'true'/'false' to boolean
+          else
+            default_value = arg[:default_value]
+          end
+          
+          if !arg[:display_name_short].nil?
+            display_name_short = arg[:display_name_short]
+          else
+            display_name_short = arg[:display_name]
+          end
+          
           s.arguments << {
             display_name: arg[:display_name],
-            display_name_short: arg[:display_name_short],
+            display_name_short: display_name_short,
             name: arg[:name],
             value_type: var_type,
-            default_value: arg[:default_value],
-            value: arg[:default_value]
+            default_value: default_value,
+            value: default_value
           }
         end
 
@@ -389,6 +435,10 @@ module OpenStudio
         s.measure_definition_name_xml = hash[:measure_definition_name_xml]
         s.measure_definition_uuid = hash[:measure_definition_uuid]
         s.measure_definition_version_uuid = hash[:measure_definition_version_uuid]
+        s.uuid = hash[:uuid] if hash[:uuid] 
+        s.version_uuid = hash[:version_uuid] if hash[:version_uuid]
+        s.description = hash[:description] if hash[:description] 
+        #s.taxonomy = hash[:taxonomy] if hash[:taxonomy] #BLB dont do this, its a Tags array of Tag
 
         s.type = hash[:measure_type] # this is actually the measure type
         hash[:arguments]&.each do |arg|
@@ -400,13 +450,33 @@ module OpenStudio
             var_type = 'string'
           end
 
+          if var_type.downcase == 'double'
+            default_value = arg[:default_value].to_f
+            value = arg[:value].to_f
+          elsif var_type.downcase == 'integer'
+            default_value = arg[:default_value].to_i
+            value = arg[:value].to_i            
+          elsif var_type.downcase == 'boolean'
+            default_value = (arg[:default_value].downcase == "true")  #convert the string 'true'/'false' to boolean
+            value = (arg[:value].downcase == "true")  #convert the string 'true'/'false' to boolean
+          else
+            default_value = arg[:default_value]
+            value = arg[:value]
+          end
+          
+          if !arg[:display_name_short].nil?
+            display_name_short = arg[:display_name_short]
+          else
+            display_name_short = arg[:display_name]
+          end
+          
           s.arguments << {
             display_name: arg[:display_name],
-            display_name_short: arg[:display_name_short],
+            display_name_short: display_name_short,
             name: arg[:name],
             value_type: var_type,
-            default_value: arg[:default_value],
-            value: arg[:value]
+            default_value: default_value,
+            value: value
           }
         end
 

data/lib/openstudio/analysis.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/helpers/hash.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/helpers/string.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/helpers/utils.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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/weather/epw.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -61,6 +61,7 @@ require 'openstudio/analysis/formulation'
 require 'openstudio/analysis/workflow'
 require 'openstudio/analysis/workflow_step'
 require 'openstudio/analysis/algorithm_attributes'
+require 'openstudio/analysis/server_scripts'
 
 # translators
 require 'openstudio/analysis/translator/excel'

data/openstudio-analysis.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'rubyzip', '~> 2.3.0'
   s.add_dependency 'semantic', '~> 1.4'
 
+  s.add_development_dependency 'json-schema', '~> 2.8.0'
   s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.9'
   s.add_development_dependency 'rubocop', '~> 0.54.0'

data/update_license.rb

@@ -6,7 +6,7 @@ js_regex = /^\/\* @preserve.*Copyright.*license.{2}\*\//m
 
 ruby_header_text = <<EOT
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+# OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -45,7 +45,7 @@ ruby_header_text.strip!
 erb_header_text = <<EOT
 <%
   # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC.
+  # OpenStudio(R), Copyright (c) 2008-2023, 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:
@@ -84,7 +84,7 @@ erb_header_text.strip!
 
 js_header_text = <<EOT
 /* @preserve
- * OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC. All rights reserved.
+ * OpenStudio(R), Copyright (c) 2008-2023, Alliance for Sustainable Energy, LLC. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be found at openstudio.net/license.
 */
 EOT

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-analysis
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nicholas Long
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2023-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +184,7 @@ files:
 - lib/openstudio/analysis/algorithm_attributes.rb
 - lib/openstudio/analysis/formulation.rb
 - lib/openstudio/analysis/server_api.rb
+- lib/openstudio/analysis/server_scripts.rb
 - lib/openstudio/analysis/support_files.rb
 - lib/openstudio/analysis/translator/datapoints.rb
 - lib/openstudio/analysis/translator/excel.rb
@@ -187,7 +202,7 @@ homepage: http://openstudio.nrel.gov
 licenses:
 - BSD
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Create JSON, ZIP to communicate with OpenStudio Distributed Analysis in the
   Cloud