urbanopt-reporting 0.1.0 → 0.3.1

data/lib/measures/default_feature_reports/measure.xml

@@ -3,8 +3,8 @@
   <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>
+  <version_id>f9af7bd8-e9ce-41b4-b892-df29f235a9bd</version_id>
+  <version_modified>20201201T173130Z</version_modified>
   <xml_checksum>FB304155</xml_checksum>
   <class_name>DefaultFeatureReports</class_name>
   <display_name>DefaultFeatureReports</display_name>
@@ -126,17 +126,23 @@
       <usage_type>test</usage_type>
       <checksum>CC4BFFAF</checksum>
     </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>0B68E96D</checksum>
+    </file>
     <file>
       <filename>LICENSE.md</filename>
       <filetype>md</filetype>
       <usage_type>license</usage_type>
-      <checksum>EA283B74</checksum>
+      <checksum>BBD19F47</checksum>
     </file>
     <file>
       <filename>default_feature_reports_test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>56E0804B</checksum>
+      <checksum>19681175</checksum>
     </file>
     <file>
       <version>
@@ -147,13 +153,7 @@
       <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>
+      <checksum>B1E43E26</checksum>
     </file>
   </files>
 </measure>

data/lib/urbanopt/reporting.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/reporting/default_reports.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/reporting/default_reports/construction_cost.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/reporting/default_reports/date.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/reporting/default_reports/distributed_generation.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,
@@ -29,10 +29,10 @@
 # *********************************************************************************
 
 require 'json'
-require_relative  'solar_pv'
-require_relative  'wind'
-require_relative  'generator'
-require_relative  'storage'
+require 'urbanopt/reporting/default_reports/solar_pv'
+require 'urbanopt/reporting/default_reports/wind'
+require 'urbanopt/reporting/default_reports/generator'
+require 'urbanopt/reporting/default_reports/storage'
 require 'json-schema'
 
 module URBANopt
@@ -47,6 +47,11 @@ module URBANopt
         #
         attr_accessor :lcc_us_dollars
 
+        ##
+        # _Float_ - Lifecycle costs for the complete distributed generation system in US Dollars
+        #
+        attr_accessor :lcc_bau_us_dollars
+
         ##
         # _Float_ - Net present value of the complete distributed generation system in US Dollars
         #
@@ -68,10 +73,40 @@ module URBANopt
         attr_accessor :year_one_bill_us_dollars
 
         ##
-        # _Float_ - Total amount paid to the utility in US Dollars over the life of the system
+        # _Float_ - Total energy costs in US Dollars over the life of the system after tax
         #
         attr_accessor :total_energy_cost_us_dollars
 
+        ##
+        # _Float_ - Total demand costs in US Dollars over the life of the system after tax
+        #
+        attr_accessor :total_demand_cost_us_dollars
+
+        ##
+        # _Float_ -  Year one energy cost in the business as usual scenario (i.e no new system) after tax, us dollars
+        #
+        attr_accessor :year_one_energy_cost_bau_us_dollars
+
+        ##
+        # _Float_ -  Year one demand cost in the business as usual scenario (i.e no new system), us dollars
+        #
+        attr_accessor :year_one_demand_cost_bau_us_dollars
+
+        ##
+        # _Float_ -  Year one demand energy bill in the business as usual scenario (i.e no new system), us dollars
+        #
+        attr_accessor :year_one_bill_bau_us_dollars
+
+        ##
+        # _Float_ -  Total lifetime demand costs in the business as usual scenario (i.e no new system) after tax, us dollars
+        #
+        attr_accessor :total_demand_cost_bau_us_dollars
+
+        ##
+        # _Float_ -  Total lifetime energy costs in the business as usual scenario (i.e no new system) after tax, us dollars
+        #
+        attr_accessor :total_energy_cost_bau_us_dollars
+
         ##
         # _Array_ - List of _SolarPV_ systems
         #
@@ -117,6 +152,36 @@ module URBANopt
         #
         attr_accessor :total_generator_kw
 
+        ##
+        # _Float_ -  Minimum hour the system can support critical load during a grid outage
+        #
+        attr_accessor :resilience_hours_min
+
+        ##
+        # _Float_ -  Maximum hour the system can support critical load during a grid outage
+        #
+        attr_accessor :resilience_hours_max
+
+        ##
+        # _Float_ -  Average hour the system can support critical load during a grid outage
+        #
+        attr_accessor :resilience_hours_avg
+
+        ##
+        # _Float_ -  Average probability the system can sustain critical load during a grid outage
+        #
+        attr_accessor :probs_of_surviving
+
+        ##
+        # _Float_ -  Average monthly probabiliies that the system can sustain critical load during a grid outage
+        #
+        attr_accessor :probs_of_surviving_by_month
+
+        ##
+        # _Float_ -  Average hourly probabiliies that the system can sustain critical load during a grid outage
+        #
+        attr_accessor :probs_of_surviving_by_hour_of_the_day
+
         ##
         # Initialize distributed generation system design and financial metrics.
         #
@@ -132,11 +197,25 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
 
           @lcc_us_dollars = hash[:lcc_us_dollars]
+          @lcc_bau_us_dollars = hash[:lcc_bau_us_dollars]
           @npv_us_dollars = hash[:npv_us_dollars]
           @year_one_energy_cost_us_dollars = hash[:year_one_energy_cost_us_dollars]
+          @year_one_energy_cost_bau_us_dollars = hash[:year_one_energy_cost_bau_us_dollars]
           @year_one_demand_cost_us_dollars = hash[:year_one_demand_cost_us_dollars]
+          @year_one_demand_cost_bau_us_dollars = hash[:year_one_demand_cost_bau_us_dollars]
           @year_one_bill_us_dollars = hash[:year_one_bill_us_dollars]
+          @year_one_bill_bau_us_dollars = hash[:year_one_bill_bau_us_dollars]
           @total_energy_cost_us_dollars = hash[:total_energy_cost_us_dollars]
+          @total_energy_cost_bau_us_dollars = hash[:total_energy_cost_bau_us_dollars]
+          @total_demand_cost_us_dollars = hash[:total_demand_cost_us_dollars]
+          @total_demand_cost_bau_us_dollars = hash[:total_demand_cost_bau_us_dollars]
+
+          @resilience_hours_min = hash[:resilience_hours_min]
+          @resilience_hours_max = hash[:resilience_hours_max]
+          @resilience_hours_avg = hash[:resilience_hours_avg]
+          @probs_of_surviving = hash[:probs_of_surviving]
+          @probs_of_surviving_by_month = hash[:probs_of_surviving_by_month]
+          @probs_of_surviving_by_hour_of_the_day = hash[:probs_of_surviving_by_hour_of_the_day]
 
           @total_solar_pv_kw = nil
           @total_wind_kw = nil
@@ -276,16 +355,34 @@ module URBANopt
           result = {}
 
           result[:lcc_us_dollars] = @lcc_us_dollars if @lcc_us_dollars
+          result[:lcc_bau_us_dollars] = @lcc_bau_us_dollars if @lcc_bau_us_dollars
           result[:npv_us_dollars] = @npv_us_dollars if @npv_us_dollars
+
           result[:year_one_energy_cost_us_dollars] = @year_one_energy_cost_us_dollars if @year_one_energy_cost_us_dollars
           result[:year_one_demand_cost_us_dollars] = @year_one_demand_cost_us_dollars if @year_one_demand_cost_us_dollars
           result[:year_one_bill_us_dollars] = @year_one_bill_us_dollars if @year_one_bill_us_dollars
+          result[:total_demand_cost_us_dollars] = @total_demand_cost_us_dollars if @total_demand_cost_us_dollars
+          result[:total_energy_cost_us_dollars] = @total_energy_cost_us_dollars if @total_energy_cost_us_dollars
+
+          result[:year_one_energy_cost_bau_us_dollars] = @year_one_energy_cost_bau_us_dollars if @year_one_energy_cost_bau_us_dollars
+          result[:year_one_demand_cost_bau_us_dollars] = @year_one_demand_cost_bau_us_dollars if @year_one_demand_cost_bau_us_dollars
+          result[:year_one_bill_bau_us_dollars] = @year_one_bill_bau_us_dollars if @year_one_bill_bau_us_dollars
+          result[:total_energy_cost_bau_us_dollars] = @total_energy_cost_bau_us_dollars if @total_energy_cost_bau_us_dollars
+          result[:total_demand_cost_bau_us_dollars] = @total_demand_cost_bau_us_dollars if @total_demand_cost_bau_us_dollars
+
           result[:total_solar_pv_kw] = @total_solar_pv_kw if @total_solar_pv_kw
           result[:total_wind_kw] = @total_wind_kw if @total_wind_kw
           result[:total_generator_kw] = @total_generator_kw if @total_generator_kw
           result[:total_storage_kw] = @total_storage_kw if @total_storage_kw
           result[:total_storage_kwh] = @total_storage_kwh if @total_storage_kwh
 
+          result[:resilience_hours_min] = @resilience_hours_min if @resilience_hours_min
+          result[:resilience_hours_max] = @resilience_hours_max if @resilience_hours_max
+          result[:resilience_hours_avg] = @resilience_hours_avg if @resilience_hours_avg
+          result[:probs_of_surviving] = @probs_of_surviving if @probs_of_surviving
+          result[:probs_of_surviving_by_month] = @probs_of_surviving_by_month if @probs_of_surviving_by_month
+          result[:probs_of_surviving_by_hour_of_the_day] = @probs_of_surviving_by_hour_of_the_day if @probs_of_surviving_by_hour_of_the_day
+
           result[:solar_pv] = []
           @solar_pv.each do |pv|
             result[:solar_pv].push pv.to_hash
@@ -327,11 +424,27 @@ module URBANopt
         ##
         def self.merge_distributed_generation(existing_dgen, new_dgen)
           existing_dgen.lcc_us_dollars = add_values(existing_dgen.lcc_us_dollars, new_dgen.lcc_us_dollars)
+          existing_dgen.lcc_bau_us_dollars = add_values(existing_dgen.lcc_bau_us_dollars, new_dgen.lcc_bau_us_dollars)
           existing_dgen.npv_us_dollars = add_values(existing_dgen.npv_us_dollars, new_dgen.npv_us_dollars)
+
           existing_dgen.year_one_energy_cost_us_dollars = add_values(existing_dgen.year_one_energy_cost_us_dollars, new_dgen.year_one_energy_cost_us_dollars)
           existing_dgen.year_one_demand_cost_us_dollars = add_values(existing_dgen.year_one_demand_cost_us_dollars, new_dgen.year_one_demand_cost_us_dollars)
           existing_dgen.year_one_bill_us_dollars = add_values(existing_dgen.year_one_bill_us_dollars, new_dgen.year_one_bill_us_dollars)
           existing_dgen.total_energy_cost_us_dollars = add_values(existing_dgen.total_energy_cost_us_dollars, new_dgen.total_energy_cost_us_dollars)
+          existing_dgen.total_demand_cost_us_dollars = add_values(existing_dgen.total_demand_cost_us_dollars, new_dgen.total_demand_cost_us_dollars)
+
+          existing_dgen.year_one_energy_cost_bau_us_dollars = add_values(existing_dgen.year_one_energy_cost_bau_us_dollars, new_dgen.year_one_energy_cost_bau_us_dollars)
+          existing_dgen.year_one_demand_cost_bau_us_dollars = add_values(existing_dgen.year_one_demand_cost_bau_us_dollars, new_dgen.year_one_demand_cost_bau_us_dollars)
+          existing_dgen.year_one_bill_bau_us_dollars = add_values(existing_dgen.year_one_bill_bau_us_dollars, new_dgen.year_one_bill_bau_us_dollars)
+          existing_dgen.total_energy_cost_bau_us_dollars = add_values(existing_dgen.total_energy_cost_bau_us_dollars, new_dgen.total_energy_cost_bau_us_dollars)
+          existing_dgen.total_demand_cost_bau_us_dollars = add_values(existing_dgen.total_demand_cost_bau_us_dollars, new_dgen.total_demand_cost_bau_us_dollars)
+
+          existing_dgen.resilience_hours_min = add_values(existing_dgen.resilience_hours_min, new_dgen.resilience_hours_min)
+          existing_dgen.resilience_hours_max = add_values(existing_dgen.resilience_hours_max, new_dgen.resilience_hours_max)
+          existing_dgen.resilience_hours_avg = add_values(existing_dgen.resilience_hours_avg, new_dgen.resilience_hours_avg)
+          existing_dgen.probs_of_surviving = add_values(existing_dgen.probs_of_surviving, new_dgen.probs_of_surviving)
+          existing_dgen.probs_of_surviving_by_month = add_values(existing_dgen.probs_of_surviving_by_month, new_dgen.probs_of_surviving_by_month)
+          existing_dgen.probs_of_surviving_by_hour_of_the_day = add_values(existing_dgen.probs_of_surviving_by_hour_of_the_day, new_dgen.probs_of_surviving_by_hour_of_the_day)
 
           new_dgen.solar_pv.each do |pv|
             existing_dgen.solar_pv.push pv

data/lib/urbanopt/reporting/default_reports/end_use.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/reporting/default_reports/end_uses.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,
@@ -39,10 +39,10 @@ module URBANopt
       # Enduses class inlclude results for each fuel type.
       ##
       class EndUses
-        attr_accessor :electricity, :natural_gas, :additional_fuel, :district_cooling, :district_heating, :water # :nodoc:
+        attr_accessor :electricity_kwh, :natural_gas_kwh, :propane_kwh, :fuel_oil_kwh, :other_fuels_kwh, :district_cooling_kwh, :district_heating_kwh, :water_qbft # :nodoc:
         ##
-        # EndUses class intialize end_uses(fuel type) attributes: +:electricity+ , +:natural_gas+ , +:additional_fuel+ ,
-        # +:district_cooling+ , +:district_heating+ , +:water+
+        # EndUses class intialize end_uses(fuel type) attributes: +:electricity_kwh+ , +:natural_gas_kwh+ , +:propane_kwh+ , +:fuel_oil_kwh+ , +:other_fuels_kwh+ ,
+        # +:district_cooling_kwh+ , +:district_heating_kwh+ , +:water_qbft+
         ##
         # [parameters:]
         # +hash+ - _Hash_ - A hash which may contain a deserialized end_uses.
@@ -51,12 +51,14 @@ module URBANopt
           hash.delete_if { |k, v| v.nil? }
           hash = defaults.merge(hash)
 
-          @electricity = EndUse.new(hash[:electricity])
-          @natural_gas = EndUse.new(hash[:natural_gas])
-          @additional_fuel = EndUse.new(hash[:additional_fuel])
-          @district_cooling = EndUse.new(hash[:district_cooling])
-          @district_heating = EndUse.new(hash[:district_heating])
-          @water = EndUse.new(hash[:water])
+          @electricity_kwh = EndUse.new(hash[:electricity_kwh])
+          @natural_gas_kwh = EndUse.new(hash[:natural_gas_kwh])
+          @propane_kwh = EndUse.new(hash[:propane_kwh])
+          @fuel_oil_kwh = EndUse.new(hash[:fuel_oil_kwh])
+          @other_fuels_kwh = EndUse.new(hash[:other_fuels_kwh])
+          @district_cooling_kwh = EndUse.new(hash[:district_cooling_kwh])
+          @district_heating_kwh = EndUse.new(hash[:district_heating_kwh])
+          @water_qbft = EndUse.new(hash[:water_qbft])
 
           # initialize class variables @@validator and @@schema
           @@validator ||= Validator.new
@@ -72,29 +74,37 @@ module URBANopt
         def to_hash
           result = {}
 
-          electricity_hash = @electricity.to_hash if @electricity.to_hash
-          electricity_hash.delete_if { |k, v| v.nil? }
-          result[:electricity] = electricity_hash if @electricity
+          electricity_kwh_hash = @electricity_kwh.to_hash if @electricity_kwh
+          electricity_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:electricity_kwh] = electricity_kwh_hash if @electricity_kwh
 
-          natural_gas_hash = @natural_gas.to_hash if @natural_gas
-          natural_gas_hash.delete_if { |k, v| v.nil? }
-          result[:natural_gas] = natural_gas_hash if @natural_gas
+          natural_gas_kwh_hash = @natural_gas_kwh.to_hash if @natural_gas_kwh
+          natural_gas_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:natural_gas_kwh] = natural_gas_kwh_hash if @natural_gas_kwh
 
-          additional_fuel_hash = @additional_fuel.to_hash if @additional_fuel
-          additional_fuel_hash.delete_if { |k, v| v.nil? }
-          result[:additional_fuel] = additional_fuel_hash if @additional_fuel
+          propane_kwh_hash = @propane_kwh.to_hash if @propane_kwh
+          propane_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:propane_kwh] = propane_kwh_hash if @propane_kwh
 
-          district_cooling_hash = @district_cooling.to_hash if @district_cooling
-          district_cooling_hash.delete_if { |k, v| v.nil? }
-          result[:district_cooling] = district_cooling_hash if @district_cooling
+          fuel_oil_kwh_hash = @fuel_oil_kwh.to_hash if @fuel_oil_kwh
+          fuel_oil_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:fuel_oil_kwh] = fuel_oil_kwh_hash if @fuel_oil_kwh
 
-          district_heating_hash = @district_heating.to_hash if @district_heating
-          district_heating_hash.delete_if { |k, v| v.nil? }
-          result[:district_heating] = district_heating_hash if @district_heating
+          other_fuels_kwh_hash = @other_fuels_kwh.to_hash if @other_fuels_kwh
+          other_fuels_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:other_fuels_kwh] = other_fuels_kwh_hash if @other_fuels_kwh
 
-          water_hash = @water.to_hash if @water
-          water_hash.delete_if { |k, v| v.nil? }
-          result[:water] = water_hash if @water
+          district_cooling_kwh_hash = @district_cooling_kwh.to_hash if @district_cooling_kwh
+          district_cooling_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:district_cooling_kwh] = district_cooling_kwh_hash if @district_cooling_kwh
+
+          district_heating_kwh_hash = @district_heating_kwh.to_hash if @district_heating_kwh
+          district_heating_kwh_hash.delete_if { |k, v| v.nil? }
+          result[:district_heating_kwh] = district_heating_kwh_hash if @district_heating_kwh
+
+          water_qbft_hash = @water_qbft.to_hash if @water_qbft
+          water_qbft_hash.delete_if { |k, v| v.nil? }
+          result[:water_qbft] = water_qbft_hash if @water_qbft
 
           # validate end_uses properties against schema
           if @@validator.validate(@@schema[:definitions][:EndUses][:properties], result).any?
@@ -109,12 +119,14 @@ module URBANopt
         ##
         def defaults
           hash = {}
-          hash[:electricity] = EndUse.new.to_hash
-          hash[:natural_gas] = EndUse.new.to_hash
-          hash[:additional_fuel] = EndUse.new.to_hash
-          hash[:district_cooling] = EndUse.new.to_hash
-          hash[:district_heating] = EndUse.new.to_hash
-          hash[:water] = EndUse.new.to_hash
+          hash[:electricity_kwh] = EndUse.new.to_hash
+          hash[:natural_gas_kwh] = EndUse.new.to_hash
+          hash[:propane_kwh] = EndUse.new.to_hash
+          hash[:fuel_oil_kwh] = EndUse.new.to_hash
+          hash[:other_fuels_kwh] = EndUse.new.to_hash
+          hash[:district_cooling_kwh] = EndUse.new.to_hash
+          hash[:district_heating_kwh] = EndUse.new.to_hash
+          hash[:water_qbft] = EndUse.new.to_hash
 
           return hash
         end
@@ -127,11 +139,13 @@ module URBANopt
         ##
         def merge_end_uses!(new_end_uses)
           # modify the existing_period by summing up the results ; # sum results only if they exist
-          @electricity.merge_end_use!(new_end_uses.electricity)
-          @natural_gas.merge_end_use!(new_end_uses.natural_gas)
-          @additional_fuel.merge_end_use!(new_end_uses.additional_fuel)
-          @district_cooling.merge_end_use!(new_end_uses.district_cooling)
-          @district_heating.merge_end_use!(new_end_uses.district_heating)
+          @electricity_kwh.merge_end_use!(new_end_uses.electricity_kwh)
+          @natural_gas_kwh.merge_end_use!(new_end_uses.natural_gas_kwh)
+          @propane_kwh.merge_end_use!(new_end_uses.propane_kwh)
+          @fuel_oil_kwh.merge_end_use!(new_end_uses.fuel_oil_kwh)
+          @other_fuels_kwh.merge_end_use!(new_end_uses.other_fuels_kwh)
+          @district_cooling_kwh.merge_end_use!(new_end_uses.district_cooling_kwh)
+          @district_heating_kwh.merge_end_use!(new_end_uses.district_heating_kwh)
           return self
         end
       end

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

@@ -1,3 +1,33 @@
+# *********************************************************************************
+# 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,
+# 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 'version'
 require 'openstudio/extension'