openstudio-extension 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd3f65a4f467a9beee5439e58dbeddc445da4dfeb606d23547865a57d461d06
-  data.tar.gz: 4f7c9792f4f9bc5419caff2aa57a4bd8dcdb4252ad8d77b8e6b28b50eedeeb99
+  metadata.gz: 6c5468ce39e3e858462a84b10da6eaf36ef110c8d6722256619eee95c4f0032c
+  data.tar.gz: d536d3216133d81b115ef61eab4ebc04c31d5842a23463674f038d1c65f92501
 SHA512:
-  metadata.gz: 61f585def76ef5d6998892f74fe8338744df5c90cdb26b906a04dbc5c53e7cfa1524c23e6636b3fd08acfcb8a2a0b9378473c24253265a320585b576ac9c4692
-  data.tar.gz: 6842e2d7eb60fd4d047d26e8b2e2e286819d3ed63a904f436bb1b8a28c2f469efcae2876eebf3372aad12716859d77350129f354a0336f8b4aedd31415cc953f
+  metadata.gz: f9305edc0f0a8fa54ba0ec4e0a4243f219a8d701018ec4dea4a2fb9662d1fe61f88923dce2abbe5c42e0f2f58a7dfc0eb3de3c632e7de3f3f160e728f032ea1e
+  data.tar.gz: 77b9a0cdba958bda77d308847c92478ba4ee2a8d20884af8498cc1982782b16a8f5fa38f5c9e59ed9a2badaa55527dbacd77e549d123533315500776c52e8c50

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # OpenStudio Extension Gem
 
+## Version 0.2.4
+
+* Fixed upload of measures to BCL using rake tasks.
+* Support economizer modeling when create_typical measure is split into two parts
+
+Closed Issues: 1
+- Fixed [#64]( https://github.com/NREL/openstudio-extension-gem/issues/64 ), README updates
+
 ## Version 0.2.3
 
 * Use new version of rubocop style from S3

data/README.md

@@ -146,14 +146,17 @@ Common Rake Tasks that are available to derivative extension gems include:
 
 | Rake Task | Description |
 | --------- | ----------- |
+| openstudio:bcl:test_login            | Test BCL login |
+| openstudio:bcl:search_measures       | Search BCL |
+| openstudio:bcl:stage[reset]          | Copy the measures/components to a staging location |
+| openstudio:bcl:push                  | Upload measures from the staging location |
+| openstudio:change_log[start_date,end_date,apikey] | Print the change log from GitHub. Specify dates in yyyy-mm-dd format |
 | openstudio:list_measures             | List all measures in the calling gem |
 | openstudio:measures:add_license      | Add License File to measures in the calling gem |
 | openstudio:measures:add_readme       | Add README.md.erb file if it and the README markdown file do not already exist for a measure |
 | openstudio:measures:copy_resources   | Copy the resources files to individual measures in the calling gem |
 | openstudio:measures:update_copyright | Update copyright on measure files in the calling gem |
 | openstudio`:runner:`init             | Create a runner.conf file running simulations |
-| openstudio:stage_bcl                 | Copy the measures to a location that can be uploaded to BCL |
-| openstudio:push_bcl                  | Upload measures from the specified location to the BCL |
 | openstudio:test_with_docker          | Use openstudio docker image to run tests |
 | openstudio:test_with_openstudio      | Use openstudio system ruby to run tests |
 | openstudio:update_measures           | Run the CLI task to check for measure updates and update the measure xml files |
@@ -176,8 +179,12 @@ The following table contains all current extension gems.
 | OpenStudio Common Measures Gem  | openstudio-common-measures | https://github.com/NREL/openstudio-common-measures-gem |
 | OpenStudio Model Articulation Gem   | openstudio-model-articulation | https://github.com/NREL/openstudio-model-articulation-gem |
 | OpenStudio AEDG Gem | openstudio-aedg | https://github.com/NREL/openstudio-aedg-gem | 
+| OpenStudio Calibration Gem | openstudio-calibration | https://github.com/NREL/openstudio-calibration-gem |
+| OpenStudio EE Gem | openstudio-ee | https://github.com/NREL/openstudio-ee-gem | 
 | OpenStudio District Systems Gem | openstudio-district-systems | https://github.com/NREL/openstudio-district-systems-gem | 
-| UrbanOpt GeoJSON Gem | urbanopt-geojson | https://github.com/urbanopt/urbanopt-geojson-gem | 
+| URBANopt Core Gem | urbanopt-core | https://github.com/urbanopt/urbanopt-core-gem |
+| URBANopt GeoJSON Gem | urbanopt-geojson | https://github.com/urbanopt/urbanopt-geojson-gem | 
+| URBANopt Scenario Gem | urbanopt-scenario | https://github.com/urbanopt/urbanopt-scenario-gem |
 | BuildingSync Gem | buildingsync | https://github.com/BuildingSync/BuildingSync-gem | 
 
 ### Initializing a new Extension Gem
@@ -236,8 +243,6 @@ Or install it yourself as:
 
 # TODO
 
-- [ ] Rake task ```stage_bcl``` _DLM: BCL gem should be a development dependency only until we can reduce its dependencies and remove native dependencies? should probably put it into a special group so we can bundle without it in openstudio-gems._
-- [ ] Rake task ```push_bcl``` _DLM: how do we want to test this?
 - [ ] Capture useful output from Travis (measure dashboard results, log files, zip of build products, etc) and put it somewhere (s3?  naming convention?)
 - [ ] ```Extension::files_dir``` _DLM: I think this can have a default implementation, right?_
 - [ ] ```Extension::minimum_openstudio_version``` _DLM: should we rename? should people overwrite this in their class?_

data/lib/openstudio/extension.rb

@@ -226,5 +226,26 @@ module OpenStudio
 
       return osw
     end
+
+    ##
+    # Module method used to check whether a measure is present in an OSW file
+    ##
+    #  @param [Hash] in_osw Initial OSW object as a Hash, keys should be symbolized
+    #  @param [String] measure_dir_name Directory name of measure to set argument on
+    #  @param [String] step_name Optional argument, if present used to further identify the measure
+    #
+    #  @return [Boolean] true or false
+    def self.measure_in_osw(osw, measure_dir_name, step_name = nil)
+      result = false
+      osw[:steps].each do |step|
+        if step[:measure_dir_name] == measure_dir_name
+          if step_name.nil? || step[:name] == step_name
+            result = true
+          end
+        end
+      end
+
+      return result
+    end
   end
 end

data/lib/openstudio/extension/core/os_lib_model_generation.rb

@@ -2560,6 +2560,19 @@ module OsLib_ModelGeneration
     # Make the standard applier
     standard = Standard.build((args['template']).to_s)
 
+    # validate climate zone
+    if !args.has_key?('climate_zone') || args['climate_zone'] == 'Lookup From Model'
+      climate_zone = standard.model_get_building_climate_zone_and_building_type(model)['climate_zone']
+      runner.registerInfo("Using climate zone #{climate_zone} from model")
+    else
+      climate_zone = args['climate_zone']
+      runner.registerInfo("Using climate zone #{climate_zone} from user arguments")
+    end
+    if climate_zone == ''
+      runner.registerError("Could not determine climate zone from measure arguments or model.")
+      return false
+    end
+
     # make sure daylight savings is turned on up prior to any sizing runs being done.
     if args['enable_dst']
       start_date = '2nd Sunday in March'
@@ -2646,13 +2659,6 @@ module OsLib_ModelGeneration
       else
         is_residential = 'No'
       end
-      if !args.has_key?('climate_zone') || args['climate_zone'] == 'Lookup From Model'
-        climate_zone = standard.model_get_building_climate_zone_and_building_type(model)['climate_zone']
-        runner.registerInfo("Using climate zone #{climate_zone} from model")
-      else
-        climate_zone = args['climate_zone']
-        runner.registerInfo("Using climate zone #{climate_zone} from user arguments")
-      end
       bldg_def_const_set = standard.model_add_construction_set(model, climate_zone, lookup_building_type, nil, is_residential)
       if bldg_def_const_set.is_initialized
         bldg_def_const_set = bldg_def_const_set.get
@@ -2797,16 +2803,25 @@ module OsLib_ModelGeneration
       end
     end
 
-    # TODO: - when add methods below add bool to enable/disable them with default value to true
+    # add_daylighting_controls (since outdated measure don't have this default to true if arg not found)
+    if !args.has_key?('add_daylighting_controls')
+      args['add_daylighting_controls'] = true
+    end
+    if args['add_daylighting_controls']
+      # remove add_daylighting_controls objects
+      if args['remove_objects']
+        model.getDaylightingControls.each(&:remove)
+      end
 
-    # add daylight controls, need to perform a sizing run for 2010
-    if args['template'] == '90.1-2010'
-      if standard.model_run_sizing_run(model, "#{Dir.pwd}/SRvt") == false
-        log_messages_to_runner(runner, debug = true)
-        return false
+      # add daylight controls, need to perform a sizing run for 2010
+      if args['template'] == '90.1-2010'
+        if standard.model_run_sizing_run(model, "#{Dir.pwd}/SRvt") == false
+          log_messages_to_runner(runner, debug = true)
+          return false
+        end
       end
-    end
     standard.model_add_daylighting_controls(model)
+    end
 
     # add refrigeration
     if args['add_refrigeration']
@@ -3034,20 +3049,6 @@ module OsLib_ModelGeneration
       end
     end
 
-    # add internal mass
-    if args['add_internal_mass']
-
-      if args['remove_objects']
-        model.getSpaceLoads.each do |instance|
-          next unless instance.to_InternalMass.is_initialized
-          instance.remove
-        end
-      end
-
-      # add internal mass to conditioned spaces; needs to happen after thermostats are applied
-      standard.model_add_internal_mass(model, primary_bldg_type)
-    end
-
     # set unmet hours tolerance
     unmet_hrs_tol_r = args['unmet_hours_tolerance']
     unmet_hrs_tol_k = OpenStudio.convert(unmet_hrs_tol_r, 'R', 'K').get

data/lib/openstudio/extension/rake_task.rb

@@ -138,7 +138,7 @@ module OpenStudio
             runner.update_copyright(@root_dir, @doc_templates_dir)
           end
 
-          desc 'Print the change log from GitHub'
+          desc 'Print the change log from GitHub. Date format: yyyy-mm-dd'
           task :change_log, [:start_date, :end_date, :apikey] do |t, args|
             require 'change_log'
             cl = ChangeLog.new(@github_repo, *args)
@@ -334,6 +334,36 @@ module OpenStudio
               # grab all the updated content (measures and components) tar files and push to bcl
               items = []
               paths = Pathname.glob(@staged_path.to_s + '/update/*.tar.gz')
+              paths.each do |path|
+                # puts path
+                items << path.to_s
+              end
+              items.each do |item|
+                puts item.split('/').last
+                total_count += 1
+
+                receipt_file = File.dirname(item) + '/' + File.basename(item, '.tar.gz') + '.receipt'
+                if !reset && File.exist?(receipt_file)
+                  skipped += 1
+                  puts 'SKIP: receipt file found'
+                  next
+                end
+
+                valid, res = bcl.update_content(item, true)
+                if valid
+                  successes += 1
+                else
+                  errors += 1
+                  if res.key?(:error)
+                    puts "  ERROR MESSAGE: #{res[:error]}"
+                  else
+                    puts "ERROR MESSAGE: #{res.inspect.chomp}"
+                  end
+                end
+                puts '', '---'
+              end
+
+              puts "****UPLOAD DONE**** #{total_count} total, #{successes} success, #{errors} failures, #{skipped} skipped"
             end
           end
         end

data/lib/openstudio/extension/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.2.3'.freeze
+    VERSION = '0.2.4'.freeze
   end
 end

data/openstudio-extension.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bundler', '~> 2.1'
   spec.add_dependency 'octokit', '~> 4.18.0' # for change logs
   spec.add_dependency 'openstudio-workflow', '~> 2.0.0'
-  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.2'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.2.3'
   spec.add_dependency 'parallel', '~> 1.19.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +218,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/openstudio-extension-gem/issues
   changelog_uri: https://github.com/NREL/openstudio-extension-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.2.3
+  source_code_uri: https://github.com/NREL/openstudio-extension-gem/tree/v0.2.4
 post_install_message: 
 rdoc_options: []
 require_paths: