urbanopt-scenario 0.3.0 → 0.4.0

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -60,8 +60,7 @@ module URBANopt
         @mapper_class = mapper_class
       end
 
-      attr_reader :mapper_class
-
+      attr_reader :mapper_class, :feature_id
       ##
       # Return the directory that this simulation will run in.
       ##
@@ -195,7 +194,6 @@ module URBANopt
 
         return false
       end
-      # rubocop: enable Metrics/AbcSize #:nodoc:
 
       ##
       # Return simulation status one of {'Not Started', 'Started', 'Complete', 'Failed'}
@@ -213,7 +211,6 @@ module URBANopt
 
         return 'Not Started'
       end
-      # rubocop: enable Style/GuardClause #:nodoc:
 
       ##
       # Clear the directory that this simulation runs in

data/lib/urbanopt/scenario/simulation_mapper_base.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,

data/lib/urbanopt/scenario/version.rb

@@ -1,5 +1,5 @@
 # *********************************************************************************
-# URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other
+# URBANopt (tm), 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,
@@ -30,6 +30,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.3.0'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/package-lock.json

@@ -0,0 +1,3 @@
+{
+  "lockfileVersion": 1
+}

data/urbanopt-scenario-gem.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Library to export data point OSW files from URBANopt Scenario CSV'
   spec.description   = 'Library to export data point OSW files from URBANopt Scenario CSV'
   spec.homepage      = 'https://github.com/urbanopt'
+  spec.licenses      = 'Nonstandard'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,10 +28,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.7'
 
-  spec.add_dependency 'json-schema'
-  spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-common-measures', '~> 0.2.0'
-  spec.add_dependency 'openstudio-model-articulation', '~> 0.2.0'
-  spec.add_dependency 'urbanopt-core', '~> 0.3.0'
-
+  spec.add_runtime_dependency 'json-schema', '~> 2.8'
+  spec.add_runtime_dependency 'json_pure', '~> 2.3'
+  spec.add_runtime_dependency 'openstudio-common-measures', '~> 0.2.0'
+  spec.add_runtime_dependency 'openstudio-extension', '~> 0.2.5'
+  spec.add_runtime_dependency 'openstudio-load-flexibility-measures', '~> 0.1.3'
+  spec.add_runtime_dependency 'openstudio-model-articulation', '~> 0.2.0'
+  spec.add_runtime_dependency 'sqlite3', '1.4.2'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 0.4.0'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,30 +57,30 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: openstudio-common-measures
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: openstudio-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+- !ruby/object:Gem::Dependency
+  name: openstudio-load-flexibility-measures
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: openstudio-model-articulation
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +137,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: urbanopt-reporting
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.2.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -146,11 +202,6 @@ files:
 - README.md
 - Rakefile
 - deploy_docs.sh
-- doc_templates/LICENSE.md
-- doc_templates/README.md.erb
-- doc_templates/copyright_erb.txt
-- doc_templates/copyright_js.txt
-- doc_templates/copyright_ruby.txt
 - docs/.gitignore
 - docs/.vuepress/components/InnerJsonSchema.vue
 - docs/.vuepress/components/JsonSchema.vue
@@ -164,36 +215,9 @@ files:
 - docs/package-lock.json
 - docs/package.json
 - docs/schemas/scenario-schema.md
-- lib/measures/.rubocop.yml
-- lib/measures/default_feature_reports/LICENSE.md
-- lib/measures/default_feature_reports/README.md
-- lib/measures/default_feature_reports/README.md.erb
-- lib/measures/default_feature_reports/measure.rb
-- lib/measures/default_feature_reports/measure.xml
 - lib/urbanopt-scenario.rb
 - lib/urbanopt/scenario.rb
 - lib/urbanopt/scenario/default_reports.rb
-- lib/urbanopt/scenario/default_reports/construction_cost.rb
-- lib/urbanopt/scenario/default_reports/date.rb
-- lib/urbanopt/scenario/default_reports/distributed_generation.rb
-- lib/urbanopt/scenario/default_reports/end_use.rb
-- lib/urbanopt/scenario/default_reports/end_uses.rb
-- lib/urbanopt/scenario/default_reports/feature_report.rb
-- lib/urbanopt/scenario/default_reports/generator.rb
-- lib/urbanopt/scenario/default_reports/location.rb
-- lib/urbanopt/scenario/default_reports/logger.rb
-- lib/urbanopt/scenario/default_reports/power_distribution.rb
-- lib/urbanopt/scenario/default_reports/program.rb
-- lib/urbanopt/scenario/default_reports/reporting_period.rb
-- lib/urbanopt/scenario/default_reports/scenario_report.rb
-- lib/urbanopt/scenario/default_reports/schema/README.md
-- lib/urbanopt/scenario/default_reports/schema/scenario_csv_columns.txt
-- lib/urbanopt/scenario/default_reports/schema/scenario_schema.json
-- lib/urbanopt/scenario/default_reports/solar_pv.rb
-- lib/urbanopt/scenario/default_reports/storage.rb
-- lib/urbanopt/scenario/default_reports/timeseries_csv.rb
-- lib/urbanopt/scenario/default_reports/validator.rb
-- lib/urbanopt/scenario/default_reports/wind.rb
 - lib/urbanopt/scenario/extension.rb
 - lib/urbanopt/scenario/logger.rb
 - lib/urbanopt/scenario/scenario_base.rb
@@ -204,13 +228,16 @@ files:
 - lib/urbanopt/scenario/scenario_post_processor_opendss.rb
 - lib/urbanopt/scenario/scenario_runner_base.rb
 - lib/urbanopt/scenario/scenario_runner_osw.rb
+- lib/urbanopt/scenario/scenario_visualization.rb
 - lib/urbanopt/scenario/simulation_dir_base.rb
 - lib/urbanopt/scenario/simulation_dir_osw.rb
 - lib/urbanopt/scenario/simulation_mapper_base.rb
 - lib/urbanopt/scenario/version.rb
+- package-lock.json
 - urbanopt-scenario-gem.gemspec
 homepage: https://github.com/urbanopt
-licenses: []
+licenses:
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -227,7 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Library to export data point OSW files from URBANopt Scenario CSV

data/doc_templates/LICENSE.md

@@ -1,27 +0,0 @@
-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.

data/doc_templates/README.md.erb

@@ -1,42 +0,0 @@
-<%#= README.md.erb is used to auto-generate README.md. %>
-<%#= To manually maintain README.md throw away README.md.erb and manually edit README.md %>
-###### (Automatically generated documentation)
-
-# <%= name %>
-
-## Description
-<%= description %>
-
-## Modeler Description
-<%= modelerDescription %>
-
-## Measure Type
-<%= measureType %>
-
-## Taxonomy
-<%= taxonomy %>
-
-## Arguments
-
-<% arguments.each do |argument| %>
-### <%= argument[:display_name] %>
-<%= argument[:description] %>
-**Name:** <%= argument[:name] %>,
-**Type:** <%= argument[:type] %>,
-**Units:** <%= argument[:units] %>,
-**Required:** <%= argument[:required] %>,
-**Model Dependent:** <%= argument[:model_dependent] %>
-<% end %>
-
-<% if arguments.size == 0 %>
-<%= "This measure does not have any user arguments" %>
-<% end %>
-
-<% if outputs.size > 0 %>
-## Outputs
-<% output_names = [] %>
-<% outputs.each do |output| %>
-<% output_names << output[:display_name] %>
-<% end %>
-<%= output_names.join(", ") %>
-<% end %>

data/doc_templates/copyright_erb.txt

@@ -1,31 +0,0 @@
-<%
-  # *********************************************************************************
-  # 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.
-  # *********************************************************************************
-%>

data/doc_templates/copyright_js.txt

@@ -1,4 +0,0 @@
-/* @preserve
- * URBANopt, Copyright (c) 2019-2020, Alliance for Sustainable Energy, LLC, and other contributors. All rights reserved.
- * Use of this source code is governed by the BSD 3-Clause license.
-*/

data/doc_templates/copyright_ruby.txt

@@ -1,29 +0,0 @@
-# *********************************************************************************
-# 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.
-# *********************************************************************************