urbanopt-scenario 0.1.0

data/lib/urbanopt/scenario/simulation_mapper_base.rb

@@ -0,0 +1,47 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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
+    class SimulationMapperBase
+      # perform initialization functions
+      def initialize; end
+
+      # create osw file given a ScenarioBase object, features, and feature_names
+      # [parameters:]
+      # +scenario+ - _ScenarioBase_ - An object of ScenarioBase class.
+      # +features+ - _Array_ - Array of Features.
+      # +feature_names+ - _Array_ - Array of scenario specific names for these Features.
+      def create_osw(scenario, features, feature_names)
+        raise 'create_osw not implemented for SimulationMapperBase, override in your class'
+      end
+    end
+  end
+end

data/lib/urbanopt/scenario/version.rb

@@ -0,0 +1,35 @@
+# *********************************************************************************
+# URBANopt, Copyright (c) 2019, 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
+    VERSION = '0.1.0'.freeze
+  end
+end

data/urbanopt-scenario-gem.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urbanopt/scenario/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'urbanopt-scenario'
+  spec.version       = URBANopt::Scenario::VERSION
+  spec.authors       = ['Dan Macumber']
+  spec.email         = ['daniel.macumber@nrel.gov']
+
+  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'
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '12.3.1'
+  spec.add_development_dependency 'rspec', '3.7.0'
+
+  spec.add_dependency 'json-schema'
+  spec.add_dependency 'json_pure'
+  spec.add_dependency 'openstudio-model-articulation', '~> 0.1.0'
+  spec.add_dependency 'urbanopt-core', '~> 0.1.0'
+
+  # lock the version of these dependencies due to using older version of Ruby.
+  spec.add_dependency 'public_suffix', '3.1.1'
+end

metadata

@@ -0,0 +1,227 @@
+--- !ruby/object:Gem::Specification
+name: urbanopt-scenario
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Macumber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: openstudio-model-articulation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: urbanopt-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: Library to export data point OSW files from URBANopt Scenario CSV
+email:
+- daniel.macumber@nrel.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Jenkinsfile
+- LICENSE.md
+- RDOC_MAIN.md
+- 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
+- docs/.vuepress/components/ScenarioSchema.vue
+- docs/.vuepress/components/StaticLink.vue
+- docs/.vuepress/config.js
+- docs/.vuepress/highlight.js
+- docs/.vuepress/public/custom_rdoc_styles.css
+- docs/.vuepress/utils.js
+- docs/README.md
+- 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/measures/default_feature_reports/tests/USA_CO_Golden-NREL.724666_TMY3.epw
+- lib/measures/default_feature_reports/tests/default_feature_reports_test.rb
+- lib/measures/default_feature_reports/tests/example_model.osm
+- 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/end_use.rb
+- lib/urbanopt/scenario/default_reports/end_uses.rb
+- lib/urbanopt/scenario/default_reports/feature_report.rb
+- lib/urbanopt/scenario/default_reports/location.rb
+- lib/urbanopt/scenario/default_reports/logger.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/timeseries_csv.rb
+- lib/urbanopt/scenario/default_reports/validator.rb
+- lib/urbanopt/scenario/extension.rb
+- lib/urbanopt/scenario/logger.rb
+- lib/urbanopt/scenario/scenario_base.rb
+- lib/urbanopt/scenario/scenario_csv.rb
+- lib/urbanopt/scenario/scenario_datapoint_base.rb
+- lib/urbanopt/scenario/scenario_post_processor_base.rb
+- lib/urbanopt/scenario/scenario_post_processor_default.rb
+- lib/urbanopt/scenario/scenario_runner_base.rb
+- lib/urbanopt/scenario/scenario_runner_osw.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
+- urbanopt-scenario-gem.gemspec
+homepage: https://github.com/urbanopt
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Library to export data point OSW files from URBANopt Scenario CSV
+test_files: []