openstudio-standards 0.2.0 → 0.2.1

data/lib/openstudio-standards/prototypes/common/objects/Prototype.Model.rb

@@ -19,7 +19,7 @@ Standard.class_eval do
       # this is required to be blank otherwise it may cause side effects.
       epw_file = ''
     end
-    model = load_initial_osm(@geometry_file)
+    model = load_geometry_osm(@geometry_file)
     model.getThermostatSetpointDualSetpoints(&:remove)
     model.getBuilding.setName(self.class.to_s)
     # save new basefile to new geometry folder as class name.

data/lib/openstudio-standards/prototypes/common/objects/Prototype.utilities.rb

@@ -102,6 +102,28 @@ class Standard
     return model
   end
 
+  # Loads a JSON file containing the space type map into a hash
+  #
+  # @param hvac_map_file [String] path to JSON file, relative to the /data folder
+  # @return [Hash] returns a hash that contains the space type map
+  def load_hvac_map(hvac_map_file)
+    # Load the geometry .osm from relative to the data folder
+    rel_path_to_hvac_map = "../../../../../data/#{hvac_map_file}"
+
+    # Load the JSON depending on whether running from normal gem location
+    # or from the embedded location in the OpenStudio CLI
+    if File.dirname(__FILE__)[0] == ':'
+      # running from embedded location in OpenStudio CLI
+      hvac_map_string = load_resource_relative(rel_path_to_hvac_map)
+      hvac_map = JSON.parse(hvac_map_string)
+    else
+      abs_path = File.join(File.dirname(__FILE__), rel_path_to_hvac_map)
+      hvac_map = JSON.parse(File.read(abs_path))if File.exist?(abs_path)
+    end
+
+    return hvac_map
+  end
+
   # Convert from SEER to COP (no fan) for cooling coils
   # @ref [References::ASHRAE9012013] Appendix G
   #

data/lib/openstudio-standards/prototypes/common/prototype_metaprogramming.rb

@@ -70,9 +70,9 @@ end
     end
     @lookup_building_type = self.model_get_lookup_name(@@building_type)
     #ideally we should map the data required to a instance variable.
-    @geometry_file = Folders.instance.data_geometry_folder + '/' + self.class.name + '.osm'
-    hvac_map_file =  Folders.instance.data_geometry_folder + '/' + self.class.name + '.hvac_map.json'
-    @system_to_space_map = JSON.parse(File.read(hvac_map_file))if File.exist?(hvac_map_file)
+    @geometry_file = 'geometry/' + self.class.name + '.osm'
+    hvac_map_file =  'geometry/' + self.class.name + '.hvac_map.json'
+    @system_to_space_map = load_hvac_map(hvac_map_file)
     self.set_variables()
   end
   # This method is used to extend the class with building-type-specific
@@ -188,9 +188,9 @@ end
       end
       @lookup_building_type = self.model_get_lookup_name(@building_type)
       #ideally we should map the data required to a instance variable.
-      @geometry_file = Folders.instance.data_geometry_folder + '/' + self.class.name + '.osm'
-      hvac_map_file =  Folders.instance.data_geometry_folder + '/' + self.class.name + '.hvac_map.json'
-      @system_to_space_map = JSON.parse(File.read(hvac_map_file))if File.exist?(hvac_map_file)
+      @geometry_file = 'geometry/' + self.class.name + '.osm'
+      hvac_map_file =  'geometry/' + self.class.name + '.hvac_map.json'
+      # @system_to_space_map = load_hvac_map(hvac_map_file) # No HVAC map json files for NECB
       self.set_variables()
     end
 
@@ -512,19 +512,9 @@ end
     end
     @lookup_building_type = @@building_type
     #ideally we should map the data required to a instance variable.
-    @geometry_file = Folders.instance.data_geometry_folder + '/' + @prototype_input['geometry_osm']
-    if !File.exist?(@geometry_file)
-      OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Model', \"Could not find prototype inputs for \#{{'template' => @template,'building_type' => @@building_type, 'hvac' => @@hvac_system}}, cannot create model.\")
-      raise(\"Could not find geometry osm \#{@prototype_input['geometry_osm']} for #{template}#{building_type}#{hvac_system}, cannot create model.\")
-      return false
-    end
-    hvac_map_file =  Folders.instance.data_geometry_folder + '/' + @prototype_input['hvac_json']
-    if !File.exist?(hvac_map_file)
-      OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Model', \"Could not find prototype inputs for \#{{'template' => @template,'building_type' => @@building_type, 'hvac' => @@hvac_system}}, cannot create model.\")
-      raise(\"Could not find HVAC json \#{@prototype_input['hvac_json']} for #{template}#{building_type}#{hvac_system}, cannot create model.\")
-      return false
-    end
-    @system_to_space_map = JSON.parse(File.read(hvac_map_file))if File.exist?(hvac_map_file)
+    @geometry_file = 'geometry/' + @prototype_input['geometry_osm']
+    hvac_map_file =  'geometry/' + @prototype_input['hvac_json']
+    @system_to_space_map = load_hvac_map(hvac_map_file)
     self.set_variables()
   end
 

data/lib/openstudio-standards/standards/Standards.Model.rb

@@ -4433,16 +4433,33 @@ class Standard
 
   # Loads a osm as a starting point.
   #
+  # @param osm_file [String] path to the .osm file, relative to the /data folder
   # @return [Bool] returns true if successful, false if not
-  def load_initial_osm(osm_file)
-    # Load the geometry .osm
-    unless File.exist?(osm_file)
-      raise("The initial osm path: #{osm_file} does not exist.")
-    end
-    osm_model_path = OpenStudio::Path.new(osm_file.to_s)
-    # Upgrade version if required.
-    version_translator = OpenStudio::OSVersion::VersionTranslator.new
-    model = version_translator.loadModel(osm_model_path).get
+  def load_geometry_osm(osm_file)
+    # Load the geometry .osm from relative to the data folder
+    osm_model_path = "../../../data/#{osm_file}"
+
+    # Load the .osm depending on whether running from normal gem location
+    # or from the embedded location in the OpenStudio CLI
+    if File.dirname(__FILE__)[0] == ':'
+      # running from embedded location in OpenStudio CLI
+      geom_model_string = load_resource_relative(osm_model_path)
+      version_translator = OpenStudio::OSVersion::VersionTranslator.new
+      model = version_translator.loadModelFromString(geom_model_string)
+    else
+      abs_path = File.join(File.dirname(__FILE__), osm_model_path)
+      version_translator = OpenStudio::OSVersion::VersionTranslator.new
+      model = version_translator.loadModel(abs_path)
+    end
+
+    # Check that the model loaded successfully
+    if model.empty?
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Version translation failed for #{osm_model_path}")
+      return false
+    end
+    model = model.get
+
+    # Check for expected characteristics of geometry model
     if model.getBuildingStorys.empty?
       OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Please assign Spaces to BuildingStorys in the geometry model: #{osm_model_path}.")
     end

data/lib/openstudio-standards/standards/necb/necb_2011/data/standards_data.rb

@@ -88,10 +88,17 @@ class StandardsData
   end
 
   def load_standards_data(datafolder = File.dirname(__FILE__))
-    files = Dir.glob("#{datafolder}/**/*.json").select {|e| File.file? e}
     @standards_data = {}
-    files.each do |file|
-      @standards_data = standards_data.deep_merge (JSON.parse(File.read(file)))
+    if __dir__[0] == ':' # Running from OpenStudio CLI
+      files = embedded_files_relative('./', /.*\.json/)
+      files.each do |file|
+        @standards_data = standards_data.deep_merge(JSON.parse(EmbeddedScripting.getFileAsString(file)))
+      end
+    else
+      files = Dir.glob("#{datafolder}/**/*.json").select {|e| File.file? e}
+      files.each do |file|
+        @standards_data = standards_data.deep_merge (JSON.parse(File.read(file)))
+      end
     end
     @standards_data = @standards_data.sort_by_key(true)
     return @standards_data

data/lib/openstudio-standards/standards/necb/necb_2011/necb_2011.rb

@@ -6,23 +6,34 @@ class NECB2011 < Standard
   attr_reader :template
   attr_accessor :standards_data
 
-
+  # Combine the data from the JSON files into a single hash
+  # Load JSON files differently depending on whether loading from
+  # the OpenStudio CLI embedded filesystem or from typical gem installation
   def load_standards_database_new()
-    # Combine the data from the JSON files into a single hash
-    top_dir = File.expand_path('../../..', File.dirname(__FILE__))
-    standards_data_dir = "#{top_dir}/data/"
-    files = Dir.glob("#{File.dirname(__FILE__)}/data/*.json").select {|e| File.file? e}
     @standards_data = {}
     @standards_data["tables"] = []
-    files.each do |file|
-      #puts "loading standards data from #{file}"
-      data = JSON.parse(File.read(file))
-      if not data["tables"].nil? and data["tables"].first["data_type"] =="table"
-        @standards_data["tables"] << data["tables"].first
-      else
-        @standards_data[data.keys.first] = data[data.keys.first]
+
+    if __dir__[0] == ':' # Running from OpenStudio CLI
+      embedded_files_relative('data/', /.*\.json/).each do |file|
+        data = JSON.parse(EmbeddedScripting.getFileAsString(file))
+        if not data["tables"].nil? and data["tables"].first["data_type"] =="table"
+          @standards_data["tables"] << data["tables"].first
+        else
+          @standards_data[data.keys.first] = data[data.keys.first]
+        end
+      end
+    else
+      files = Dir.glob("#{File.dirname(__FILE__)}/data/*.json").select {|e| File.file? e}
+      files.each do |file|
+        data = JSON.parse(File.read(file))
+        if not data["tables"].nil? and data["tables"].first["data_type"] =="table"
+          @standards_data["tables"] << data["tables"].first
+        else
+          @standards_data[data.keys.first] = data[data.keys.first]
+        end
       end
     end
+
     #needed for compatibility of standards database format
     @standards_data['tables'].each do |table|
       @standards_data[table['name']] = table
@@ -102,7 +113,7 @@ class NECB2011 < Standard
     #get models weather object to get the province. Then use that to look up the province.
     epw = BTAP::Environment::WeatherFile.new(model.weatherFile.get.path.get)
     fuel_sources = @standards_data['tables'].detect {|table| table['name'] == 'regional_fuel_use'}['table'].detect {|fuel_sources| fuel_sources['state_province_regions'].include?(epw.state_province_region)}
-    raise() if fuel_sources.nil? #this should never happen since we are using only canadian weather files.
+    raise("Could not find fuel sources for weather file, make sure it is a Canadian weather file.") if fuel_sources.nil? #this should never happen since we are using only canadian weather files.
     return fuel_sources
   end
 
@@ -136,7 +147,7 @@ class NECB2011 < Standard
     raise 'no building_type!' if @instvarbuilding_type.nil?
     model = nil
     # prototype generation.
-    model = load_initial_osm(@geometry_file) # standard candidate
+    model = load_geometry_osm(@geometry_file) # standard candidate
     model.getThermostatSetpointDualSetpoints(&:remove)
     model.yearDescription.get.setDayofWeekforStartDay('Sunday')
     model_add_design_days_and_weather_file(model, climate_zone, epw_file) # Standards

data/lib/openstudio-standards/standards/standard.rb

@@ -112,9 +112,9 @@ class Standard
     @standards_data = {}
     standards_files.sort.each do |standards_file|
       temp = ''
-      begin
+      if __dir__[0] == ':' # Running from OpenStudio CLI
         temp = load_resource_relative("../../../data/standards/#{standards_file}", 'r:UTF-8')
-      rescue NoMethodError
+      else
         File.open("#{standards_data_dir}/#{standards_file}", 'r:UTF-8') do |f|
           temp = f.read
         end

data/lib/openstudio-standards/version.rb

@@ -13,5 +13,5 @@ module OpenstudioStandards
     end
     return 'git-not-found-on-this-system'
   end
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/openstudio-standards/weather/Weather.Model.rb

@@ -73,9 +73,7 @@ class Standard
 
     # Define where the weather files lives
     weather_dir = nil
-    if File.dirname(__FILE__)[0] == ':'
-      # running embedded copy of the gem
-
+    if __dir__[0] == ':' # Running from OpenStudio CLI
       # load weather file from embedded files
       epw_string = load_resource_relative("../../../data/weather/#{weather_file_name}")
       ddy_string = load_resource_relative("../../../data/weather/#{weather_file_name.gsub('.epw', '.ddy')}")
@@ -237,8 +235,16 @@ module BTAP
     # this method is used to populate user interfaces if needed from the hash above.
     def self.get_canadian_weather_file_names()
       canadian_file_names = []
-      Dir.glob("#{File.dirname(__FILE__)}/../../../**/*.epw").each do |file|
-        canadian_file_names << File.basename(file).to_s
+      if __dir__[0] == ':' # Running from OpenStudio CLI
+        embedded_files_relative('../../../', /.*\.epw/).each do |file|
+          canadian_file_names << File.basename(file).to_s
+        end
+      else
+        Dir.glob("#{File.dirname(__FILE__)}/../../../**/*.epw").each do |file|
+          canadian_file_names << File.basename(file).to_s
+          puts "File.basename = #{File.basename(file)}"
+          puts "File.dirname = #{File.dirname(file)}"
+        end
       end
       return canadian_file_names
     end
@@ -384,10 +390,6 @@ module BTAP
       # @param weather_file [String]
       # @return [String] self
       def initialize(weather_file)
-        # Define the openstudio-standards weather location
-        top_dir = File.expand_path('../../..', File.dirname(__FILE__))
-        weather_dir = "#{top_dir}/data/weather"
-
         # First check if the epw file exists at a full path.  If not found there,
         # check for the file in the openstudio-standards/data/weather directory.
         weather_file = weather_file.to_s
@@ -398,12 +400,29 @@ module BTAP
           @epw_filepath = weather_file.to_s
           @ddy_filepath = weather_file.sub('epw', 'ddy').to_s
           @stat_filepath = weather_file.sub('epw', 'stat').to_s
-        elsif File.exist?("#{weather_dir}/#{weather_file}")
+        else
+          # Run differently depending on whether running from embedded filesystem in OpenStudio CLI or not
+          if __dir__[0] == ':' # Running from OpenStudio CLI
+            # load weather file from embedded files
+            epw_string = load_resource_relative("../../../data/weather/#{weather_file}")
+            ddy_string = load_resource_relative("../../../data/weather/#{weather_file.gsub('.epw', '.ddy')}")
+            stat_string = load_resource_relative("../../../data/weather/#{weather_file.gsub('.epw', '.stat')}")
+
+            # extract to local weather dir
+            weather_dir = File.expand_path(File.join(Dir.pwd, 'extracted_files/weather/'))
+            puts "Extracting weather files to #{weather_dir}"
+            FileUtils.mkdir_p(weather_dir)
+            File.open("#{weather_dir}/#{weather_file}", 'wb') { |f| f << epw_string; f.flush }
+            File.open("#{weather_dir}/#{weather_file.gsub('.epw', '.ddy')}", 'wb') { |f| f << ddy_string; f.flush }
+            File.open("#{weather_dir}/#{weather_file.gsub('.epw', '.stat')}", 'wb') { |f| f << stat_string; f.flush }
+          else # loaded gem from system path
+            top_dir = File.expand_path('../../..', File.dirname(__FILE__))
+            weather_dir = File.expand_path("#{top_dir}/data/weather")
+          end
+
           @epw_filepath = "#{weather_dir}/#{weather_file}"
           @ddy_filepath = "#{weather_dir}/#{weather_file.sub('epw', 'ddy')}"
           @stat_filepath = "#{weather_dir}/#{weather_file.sub('epw', 'stat')}"
-        else
-          raise("Could not find weather file #{weather_file}.  Make sure file path is correct.")
         end
 
         # Ensure that epw, ddy, and stat file all exist

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-standards
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Parker
@@ -21,7 +21,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-25 00:00:00.000000000 Z
+date: 2018-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
@@ -1630,7 +1630,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Creates DOE Prototype building models and transforms proposed OpenStudio