urbanopt-reporting 0.1.0

data/lib/measures/default_feature_reports/measure.xml

@@ -0,0 +1,160 @@
+<?xml version="1.0"?>
+<measure>
+  <schema_version>3.0</schema_version>
+  <name>default_feature_reports</name>
+  <uid>9ee3135a-8070-4408-bfa1-b75fecf9dd4f</uid>
+  <version_id>95706c7a-88ab-433b-b897-00435181a6dd</version_id>
+  <version_modified>20200603T001228Z</version_modified>
+  <xml_checksum>FB304155</xml_checksum>
+  <class_name>DefaultFeatureReports</class_name>
+  <display_name>DefaultFeatureReports</display_name>
+  <description>Writes default_feature_reports.json and default_feature_reports.csv files used by URBANopt Scenario Default Post Processor</description>
+  <modeler_description>This measure only allows for one feature_report per simulation. If multiple features are simulated in a single simulation, a new measure must be written to disaggregate simulation results to multiple features.</modeler_description>
+  <arguments>
+    <argument>
+      <name>feature_id</name>
+      <display_name>Feature unique identifier</display_name>
+      <description></description>
+      <type>String</type>
+      <units></units>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>1</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
+    </argument>
+    <argument>
+      <name>feature_name</name>
+      <display_name>Feature scenario specific name</display_name>
+      <description></description>
+      <type>String</type>
+      <units></units>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>name</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
+    </argument>
+    <argument>
+      <name>feature_type</name>
+      <display_name>URBANopt Feature Type</display_name>
+      <description></description>
+      <type>String</type>
+      <units></units>
+      <required>false</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Building</default_value>
+      <min_value></min_value>
+      <max_value></max_value>
+    </argument>
+    <argument>
+      <name>reporting_frequency</name>
+      <display_name>Reporting Frequency</display_name>
+      <description>The frequency at which to report timeseries output data.</description>
+      <type>Choice</type>
+      <units></units>
+      <required>true</required>
+      <model_dependent>false</model_dependent>
+      <default_value>Timestep</default_value>
+      <choices>
+        <choice>
+          <value>Detailed</value>
+          <display_name>Detailed</display_name>
+        </choice>
+        <choice>
+          <value>Timestep</value>
+          <display_name>Timestep</display_name>
+        </choice>
+        <choice>
+          <value>Hourly</value>
+          <display_name>Hourly</display_name>
+        </choice>
+        <choice>
+          <value>Daily</value>
+          <display_name>Daily</display_name>
+        </choice>
+        <choice>
+          <value>BillingPeriod</value>
+          <display_name>BillingPeriod</display_name>
+        </choice>
+        <choice>
+          <value>Monthly</value>
+          <display_name>Monthly</display_name>
+        </choice>
+        <choice>
+          <value>Runperiod</value>
+          <display_name>Runperiod</display_name>
+        </choice>
+      </choices>
+      <min_value></min_value>
+      <max_value></max_value>
+    </argument>
+  </arguments>
+  <outputs />
+  <provenances />
+  <tags>
+    <tag>Reporting.QAQC</tag>
+  </tags>
+  <attributes>
+    <attribute>
+      <name>Measure Type</name>
+      <value>ReportingMeasure</value>
+      <datatype>string</datatype>
+    </attribute>
+    <attribute>
+      <name>Intended Use Case</name>
+      <value>Automatic Report Generation</value>
+      <datatype>string</datatype>
+    </attribute>
+  </attributes>
+  <files>
+    <file>
+      <filename>USA_CO_Golden-NREL.724666_TMY3.epw</filename>
+      <filetype>epw</filetype>
+      <usage_type>test</usage_type>
+      <checksum>BDF687C1</checksum>
+    </file>
+    <file>
+      <filename>README.md.erb</filename>
+      <filetype>erb</filetype>
+      <usage_type>readmeerb</usage_type>
+      <checksum>703C9964</checksum>
+    </file>
+    <file>
+      <filename>example_model.osm</filename>
+      <filetype>osm</filetype>
+      <usage_type>test</usage_type>
+      <checksum>CC4BFFAF</checksum>
+    </file>
+    <file>
+      <filename>LICENSE.md</filename>
+      <filetype>md</filetype>
+      <usage_type>license</usage_type>
+      <checksum>EA283B74</checksum>
+    </file>
+    <file>
+      <filename>default_feature_reports_test.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>test</usage_type>
+      <checksum>56E0804B</checksum>
+    </file>
+    <file>
+      <version>
+        <software_program>OpenStudio</software_program>
+        <identifier>1.11.0</identifier>
+        <min_compatible>1.11.0</min_compatible>
+      </version>
+      <filename>measure.rb</filename>
+      <filetype>rb</filetype>
+      <usage_type>script</usage_type>
+      <checksum>A00C8077</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0B68E96D</checksum>
+    </file>
+  </files>
+</measure>
+<error>wrong number of arguments (given 1, expected 0)</error>

data/lib/urbanopt/reporting.rb

@@ -0,0 +1,37 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+##
+# Retrieve all default_reports classes.
+##
+
+require 'urbanopt/reporting/default_reports'
+require 'urbanopt/reporting/derived_extension'
+require 'urbanopt/reporting/version'

data/lib/urbanopt/reporting/default_reports.rb

@@ -0,0 +1,44 @@
+# *********************************************************************************
+# 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.
+# *********************************************************************************
+
+##
+# Retrieve all default_reports classes.
+##
+
+require 'urbanopt/reporting/default_reports/scenario_report'
+require 'urbanopt/reporting/default_reports/feature_report'
+require 'urbanopt/reporting/default_reports/construction_cost'
+require 'urbanopt/reporting/default_reports/program'
+require 'urbanopt/reporting/default_reports/reporting_period'
+require 'urbanopt/reporting/default_reports/timeseries_csv'
+require 'urbanopt/reporting/default_reports/distributed_generation'
+require 'urbanopt/reporting/default_reports/power_distribution'
+require 'urbanopt/reporting/default_reports/logger'
+require 'urbanopt/reporting/default_reports/validator'

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

@@ -0,0 +1,169 @@
+# *********************************************************************************
+# 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_relative 'validator'
+require 'json-schema'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # ConstructionCost include construction cost information.
+      ##
+      class ConstructionCost
+        attr_accessor :category, :item_name, :unit_cost, :cost_units, :item_quantity, :total_cost # :nodoc:
+        ##
+        # ConstructionCost class intialize all construction_cost attributes:
+        # +:category+ , +:item_name+ , +:unit_cost+ , +:cost_units+ , +:item_quantity+ , +:total_cost+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized construction_cost.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @category = hash[:category]
+          @item_name = hash[:item_name]
+          @unit_cost = hash[:unit_cost]
+          @cost_units = hash[:cost_units]
+          @item_quantity = hash[:item_quantity]
+          @total_cost = hash[:total_cost]
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Assigns default values if attribute values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:category] = nil
+          hash[:item_name] = nil
+          hash[:unit_cost] = nil
+          hash[:cost_units] = nil
+          hash[:item_quantity] = nil
+          hash[:total_cost] = nil
+
+          return hash
+        end
+
+        ##
+        # Converts to a Hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate construct_cost hash properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:category] = @category if @category
+          result[:item_name] = @item_name if @item_name
+          result[:unit_cost] = @unit_cost if @unit_cost
+          result[:cost_units] = @cost_units if @cost_units
+          result[:item_quantity] = @item_quantity if @item_quantity
+          result[:total_cost] = @total_cost if @total_cost
+
+          # validate construct_cost properties against schema
+          if @@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result).any?
+            raise "construction_cost properties does not match schema: #{@@validator.validate(@@schema[:definitions][:ConstructionCost][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Merges an +existing_cost+ with a +new_cost+:
+        # - modify the existing_cost by summing the +:total_cost+ and +:item_quantity+ of new_cost and existing_cost.
+        # - raise an error if +:category+ , +:cost_units+ and +:unit_cost+ are not identical
+        ##
+        # [Parameters:]
+        # +existing_cost+ - _ConstructionCost_ - An object of ConstructionCost class.
+        ##
+        # +new_cost+ - _ConstructionCost_ - An object of ConstructionCost class.
+        ##
+        def self.merge_construction_cost(existing_cost, new_cost)
+          # modify the existing_cost by adding the :total_cost and :item_quantity
+          existing_cost.total_cost += new_cost.total_cost
+          existing_cost.item_quantity += new_cost.item_quantity
+
+          if existing_cost.category != new_cost.category
+            raise "Cannot merge existing cost of category \"#{existing_cost.category}\" with new cost of category \"#{new_cost.category}\"."
+          end
+
+          if existing_cost.cost_units != new_cost.cost_units
+            raise "Cannot merge existing cost with cost units \"#{existing_cost.cost_units}\" with new cost with cost units \"#{new_cost.cost_units}\". "
+          end
+
+          if existing_cost.unit_cost != new_cost.unit_cost
+            raise "Cannot merge existing cost with unit cost \"#{existing_cost.unit_cost}\" with new cost with unit cost \"#{new_cost.unit_cost}\"; identical items should have identical unit cost."
+          end
+
+          return existing_cost
+        end
+
+        ##
+        # Merges muliple construction costs together.
+        # - loops over the new_costs and find the index of the cost with identical +:item_name+.
+        # - if +item_name+ is identical then modify the existing_cost array by summing the :total_cost and :item_quantity. Else add the new_cost to existing_costs array.
+        ##
+        # [Parameters:]
+        # +existing_costs+ - _Array_ - An array of ConstructionCost objects.
+        ##
+        # +new_costs+ - _Array_ - An array of ConstructionCost objects.
+        def self.merge_construction_costs(existing_costs, new_costs)
+          item_name_list = []
+          item_name_list = existing_costs.collect(&:item_name)
+
+          new_costs.each do |x_new|
+            if item_name_list.include?(x_new.item_name)
+
+              # when looping over the new_cost item_names find the index of the item_name_list with the same item name
+              id = item_name_list.find_index(x_new.item_name) # the order of the item_name_list is the same as the order of the existing_cost hash-array
+
+              # modify the existing_cost array by adding the :total_cost and :item_quantity when looping over costs
+              existing_costs[id] = merge_construction_cost(existing_costs[id], x_new)
+
+            else
+
+              # insert the new hash in to the array
+              existing_costs << x_new
+
+            end
+          end
+
+          return existing_costs
+        end
+      end
+    end
+  end
+end

data/lib/urbanopt/reporting/default_reports/date.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_relative 'validator'
+require 'json-schema'
+require 'json'
+
+module URBANopt
+  module Reporting
+    module DefaultReports
+      ##
+      # Date class include information of simulation run date.
+      ##
+      class Date
+        attr_accessor :month, :day_of_month, :year #:nodoc:
+        ##
+        # Date class intialize all date attributes:
+        # +:month+ , +:day_of_month+ , +:year+
+        ##
+        # [parameters:]
+        # +hash+ - _Hash_ - A hash which may contain a deserialized date.
+        ##
+        def initialize(hash = {})
+          hash.delete_if { |k, v| v.nil? }
+          hash = defaults.merge(hash)
+
+          @month = hash[:month].to_i
+          @day_of_month = hash[:day_of_month].to_i
+          @year = hash[:year].to_i
+
+          # initialize class variables @@validator and @@schema
+          @@validator ||= Validator.new
+          @@schema ||= @@validator.schema
+        end
+
+        ##
+        # Converts to a hash equivalent for JSON serialization.
+        ##
+        # - Exclude attributes with nil values.
+        # - Validate date properties against schema.
+        ##
+        def to_hash
+          result = {}
+          result[:month] = @month if @month
+          result[:day_of_month] = @day_of_month if @day_of_month
+          result[:year] = @year if @year
+
+          # validate date hash properties against schema
+          if @@validator.validate(@@schema[:definitions][:Date][:properties], result).any?
+            raise "end_uses properties does not match schema: #{@@validator.validate(@@schema[:definitions][:Date][:properties], result)}"
+          end
+
+          return result
+        end
+
+        ##
+        # Assigns default values if values do not exist.
+        ##
+        def defaults
+          hash = {}
+          hash[:month] = nil
+          hash[:day_of_month] = nil
+          hash[:year] = nil
+
+          return hash
+        end
+      end
+    end
+  end
+end