openstudio-workflow 1.2.0 → 1.2.1

data/lib/openstudio/workflow/jobs/run_translation.rb

@@ -1,61 +1,61 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-# Run the initialization job to validate the directory and initialize the adapters.
-class RunTranslation < OpenStudio::Workflow::Job
-  require 'openstudio/workflow/util/model'
-  include OpenStudio::Workflow::Util::Model
-
-  def initialize(input_adapter, output_adapter, registry, options = {})
-    super
-  end
-
-  def perform
-    @logger.debug "Calling #{__method__} in the #{self.class} class"
-    
-    # Ensure that the run directory is created
-    FileUtils.mkdir_p(@registry[:run_dir])
-
-    # Copy in the weather file defined in the registry, or alternately in the options
-    if @registry[:wf]
-      @logger.info "Weather file for EnergyPlus simulation is #{@registry[:wf]}"
-      FileUtils.copy(@registry[:wf], "#{@registry[:run_dir]}/in.epw")
-      @registry.register(:wf) { "#{@registry[:run_dir]}/in.epw" }
-    else
-      @logger.warn "EPW file not found or not sent to #{self.class}"
-    end
-    
-    # Translate the OSM to an IDF
-    @logger.info 'Beginning the translation to IDF'
-    @registry[:time_logger].start('Translating to EnergyPlus') if @registry[:time_logger]
-    model_idf = translate_to_energyplus @registry[:model], @logger
-    @registry[:time_logger].stop('Translating to EnergyPlus') if @registry[:time_logger]
-    @registry.register(:model_idf) { model_idf }
-    @logger.info 'Successfully translated to IDF'
-
-    # Save the generated IDF file if the :debug option is true
-    return nil unless @options[:debug]
-    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
-    idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
-    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
-    @logger.debug "Saved IDF as #{idf_name}"
-
-    nil
-  end
-end
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+# Run the initialization job to validate the directory and initialize the adapters.
+class RunTranslation < OpenStudio::Workflow::Job
+  require 'openstudio/workflow/util/model'
+  include OpenStudio::Workflow::Util::Model
+
+  def initialize(input_adapter, output_adapter, registry, options = {})
+    super
+  end
+
+  def perform
+    @logger.debug "Calling #{__method__} in the #{self.class} class"
+    
+    # Ensure that the run directory is created
+    FileUtils.mkdir_p(@registry[:run_dir])
+
+    # Copy in the weather file defined in the registry, or alternately in the options
+    if @registry[:wf]
+      @logger.info "Weather file for EnergyPlus simulation is #{@registry[:wf]}"
+      FileUtils.copy(@registry[:wf], "#{@registry[:run_dir]}/in.epw")
+      @registry.register(:wf) { "#{@registry[:run_dir]}/in.epw" }
+    else
+      @logger.warn "EPW file not found or not sent to #{self.class}"
+    end
+    
+    # Translate the OSM to an IDF
+    @logger.info 'Beginning the translation to IDF'
+    @registry[:time_logger].start('Translating to EnergyPlus') if @registry[:time_logger]
+    model_idf = translate_to_energyplus @registry[:model], @logger
+    @registry[:time_logger].stop('Translating to EnergyPlus') if @registry[:time_logger]
+    @registry.register(:model_idf) { model_idf }
+    @logger.info 'Successfully translated to IDF'
+
+    # Save the generated IDF file if the :debug option is true
+    return nil unless @options[:debug]
+    @registry[:time_logger].start('Saving IDF') if @registry[:time_logger]
+    idf_name = save_idf(@registry[:model_idf], @registry[:root_dir])
+    @registry[:time_logger].stop('Saving IDF') if @registry[:time_logger]
+    @logger.debug "Saved IDF as #{idf_name}"
+
+    nil
+  end
+end

data/lib/openstudio/workflow/multi_delegator.rb

@@ -1,46 +1,46 @@
-######################################################################
-#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
-#  All rights reserved.
-#
-#  This library is free software; you can redistribute it and/or
-#  modify it under the terms of the GNU Lesser General Public
-#  License as published by the Free Software Foundation; either
-#  version 2.1 of the License, or (at your option) any later version.
-#
-#  This library is distributed in the hope that it will be useful,
-#  but WITHOUT ANY WARRANTY; without even the implied warranty of
-#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#  Lesser General Public License for more details.
-#
-#  You should have received a copy of the GNU Lesser General Public
-#  License along with this library; if not, write to the Free Software
-#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
-######################################################################
-
-require 'logger'
-
-class Logger
-  def format_message(severity, datetime, _progname, msg)
-    "[%s %s] %s\n" % [datetime.strftime('%H:%M:%S.%6N'), severity, msg]
-  end
-end
-
-# Class to allow multiple logging paths
-class MultiDelegator
-  def initialize(*targets)
-    @targets = targets
-  end
-
-  def self.delegate(*methods)
-    methods.each do |m|
-      define_method(m) do |*args|
-        @targets.map { |t| t.send(m, *args) }
-      end
-    end
-    self
-  end
-
-  class <<self
-    alias to new
-  end
-end
+######################################################################
+#  Copyright (c) 2008-2014, Alliance for Sustainable Energy.
+#  All rights reserved.
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+#
+#  This library is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+######################################################################
+
+require 'logger'
+
+class Logger
+  def format_message(severity, datetime, _progname, msg)
+    "[%s %s] %s\n" % [datetime.strftime('%H:%M:%S.%6N'), severity, msg]
+  end
+end
+
+# Class to allow multiple logging paths
+class MultiDelegator
+  def initialize(*targets)
+    @targets = targets
+  end
+
+  def self.delegate(*methods)
+    methods.each do |m|
+      define_method(m) do |*args|
+        @targets.map { |t| t.send(m, *args) }
+      end
+    end
+    self
+  end
+
+  class <<self
+    alias to new
+  end
+end

data/lib/openstudio/workflow/registry.rb

@@ -1,137 +1,137 @@
-module OpenStudio
-  module Workflow
-    # Registers objects in a single place. Based on Hashicorps's Vagrant Registry class
-    #
-    # This allows certain components (such as models, weather files, proxy settings, etc.) to be registered as blocks
-    #   and lazily updated. This allows for the state of various objects to be updated through evaluation of or
-    #   overwriting the key. An instance of this class is passed between jobs to allow for highly flexible workflow
-    #   definitions. Note that hashes can be passed into the registry as follows: hash = {...};
-    #   Registry.new.register(:hash) { hash } or Registry.new.register(:hash) { {...} }. This class will likely absorb
-    #   un-abstracted elements of the adapter class, see Workflow#Adapter
-
-    # @todo (rhorsey) registry should be a member of WorkflowRunner - DLM
-    # @todo (rhorsey) how is this different than a regular hash?  why is it important to be able to register keys with blocks that return values instead of values, looks like the block is called on insert anyway? let's not go crazy on performance optimizations until we have to - DLM
-    class Registry
-      def initialize
-        @items = {}
-        @results_cache = {}
-      end
-
-      # Register a key and cache it's value. Note that if a key with the given name already exists it is overwritten
-      #
-      # @param [] key The key for the passed in block. Symbols are highly recommended
-      # @param [Proc] block The block (Proc) which contains the registered information
-      # @return [] Returns block.call from the registries cache
-      #
-      def register(key, &block)
-        raise ArgumentError, 'block required' unless block_given?
-        @items[key] = block
-        @results_cache[key] = @items[key].call
-      end
-
-      # Get the cached value of the given key
-      #
-      # @param [] key  The key defining the block
-      # @return [] Returns the registries cached value for the key or nil if the key was not found
-      #
-      def get(key)
-        return nil unless @items.key?(key)
-        @results_cache[key]
-      end
-      alias [] get
-
-      # Re-evaluate the proc of a key and update the cache
-      #
-      # @param [Sym or String] key This will evaluate the item assigned to the key and update the cache if possible
-      # @return [] If successful the method returns the new value, and if it cannot find or cannot update the key it
-      #   returns nil
-      #
-      def eval(key)
-        return nil unless @items.key?(key)
-        begin
-          @items[key].call
-        rescue
-          return nil
-        end
-        @results_cache[key] = @items[key].call
-      end
-
-      # Checks if the given key is registered with the registry
-      #
-      # @return [Boolean]
-      #
-      def key?(key)
-        @items.key?(key)
-      end
-      alias has_key? key?
-
-      # Returns an array populated with the keys of this object
-      #
-      # @return [Array]
-      #
-      def keys
-        @items.keys
-      end
-
-      # Return the number of elements in this registry
-      #
-      # @return [Fixnum]
-      #
-      def length
-        @items.keys.length
-      end
-      alias size length
-
-      # Checks if this registry has any items
-      #
-      # @return [Boolean]
-      #
-      def empty?
-        @items.keys.empty?
-      end
-
-      # Merge one registry with another and return a completely new registry. Note that the result cache is completely
-      #   busted, so any gets on the new registry will result in a cache miss
-      #
-      # @param [Registry] other The other #Registry to merge onto of self
-      # @return [Registry] A merged #Registry
-      #
-      def merge(other)
-        self.class.new.tap do |result|
-          result.merge!(self)
-          result.merge!(other)
-        end
-      end
-
-      # Like #merge but updates self
-      #
-      # @param [Registry] other The other #Registry to merge onto of self
-      # @return [Void]
-      #
-      def merge!(other)
-        @items.merge!(other.__internal_state[:items])
-        self
-      end
-
-      # Converts the registry to a hash
-      #
-      # @return [Hash] The registry as a hash
-      #
-      def to_hash
-        result = {}
-        @results_cache.each_pair do |key, value|
-          result[key] = value
-        end
-
-        result
-      end
-
-      def __internal_state
-        {
-          items: @items,
-          results_cache: @results_cache
-        }
-      end
-    end
-  end
-end
+module OpenStudio
+  module Workflow
+    # Registers objects in a single place. Based on Hashicorps's Vagrant Registry class
+    #
+    # This allows certain components (such as models, weather files, proxy settings, etc.) to be registered as blocks
+    #   and lazily updated. This allows for the state of various objects to be updated through evaluation of or
+    #   overwriting the key. An instance of this class is passed between jobs to allow for highly flexible workflow
+    #   definitions. Note that hashes can be passed into the registry as follows: hash = {...};
+    #   Registry.new.register(:hash) { hash } or Registry.new.register(:hash) { {...} }. This class will likely absorb
+    #   un-abstracted elements of the adapter class, see Workflow#Adapter
+
+    # @todo (rhorsey) registry should be a member of WorkflowRunner - DLM
+    # @todo (rhorsey) how is this different than a regular hash?  why is it important to be able to register keys with blocks that return values instead of values, looks like the block is called on insert anyway? let's not go crazy on performance optimizations until we have to - DLM
+    class Registry
+      def initialize
+        @items = {}
+        @results_cache = {}
+      end
+
+      # Register a key and cache it's value. Note that if a key with the given name already exists it is overwritten
+      #
+      # @param [] key The key for the passed in block. Symbols are highly recommended
+      # @param [Proc] block The block (Proc) which contains the registered information
+      # @return [] Returns block.call from the registries cache
+      #
+      def register(key, &block)
+        raise ArgumentError, 'block required' unless block_given?
+        @items[key] = block
+        @results_cache[key] = @items[key].call
+      end
+
+      # Get the cached value of the given key
+      #
+      # @param [] key  The key defining the block
+      # @return [] Returns the registries cached value for the key or nil if the key was not found
+      #
+      def get(key)
+        return nil unless @items.key?(key)
+        @results_cache[key]
+      end
+      alias [] get
+
+      # Re-evaluate the proc of a key and update the cache
+      #
+      # @param [Sym or String] key This will evaluate the item assigned to the key and update the cache if possible
+      # @return [] If successful the method returns the new value, and if it cannot find or cannot update the key it
+      #   returns nil
+      #
+      def eval(key)
+        return nil unless @items.key?(key)
+        begin
+          @items[key].call
+        rescue
+          return nil
+        end
+        @results_cache[key] = @items[key].call
+      end
+
+      # Checks if the given key is registered with the registry
+      #
+      # @return [Boolean]
+      #
+      def key?(key)
+        @items.key?(key)
+      end
+      alias has_key? key?
+
+      # Returns an array populated with the keys of this object
+      #
+      # @return [Array]
+      #
+      def keys
+        @items.keys
+      end
+
+      # Return the number of elements in this registry
+      #
+      # @return [Fixnum]
+      #
+      def length
+        @items.keys.length
+      end
+      alias size length
+
+      # Checks if this registry has any items
+      #
+      # @return [Boolean]
+      #
+      def empty?
+        @items.keys.empty?
+      end
+
+      # Merge one registry with another and return a completely new registry. Note that the result cache is completely
+      #   busted, so any gets on the new registry will result in a cache miss
+      #
+      # @param [Registry] other The other #Registry to merge onto of self
+      # @return [Registry] A merged #Registry
+      #
+      def merge(other)
+        self.class.new.tap do |result|
+          result.merge!(self)
+          result.merge!(other)
+        end
+      end
+
+      # Like #merge but updates self
+      #
+      # @param [Registry] other The other #Registry to merge onto of self
+      # @return [Void]
+      #
+      def merge!(other)
+        @items.merge!(other.__internal_state[:items])
+        self
+      end
+
+      # Converts the registry to a hash
+      #
+      # @return [Hash] The registry as a hash
+      #
+      def to_hash
+        result = {}
+        @results_cache.each_pair do |key, value|
+          result[key] = value
+        end
+
+        result
+      end
+
+      def __internal_state
+        {
+          items: @items,
+          results_cache: @results_cache
+        }
+      end
+    end
+  end
+end