urbanopt-scenario 0.1.1

data/lib/urbanopt/scenario/default_reports/validator.rb

@@ -0,0 +1,97 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'json'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      class Validator
+        @@schema = nil
+
+        # Initialize the root directory
+        def initialize
+          super
+
+          @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..', '..'))
+
+          @instance_lock = Mutex.new
+          @@schema ||= schema
+        end
+
+        # Return the absolute path of the default reports files
+        def files_dir
+          File.absolute_path(File.join(@root_dir, 'lib/urbanopt/scenario/default_reports/'))
+        end
+
+        # return path to schema file
+        def schema_file
+          File.join(files_dir, 'schema/scenario_schema.json')
+        end
+
+        # return schema
+        def schema
+          @instance_lock.synchronize do
+            if @@schema.nil?
+              File.open(schema_file, 'r') do |f|
+                @@schema = JSON.parse(f.read, symbolize_names: true)
+              end
+            end
+          end
+
+          @@schema
+        end
+
+        ##
+        # validate data against schema
+        ##
+        # [parameters:]
+        # +schema+ - _Hash_ - A hash of the JSON scenario_schema.
+        # +data+ - _Hash_ - A hash of the data to be validated against scenario_schema.
+        ##
+        def validate(schema, data)
+          JSON::Validator.fully_validate(schema, data)
+        end
+
+        # check if the schema is valid
+        def schema_valid?
+          metaschema = JSON::Validator.validator_for_name('draft6').metaschema
+          JSON::Validator.validate(metaschema, @@schema)
+        end
+
+        # return detailed schema validation errors
+        def schema_validation_errors
+          metaschema = JSON::Validator.validator_for_name('draft6').metaschema
+          JSON::Validator.fully_validate(metaschema, @@schema)
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/default_reports/wind.rb

@@ -0,0 +1,92 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'json'
+require 'json-schema'
+
+module URBANopt
+  module Scenario
+    module DefaultReports
+      ##
+      # Onsite wind system attributes
+      ##
+      class Wind
+        ##
+        # _Float_ - power capacity in kilowatts
+        #
+        attr_accessor :size_kw
+
+        ##
+        # Initialize Wind attributes from a hash. Wind attributes currently are limited to power capacity.
+        ##
+        # [parameters:]
+        #
+        # * +hash+ - _Hash_ - A hash containting a +:size_kw+ key/value pair which represents the nameplate capacity in kilowatts (kW)
+        #
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+
+          @size_kw = hash[:size_kw]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+
+          # initialize @@logger
+          @@logger ||= URBANopt::Scenario::DefaultReports.logger
+        end
+
+        ##
+        # Convert to a Hash equivalent for JSON serialization
+        ##
+        def to_hash
+          result = {}
+
+          result[:size_kw] = @size_kw if @size_kw
+
+          return result
+        end
+
+        ##
+        # Merge Wind systems
+        ##
+        def self.add_wind(existing_wind, new_wind)
+          if existing_wind.size_kw.nil? && new_wind.size_kw.nil?
+            existing_wind.size_kw = nil
+          else
+            existing_wind.size_kw = (existing_wind.size_kw || 0) + (new_wind.size_kw || 0)
+          end
+
+          return existing_wind
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/extension.rb

@@ -0,0 +1,63 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'openstudio/extension'
+
+module URBANopt
+  module Scenario
+    class Extension < OpenStudio::Extension::Extension
+      def initialize
+        super
+        @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
+      end
+
+      ##
+      # Returns the absolute path of the measures or nil if there is none, can be used when configuring OSWs.
+      def measures_dir
+        return File.absolute_path(File.join(@root_dir, 'lib', 'measures'))
+      end
+
+      ##
+      # Relevant files such as weather data, design days, etc.
+      # Return the absolute path of the files or nil if there is none, used when configuring OSWs
+      def files_dir
+        return nil
+      end
+
+      ##
+      # Doc templates are common files like copyright files which are used to update measures and other code.
+      # Doc templates will only be applied to measures in the current repository.
+      # Return the absolute path of the doc templates dir or nil if there is none.
+      def doc_templates_dir
+        return File.absolute_path(File.join(@root_dir, 'doc_templates'))
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/logger.rb

@@ -0,0 +1,42 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'logger'
+
+module URBANopt
+  module Scenario
+    @@logger = Logger.new(STDOUT)
+
+    # Definining class variable "@@logger" to log errors, info and warning messages.
+    def self.logger
+      @@logger
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_base.rb

@@ -0,0 +1,79 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+module URBANopt
+  module Scenario
+    # ScenarioBase is a simulation method agnostic description of a Scenario.
+    class ScenarioBase
+      ##
+      # Initialize ScenarioBase attributes: +name+ , +root directory+ , +run directory+ and +feature_file+
+      ##
+      # [parameters:]
+      # +name+ - _String_ - Human readable scenario name.
+      # +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
+      # +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
+      # +feature_file+ - _FeatureFile_ - An instance of +URBANopt::Core::FeatureFile+ containing features for simulation.
+      def initialize(name, root_dir, run_dir, feature_file)
+        @name = name
+        @root_dir = root_dir
+        @run_dir = run_dir
+        @feature_file = feature_file
+      end
+
+      ##
+      # Name of the Scenario.
+      attr_reader :name #:nodoc:
+
+      ##
+      # Root directory containing Gemfile.
+      attr_reader :root_dir #:nodoc:
+
+      ##
+      # Directory to run this Scenario.
+      attr_reader :run_dir #:nodoc:
+
+      ##
+      # An instance of +URBANopt::Core::FeatureFile+ associated with this Scenario.
+      attr_reader :feature_file #:nodoc:
+
+      # An array of SimulationDirBase objects.
+      def simulation_dirs
+        raise 'simulation_dirs not implemented for ScenarioBase, override in your class'
+      end
+
+      # Removes all simulation input and output files by removing this Scenario's +run_dir+ .
+      def clear
+        Dir.glob(File.join(@run_dir, '/*')).each do |f|
+          FileUtils.rm_rf(f)
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -0,0 +1,122 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this list
+# of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice, this
+# list of conditions and the following disclaimer in the documentation and/or other
+# materials provided with the distribution.
+#
+# Neither the name of the copyright holder nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+# *********************************************************************************
+
+require 'urbanopt/scenario/scenario_base'
+require 'urbanopt/scenario/simulation_dir_osw'
+
+require 'csv'
+require 'fileutils'
+
+module URBANopt
+  module Scenario
+    class ScenarioCSV < ScenarioBase
+      ##
+      # ScenarioCSV is a ScenarioBase which assigns a Simulation Mapper to each Feature in a FeatureFile using a simple CSV format.
+      # The CSV file has three columns 1) feature_id, 2) feature_name, and 3) mapper_class_name.  There is one row for each Feature.
+      ##
+      # [parameters:]
+      # +name+ - _String_ - Human readable scenario name.
+      # +root_dir+ - _String_ - Root directory for the scenario, contains Gemfile describing dependencies.
+      # +run_dir+ - _String_ - Directory for simulation of this scenario, deleting run directory clears the scenario.
+      # +feature_file+ - _URBANopt::Core::FeatureFile_ - FeatureFile containing features to simulate.
+      # +mapper_files_dir+ - _String_ - Directory containing all mapper class files containing MapperBase definitions.
+      # +csv_file+ - _String_ - Path to CSV file assigning a MapperBase class to each feature in feature_file.
+      # +num_header_rows+ - _Strng_ - Number of header rows to skip in CSV file.
+
+      def initialize(name, root_dir, run_dir, feature_file, mapper_files_dir, csv_file, num_header_rows)
+        super(name, root_dir, run_dir, feature_file)
+
+        @mapper_files_dir = mapper_files_dir
+        @csv_file = csv_file
+        @num_header_rows = num_header_rows
+
+        @@logger ||= URBANopt::Scenario.logger
+
+        load_mapper_files
+      end
+
+      # Path to CSV file
+      attr_reader :csv_file #:nodoc:
+
+      # Number of header rows to skip in CSV file
+      attr_reader :num_header_rows #:nodoc:
+
+      # Directory containing all mapper class files
+      attr_reader :mapper_files_dir #:nodoc:
+
+      # Require all simulation mappers in mapper_files_dir
+      def load_mapper_files
+        Dir.glob(File.join(@mapper_files_dir, '/*.rb')).each do |f|
+          begin
+            require(f)
+          rescue LoadError => e
+            @@logger.error(e.message)
+            raise
+          end
+        end
+      end
+
+      # Gets all the simulation directories
+      def simulation_dirs
+        # DLM: TODO use HeaderConverters from CSV module
+
+        rows_skipped = 0
+        result = []
+        CSV.foreach(@csv_file) do |row|
+          if rows_skipped < @num_header_rows
+            rows_skipped += 1
+            next
+          end
+
+          break if row[0].nil?
+
+          # gets +feature_id+ , +feature_name+ and +mapper_class+ from csv_file
+          feature_id = row[0].chomp
+          feature_name = row[1].chomp
+          mapper_class = row[2].chomp
+
+          # gets +features+ from the feature_file.
+          features = []
+          feature = feature_file.get_feature_by_id(feature_id)
+          features << feature
+
+          feature_names = []
+          feature_names << feature_name
+
+          simulation_dir = SimulationDirOSW.new(self, features, feature_names, mapper_class)
+
+          result << simulation_dir
+        end
+
+        return result
+      end
+    end
+  end
+end