urbanopt-scenario 0.4.2 → 0.6.0

data/docs/package.json

@@ -10,21 +10,24 @@
   },
   "author": "NREL",
   "dependencies": {
-    "highlight.js": "^10.2.0",
+    "highlight.js": "^10.4.1",
     "json-schema-ref-parser": "^9.0.6",
     "json-schema-view-js": "git+https://git@github.com/bgschiller/json-schema-view-js.git",
-    "vuepress": "^1.5.4",
-    "webpack-dev-middleware": "^3.7.2"
+    "vuepress": "^1.6.0",
+    "webpack-dev-middleware": "^3.6.0"
   },
   "devDependencies": {
     "braces": "^3.0.2",
     "dot-prop": "^5.3.0",
     "gh-pages": "^3.1.0",
+    "is-svg": ">=4.3.1",
     "js-yaml": "^3.14.0",
     "minimist": ">=1.2.3",
     "node-forge": ">=0.10.0",
     "serialize-javascript": "^5.0.1",
     "set-value": "^3.0.2",
-    "yargs-parser": ">=18.1.1"
+    "ssri": ">=8.0.1",
+    "yargs-parser": "^20.2.1",
+    "ini": "^2.0.0"
   }
 }

data/lib/urbanopt-scenario.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.

data/lib/urbanopt/scenario.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.

data/lib/urbanopt/scenario/default_reports.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.

data/lib/urbanopt/scenario/extension.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -39,14 +49,15 @@ module URBANopt
       end
 
       ##
-      # Returns the absolute path of the measures or nil if there is none, can be used when configuring OSWs.
+      # [return:] 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
+      ##
+      # [return:] Absolute path of the files or nil if there is none, used when configuring OSWs
       def files_dir
         return nil
       end
@@ -54,7 +65,8 @@ module URBANopt
       ##
       # 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.
+      ##
+      # [return:] 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

data/lib/urbanopt/scenario/logger.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.

data/lib/urbanopt/scenario/scenario_base.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -36,10 +46,10 @@ module URBANopt
       # 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.
+      # * +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

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -42,16 +52,16 @@ module URBANopt
       # 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.
-
+      # * +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+ - _String_ - 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)
+        @root_dir = root_dir
         @mapper_files_dir = mapper_files_dir
         @csv_file = csv_file
         @num_header_rows = num_header_rows
@@ -72,28 +82,44 @@ module URBANopt
 
       # Require all simulation mappers in mapper_files_dir
       def load_mapper_files
-        dirs = Dir.glob(File.join(@mapper_files_dir, '/*.rb'))
-        # order is not guaranteed...attempt to add Baseline first, then High Efficiency
-        ordered_dirs = []
-        bindex = dirs.find_index { |i| i.include? 'Baseline.rb' }
-        if bindex
-          ordered_dirs << dirs[bindex]
-          dirs.delete_at(bindex)
+
+        # loads default values from extension gem
+        options = OpenStudio::Extension::RunnerConfig.default_config
+        # check if runner.conf file exists
+        if File.exist?(File.join(@root_dir, OpenStudio::Extension::RunnerConfig::FILENAME))
+          runner_config = OpenStudio::Extension::RunnerConfig.new(@root_dir)
+          # use the default values overriden with runner.conf values
+          options = options.merge(runner_config.options)
+        end
+
+        # bundle path is assigned from the runner.conf if it exists or is assigned in the root_dir
+        bundle_path = !options.key?(:bundle_install_path) || options[:bundle_install_path] === '' ? File.join(@root_dir, '.bundle/install/') : options[:bundle_install_path]
+        
+        # checks if bundle path doesn't exist or is empty
+        if !Dir.exists?(bundle_path) or Dir.empty?(bundle_path)
+          # install bundle
+          OpenStudio::Extension::Runner.new(@root_dir)
         end
-        hindex = dirs.find_index { |i| i.include? 'HighEfficiency.rb' }
-        if hindex
-          ordered_dirs << dirs[hindex] if hindex
-          dirs.delete_at(hindex)
+
+        # find all lib dirs in the bundle path and add them to the path
+        lib_dirs = Dir.glob(File.join(bundle_path, '/**/lib'))
+        lib_dirs.each do |ld|
+          # for now only add openstudio and urbanopt gems to the load path
+          if ld.include? 'urbanopt' or ld.include? 'openstudio'
+            puts "adding DIR to load path: #{ld}"
+            $LOAD_PATH.unshift(ld)
+          end
         end
-        # then the rest
-        ordered_dirs += dirs
 
-        ordered_dirs.each do |f|
+        dirs = Dir.glob(File.join(@mapper_files_dir, '/*.rb'))
+
+        dirs.each do |f|
           require(f)
         rescue LoadError => e
           @@logger.error(e.message)
           raise
         end
+
       end
 
       # Gets all the simulation directories

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -1,21 +1,31 @@
 # *********************************************************************************
-# URBANopt (tm), Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt™, Copyright (c) 2019-2021, 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.
-#
+
+# Redistribution of this software, without modification, must refer to the software
+# by the same designation. Redistribution of a modified version of this software
+# (i) may not refer to the modified version by the same designation, or by any
+# confusingly similar designation, and (ii) must refer to the underlying software
+# originally provided by Alliance as “URBANopt”. Except to comply with the foregoing,
+# the term “URBANopt”, or any confusingly similar designation may not be used to
+# refer to any modified version of this software or any modified version of the
+# underlying software originally provided by Alliance without the prior written
+# consent of Alliance.
+
 # 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.
@@ -38,10 +48,10 @@ module URBANopt
       # A Simulation Mapper will map the
       ##
       # [parameters:]
-      #  +scenario+ - _ScenarioBase_ - Scenario containing this ScenarioDatapoint.
-      #  +feature_id+ - _String_ - Unique id of the feature for this ScenarioDatapoint.
-      #  +feature_name+ - _String_ - Human readable name of the feature for this ScenarioDatapoint.
-      #  +mapper_class+ - _String_ - Name of Ruby class used to translate feature to simulation OSW.
+      # * +scenario+ - _ScenarioBase_ - Scenario containing this ScenarioDatapoint.
+      # * +feature_id+ - _String_ - Unique id of the feature for this ScenarioDatapoint.
+      # * +feature_name+ - _String_ - Human readable name of the feature for this ScenarioDatapoint.
+      # * +mapper_class+ - _String_ - Name of Ruby class used to translate feature to simulation OSW.
       def initialize(scenario, feature_id, feature_name, mapper_class)
         @scenario = scenario
         @feature_id = feature_id