openstudio-analysis 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce67306a44fa45d81b14281b40e5e9d311333b83c4741fff3dc735d05fb273d
-  data.tar.gz: b7786960a5d47cfacfea90db7c86fa3f5d25ae66185cb004ec59edcd8449d267
+  metadata.gz: b307b715407bd74c16e687f0acfe025555e232cab093d493ddfec92930208928
+  data.tar.gz: b03f1c1c73cbd0c7ec95033e91874d9a4ec6ff267ca038877a04d18ec8772f7d
 SHA512:
-  metadata.gz: 6324de334d0b870124f373020b54d8493ca91c3d74d441f5adf8c12dd762ec51d042bd9528fe1b5db8b52844007ba887c2a50ea373615fcf800c5bf6fc501e80
-  data.tar.gz: dfbe7fa89ec24428a0864d55dc14d48c368665fe541e572729af1cb95b034c9555543e54da0cf4827744d8c3fd813a8905f33878a2352b4fc85f8a98506ea6ee
+  metadata.gz: ba82343b9d2bc7e35439d1583ee39b6938459e1fd0f83cd6993ab1e6e71dcf185f2da7fedb62d4b02267664576c42b941e22e3fcf673ac321812998ca60bd07d
+  data.tar.gz: 4a8aad3e2348fa63e25c6aa07e496b75a79be7b9aa2af92075c1e63524296e60150169f0c9e732c13cd962b6c701e16a16b50474e7005fb3cbf7e090981ee7df

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 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

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/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.1'.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

metadata

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