openstudio-workflow 1.0.0.pat1 → 1.0.0

data/lib/openstudio-workflow.rb

@@ -17,138 +17,33 @@
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 ######################################################################
 
-require 'pp'
-require 'rubyXL'
-require 'multi_json'
-require 'colored'
 require 'fileutils'
-require 'securerandom' # uuids
-require 'json' # needed for a single pretty generate call
+require 'json'
 require 'pathname'
 
-begin
-  require 'facter'
-rescue LoadError => e
-  warn 'Could not load Facter. Will not be able to save the IP address to the log'.red
-end
-
-require 'openstudio/workflow/version'
-require 'openstudio/workflow/multi_delegator'
-require 'openstudio/workflow/run'
-require 'openstudio/workflow/jobs/lib/apply_measures'
-require 'openstudio/workflow/time_logger'
-
+require_relative 'openstudio/workflow/version'
+require_relative 'openstudio/workflow/multi_delegator'
+require_relative 'openstudio/workflow/run'
+require_relative 'openstudio/workflow/job'
+require_relative 'openstudio/workflow/time_logger'
+require_relative 'openstudio/workflow/registry'
+require_relative 'openstudio/workflow/util'
 require 'openstudio'
-require 'openstudio/extended_runner'
-
-ENV['OPENSTUDIO_WORKFLOW'] = 'true'
-
-# some core extensions
-class String
-  def to_underscore
-    gsub(/::/, '/')
-      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-      .tr('-', '_')
-      .downcase
-  end
-end
+require_relative 'openstudio/workflow_runner'
 
 module OpenStudio
   module Workflow
     extend self
 
-    # Create a new workflow instance using the defined adapter and UUID
-    def load(adapter_name, run_directory, options = {})
-      defaults = { adapter_options: {} }
-      options = defaults.merge(options)
-      # We don't have deep merge so just check for the rails_env
-      options[:adapter_options][:rails_env] = :development unless options[:adapter_options][:rails_env]
-
-      # Convert various paths to absolute paths
-      if options[:adapter_options] && options[:adapter_options][:mongoid_path] &&
-         (Pathname.new options[:adapter_options][:mongoid_path]).absolute? == false
-        options[:adapter_options][:mongoid_path] = File.expand_path options[:adapter_options][:mongoid_path]
-      end
-      if options[:analysis_root_path] &&
-         (Pathname.new options[:analysis_root_path]).absolute? == false
-        options[:analysis_root_path] = File.expand_path options[:analysis_root_path]
-      end
-      unless (Pathname.new run_directory).absolute?
-        # relative to wherever you are running the script
-        run_directory = File.expand_path run_directory
-      end
-      adapter = load_adapter adapter_name, options[:adapter_options]
-      run_klass = OpenStudio::Workflow::Run.new(adapter, run_directory, options)
-      # return the run class
-      run_klass
-    end
-
-    # predefined method that simply runs EnergyPlus in the specified directory. It does not apply any workflow steps
-    # such as preprocessing / postprocessing. The directory must have the IDF and EPW file in the folder. The
-    # simulations will run in the directory/run path
-    #
-    # @param adapter_name [String] Type of adapter, local or mongo.
-    # @param run_directory [String] Path to where the simulation is to run
-    # @param options [Hash] List of options for the adapter
-    def run_energyplus(adapter_name, run_directory, options = {})
-      unless (Pathname.new run_directory).absolute?
-        # relative to wherever you are running the script
-        run_directory = File.expand_path run_directory
-      end
-
-      transitions = [
-        { from: :queued, to: :preflight },
-        { from: :preflight, to: :energyplus },
-        { from: :energyplus, to: :finished }
-      ]
-
-      states = [
-        { state: :queued, options: { initial: true } },
-        { state: :preflight, options: { after_enter: :run_preflight } },
-        { state: :energyplus, options: { after_enter: :run_energyplus } },
-        { state: :finished },
-        { state: :errored }
-      ]
-      options = {
-        transitions: transitions,
-        states: states
-      }
-
-      adapter = load_adapter adapter_name, options[:adapter_options]
-      run_klass = OpenStudio::Workflow::Run.new(adapter, run_directory, options)
-
-      run_klass
-    end
-
     # Extract an archive to a specific location
+    #
     # @param archive_filename [String] Path and name of the file to extract
     # @param destination [String] Path to extract to
     # @param overwrite [Boolean] If true, will overwrite any extracted file that may already exist
+    #
     def extract_archive(archive_filename, destination, overwrite = true)
-      Zip::File.open(archive_filename) do |zf|
-        zf.each do |f|
-          f_path = File.join(destination, f.name)
-          FileUtils.mkdir_p(File.dirname(f_path))
-
-          if File.exist?(f_path) && overwrite
-            FileUtils.rm_rf(f_path)
-            zf.extract(f, f_path)
-          elsif !File.exist? f_path
-            zf.extract(f, f_path)
-          end
-        end
-      end
-    end
-
-    private
-
-    def load_adapter(name, adapter_options = {})
-      require "openstudio/workflow/adapters/#{name.downcase}"
-      klass_name = name.to_s.split('_').map(&:capitalize) * ''
-      # pp "#{klass_name} is the adapter class name"
-      klass = OpenStudio::Workflow::Adapters.const_get(klass_name).new(adapter_options)
-      klass
+      zf = OpenStudio::UnzipFile.new(archive_filename)
+      zf.extractAllFiles(destination)
     end
   end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-workflow
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pat1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nicholas Long
+- Henry Horsey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,103 +26,62 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.10.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.10.0
-- !ruby/object:Gem::Dependency
-  name: colored
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: rubyXL
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-description: Run OpenStudio based simulations using EnergyPlus
+        version: '0'
+description: Run OpenStudio based measures and simulations using EnergyPlus
 email:
 - nicholas.long@nrel.gov
-executables: []
+- henry.horsey@nrel.gov
+executables:
+- openstudio_cli
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/openstudio/extended_runner.rb
-- lib/openstudio/workflow/adapter.rb
-- lib/openstudio/workflow/adapters/local.rb
-- lib/openstudio/workflow/adapters/mongo.rb
-- lib/openstudio/workflow/jobs/lib/apply_measures.rb
-- lib/openstudio/workflow/jobs/run_energyplus/monthly_report.idf
-- lib/openstudio/workflow/jobs/run_energyplus/run_energyplus.rb
-- lib/openstudio/workflow/jobs/run_openstudio/run_openstudio.rb
-- lib/openstudio/workflow/jobs/run_postprocess/run_postprocess.rb
-- lib/openstudio/workflow/jobs/run_preflight/run_preflight.rb
-- lib/openstudio/workflow/jobs/run_reporting_measures/run_reporting_measures.rb
-- lib/openstudio/workflow/jobs/run_runmanager/run_runmanager.rb
-- lib/openstudio/workflow/jobs/run_xml/run_xml.rb
+- CHANGELOG.md
+- README.md
+- Rakefile
+- bin/openstudio_cli
+- lib/openstudio-workflow.rb
+- lib/openstudio/workflow/adapters/input/local.rb
+- lib/openstudio/workflow/adapters/output/local.rb
+- lib/openstudio/workflow/adapters/output/socket.rb
+- lib/openstudio/workflow/adapters/output/web.rb
+- lib/openstudio/workflow/adapters/output_adapter.rb
+- lib/openstudio/workflow/job.rb
+- lib/openstudio/workflow/jobs/resources/monthly_report.idf
+- lib/openstudio/workflow/jobs/run_energyplus.rb
+- lib/openstudio/workflow/jobs/run_ep_measures.rb
+- lib/openstudio/workflow/jobs/run_initialization.rb
+- lib/openstudio/workflow/jobs/run_os_measures.rb
+- lib/openstudio/workflow/jobs/run_postprocess.rb
+- lib/openstudio/workflow/jobs/run_preprocess.rb
+- lib/openstudio/workflow/jobs/run_reporting_measures.rb
+- lib/openstudio/workflow/jobs/run_translation.rb
 - lib/openstudio/workflow/multi_delegator.rb
+- lib/openstudio/workflow/registry.rb
 - lib/openstudio/workflow/run.rb
 - lib/openstudio/workflow/time_logger.rb
+- lib/openstudio/workflow/util.rb
+- lib/openstudio/workflow/util/energyplus.rb
+- lib/openstudio/workflow/util/io.rb
+- lib/openstudio/workflow/util/measure.rb
+- lib/openstudio/workflow/util/model.rb
+- lib/openstudio/workflow/util/post_process.rb
+- lib/openstudio/workflow/util/weather_file.rb
 - lib/openstudio/workflow/version.rb
-- lib/openstudio-workflow.rb
-- README.md
-- CHANGELOG.md
-- Rakefile
+- lib/openstudio/workflow_json.rb
+- lib/openstudio/workflow_runner.rb
 homepage: https://github.com/NREL/OpenStudio-workflow-gem
 licenses:
 - LGPL
@@ -134,16 +94,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: Workflow Manager
+summary: OpenStudio Workflow Manager
 test_files: []

data/lib/openstudio/extended_runner.rb

@@ -1,105 +0,0 @@
-# Extend OS Runner to persist measure information throughout the workflow
-class ExtendedRunner < OpenStudio::Ruleset::OSRunner
-  # Allow former arguments to be set and read
-  # TODO: Consider having the former arguments passed in in initialization, and define as attr_reader
-  attr_accessor :former_workflow_arguments
-  attr_accessor :past_results
-  attr_reader :workflow_arguments
-
-  # Add in @workflow_arguments
-  def initialize(multi_logger, analysis_hash, datapoint_hash)
-    @multi_logger = multi_logger
-    @analysis = analysis_hash
-    @datapoint = datapoint_hash
-    @workflow_arguments = nil
-    super()
-  end
-
-  def analysis
-    return @analysis
-  end
-
-  def datapoint
-    return @datapoint
-  end
-
-  # Take the OS Argument type and map it correctly to the argument value.
-  #     OPENSTUDIO_ENUM( OSArgumentType,
-  #     ((Boolean)(Bool)(0))
-  #     ((Double)(Double)(1))
-  #     ((Quantity)(Quantity)(2))
-  #     ((Integer)(Int)(3))
-  #     ((String)(String)(4))
-  #     ((Choice)(Choice)(5))
-  #     ((Path)(Path)(6))
-  #     );
-  # @param os_argument_name [String] The string of the argument to check
-  # @param user_arguments [OSArgumentMap] Map of the arguments to check
-  def bad_os_typecasting(os_argument_name, user_arguments)
-    out = nil
-    user_arguments.each do |arg_name, arg|
-      # get the type cast value
-      next unless os_argument_name == arg_name
-
-      case arg.type.valueName
-        when 'Boolean'
-          out = arg.valueAsBool if arg.hasValue
-        when 'Double'
-          out = arg.valueAsDouble if arg.hasValue
-        when 'Quantity'
-          warn 'This OpenStudio Argument Type is deprecated'
-        when 'Integer'
-          out = arg.valueAsInteger if arg.hasValue
-        when 'String'
-          out = arg.valueAsString if arg.hasValue
-        when 'Choice'
-          out = arg.valueAsString if arg.hasValue
-        when 'Path'
-          out = arg.valueAsPath.to_s if arg.hasValue
-      end
-    end
-
-    out
-  end
-
-  # Overloaded argument parsing
-  def validateUserArguments(script_arguments, user_arguments)
-    @workflow_arguments = {}
-    user_arguments.each do |hash|
-      value = bad_os_typecasting(hash, user_arguments)
-      @workflow_arguments[hash.to_sym] = value if value
-    end
-
-    super
-  end
-
-  # Overload registerInfo
-  def registerInfo(message)
-    super
-    @multi_logger.info message
-  end
-
-  # Overload registerInfo
-  def registerWarning(message)
-    super
-    @multi_logger.warn message
-  end
-
-  # Overload registerError
-  def registerError(message)
-    super
-    @multi_logger.error message
-  end
-
-  # Overload registerInitialCondition
-  def registerInitialCondition(message)
-    super
-    @multi_logger.info message
-  end
-
-  # Overload registerFinalCondition
-  def registerFinalCondition(message)
-    super
-    @multi_logger.info message
-  end
-end

data/lib/openstudio/workflow/adapters/local.rb

@@ -1,101 +0,0 @@
-######################################################################
-#  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_relative '../adapter'
-
-# Local file based workflow
-module OpenStudio
-  module Workflow
-    module Adapters
-      class Local < Adapter
-        def initialize(options = {})
-          super
-        end
-
-        # Tell the system that the process has started
-        def communicate_started(directory, _options = {})
-          # Watch out for namespace conflicts (::Time is okay but Time is OpenStudio::Time)
-          File.open("#{directory}/started.job", 'w') { |f| f << "Started Workflow #{::Time.now}" }
-        end
-
-        # Get the data point from the path
-        def get_datapoint(directory, options = {})
-          defaults = { datapoint_filename: 'datapoint.json', format: 'json' }
-          options = defaults.merge(options)
-
-          # how do we log within this file?
-          if File.exist? "#{directory}/#{options[:datapoint_filename]}"
-            ::JSON.parse(File.read("#{directory}/#{options[:datapoint_filename]}"), symbolize_names: true)
-          else
-            fail "Data point file does not exist for #{directory}/#{options[:datapoint_filename]}"
-          end
-        end
-
-        # Get the Problem/Analysis definition from the local file
-        # TODO: rename this to get_analysis_definintion (or something like that)
-        def get_problem(directory, options = {})
-          defaults = { problem_filename: 'problem.json', format: 'json' }
-          options = defaults.merge(options)
-
-          if File.exist? "#{directory}/#{options[:problem_filename]}"
-            ::JSON.parse(File.read("#{directory}/#{options[:problem_filename]}"), symbolize_names: true)
-          else
-            fail "Problem file does not exist for #{directory}/#{options[:problem_filename]}"
-          end
-        end
-
-        def communicate_intermediate_result(_directory)
-          # noop
-        end
-
-        def communicate_complete(directory)
-          File.open("#{directory}/finished.job", 'w') { |f| f << "Finished Workflow #{::Time.now}" }
-        end
-
-        # Final state of the simulation. The os_directory is the run directory and may be needed to
-        # zip up the results of the simuation.
-        def communicate_failure(directory)
-          File.open("#{directory}/failed.job", 'w') { |f| f << "Failed Workflow #{::Time.now}" }
-          # @communicate_module.communicate_failure(@communicate_object, os_directory)
-        end
-
-        def communicate_results(directory, results)
-          zip_results(directory)
-
-          if results.is_a? Hash
-            File.open("#{directory}/data_point_out.json", 'w') { |f| f << JSON.pretty_generate(results) }
-          else
-            pp "Unknown datapoint result type. Please handle #{results.class}"
-            # data_point_json_path = OpenStudio::Path.new(run_dir) / OpenStudio::Path.new('data_point_out.json')
-            # os_data_point.saveJSON(data_point_json_path, true)
-          end
-          # end
-        end
-
-        # For the local adapter send back a handle to a file to append the data. For this adapter
-        # the log messages are likely to be the same as the run.log messages.
-        # ?: do we really want two local logs from the Local adapter? One is in the run dir and the other is in the root
-        def get_logger(directory, _options = {})
-          @log ||= File.open("#{directory}/local_adapter.log", 'w')
-          @log
-        end
-      end
-    end
-  end
-end