urbanopt-reporting 0.1.0

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

@@ -0,0 +1,112 @@
+# *********************************************************************************
+# 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 Reporting
+    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/reporting/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
+
+        # get csv headers from csv schema
+        def csv_headers
+          # read scenario csv schema headers
+          scenario_csv_schema = open(File.expand_path('schema/scenario_csv_columns.txt', File.dirname(__FILE__))) # .read()
+
+          scenario_csv_schema_headers = []
+          File.readlines(scenario_csv_schema).each do |line|
+            l = line.delete("\n")
+            a = l.delete("\t")
+            scenario_csv_schema_headers << a
+          end
+
+          return scenario_csv_schema_headers
+        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/reporting/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 Reporting
+    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/reporting/derived_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 'urbanopt/reporting/version'
+require 'openstudio/extension'
+
+module URBANopt
+  module Reporting
+    class Extension < OpenStudio::Extension::Extension
+      def initialize # :nodoc:
+        @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..'))
+      end
+
+      ##
+      # Returns the absolute path of the measures or returns nil, in case no measures are
+      # added. It can be used while configuring OSWs.
+      def measures_dir
+        return File.absolute_path(File.join(@root_dir, 'lib/measures'))
+      end
+
+      ##
+      # The directory containign relevant files such as weather data, design days, etc.
+      # The method returns nil if no files are present. It is used while configuring OSWs.
+      def files_dir
+        return nil
+      end
+
+      # The directory containing common files like copyright and license notices which are used to update measures and other code.
+      # This method will only be applied to measures in the current repository and
+      # returns 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/reporting/version.rb

@@ -0,0 +1,35 @@
+# *********************************************************************************
+# 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 Reporting
+    VERSION = '0.1.0'.freeze
+  end
+end

data/urbanopt-reporting-gem.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urbanopt/reporting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'urbanopt-reporting'
+  spec.version       = URBANopt::Reporting::VERSION
+  spec.authors       = ['Rawad El Kontar', 'Dan Macumber']
+  spec.email         = ['rawad.elkontar@nrel.gov']
+
+  spec.summary       = 'Library to report URBANopt results'
+  spec.description   = 'Library include scenario default reporting measure and scenario defaults reports schema and classes'
+  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|lib.measures.*tests|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.5.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  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-extension', '~> 0.2.3'
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: urbanopt-reporting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rawad El Kontar
+- Dan Macumber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !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-extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: Library include scenario default reporting measure and scenario defaults
+  reports schema and classes
+email:
+- rawad.elkontar@nrel.gov
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Jenkinsfile
+- LICENSE.md
+- README.md
+- Rakefile
+- doc_templates/LICENSE.md
+- doc_templates/README.md.erb
+- doc_templates/copyright_erb.txt
+- doc_templates/copyright_js.txt
+- doc_templates/copyright_ruby.txt
+- 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/reporting.rb
+- lib/urbanopt/reporting/default_reports.rb
+- lib/urbanopt/reporting/default_reports/construction_cost.rb
+- lib/urbanopt/reporting/default_reports/date.rb
+- lib/urbanopt/reporting/default_reports/distributed_generation.rb
+- lib/urbanopt/reporting/default_reports/end_use.rb
+- lib/urbanopt/reporting/default_reports/end_uses.rb
+- lib/urbanopt/reporting/default_reports/extension.rb
+- lib/urbanopt/reporting/default_reports/feature_report.rb
+- lib/urbanopt/reporting/default_reports/generator.rb
+- lib/urbanopt/reporting/default_reports/location.rb
+- lib/urbanopt/reporting/default_reports/logger.rb
+- lib/urbanopt/reporting/default_reports/power_distribution.rb
+- lib/urbanopt/reporting/default_reports/program.rb
+- lib/urbanopt/reporting/default_reports/reporting_period.rb
+- lib/urbanopt/reporting/default_reports/scenario_report.rb
+- lib/urbanopt/reporting/default_reports/schema/README.md
+- lib/urbanopt/reporting/default_reports/schema/scenario_csv_columns.txt
+- lib/urbanopt/reporting/default_reports/schema/scenario_schema.json
+- lib/urbanopt/reporting/default_reports/solar_pv.rb
+- lib/urbanopt/reporting/default_reports/storage.rb
+- lib/urbanopt/reporting/default_reports/timeseries_csv.rb
+- lib/urbanopt/reporting/default_reports/validator.rb
+- lib/urbanopt/reporting/default_reports/wind.rb
+- lib/urbanopt/reporting/derived_extension.rb
+- lib/urbanopt/reporting/version.rb
+- urbanopt-reporting-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: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Library to report URBANopt results
+test_files: []