openstudio-standards 0.7.1 → 0.8.0.rc1

data/lib/openstudio-standards/standards/necb/common/btap_data.rb

@@ -7,7 +7,8 @@ class BTAPData
 
   def initialize(model:, runner: nil, cost_result:, baseline_cost_equipment_total_cost_per_m_sq: -1.0,
                  baseline_cost_utility_neb_total_cost_per_m_sq: -1.0, baseline_energy_eui_total_gj_per_m_sq: -1.0, qaqc:,
-                 npv_start_year:, npv_end_year:, npv_discount_rate:)
+                 npv_start_year: 2022, npv_end_year: 2041, npv_discount_rate: 0.03, npv_discount_rate_carbon: 0.03, oerd_utility_pricing: nil,
+                 utility_pricing_year: 2020)
     @model = model
     @error_warning = []
     # sets sql file.
@@ -17,6 +18,7 @@ class BTAPData
     @btap_data = {}
     @btap_results_version = 1.00
     @neb_prices_csv_file_name = File.join(__dir__, 'neb_end_use_prices.csv')
+    @neb_prices_csv_file_name = File.join(__dir__, 'utility_pricing_2025-02-20.csv') if oerd_utility_pricing.to_bool
     @necb_reference_runs_csv_file_name = File.join(__dir__, 'necb_reference_runs.csv')
 
     # Conditioned floor area is used so much. May as well make it a object variable.
@@ -49,7 +51,7 @@ class BTAPData
     @btap_data.merge!(service_water_heating_data)
     @btap_data.merge!(energy_eui_data(model))
     @btap_data.merge!(energy_peak_data)
-    @btap_data.merge!(utility(model))
+    @btap_data.merge!(utility(model: model, utility_pricing_year: utility_pricing_year))
     @btap_data.merge!(unmet_hours(model))
     @btap_data.merge!outdoor_air_data(model)
 
@@ -87,8 +89,10 @@ class BTAPData
     phius_performance_indicators(model)
     # The below method calculates energy performance indicators (i.e. TEDI and MEUI) as per BC Energy Step Code
     bc_energy_step_code_performance_indicators
+        # calculates annual peak electricity cost (dollar)
+    annual_peak_kW_per_m_sq = oerd_electricity_cost(model: model, utility_pricing_year: utility_pricing_year, oerd_utility_pricing: oerd_utility_pricing)
     # calculate net present value
-    net_present_value(npv_start_year, npv_end_year, npv_discount_rate) unless cost_result.nil?
+    net_present_value(npv_start_year: npv_start_year, npv_end_year: npv_end_year, npv_discount_rate: npv_discount_rate, npv_discount_rate_carbon: npv_discount_rate_carbon, oerd_utility_pricing: oerd_utility_pricing, annual_peak_kW_per_m_sq: annual_peak_kW_per_m_sq) unless cost_result.nil?
 
     measure_metrics(qaqc)
     @btap_data
@@ -171,35 +175,43 @@ class BTAPData
     return building_data
   end
 
-  def net_present_value(npv_start_year, npv_end_year, npv_discount_rate)
+  def net_present_value(npv_start_year: 2022, npv_end_year: 2041, npv_discount_rate: 0.03, npv_discount_rate_carbon: 0.03, oerd_utility_pricing: false, annual_peak_kW_per_m_sq: nil)
 
     # Find end year in the neb data
     neb_header = CSV.read(@neb_prices_csv_file_name, headers: true).headers
     neb_header.delete_if { |item| ["building_type", "province", "fuel_type"].include?(item) } # remove "building_type", "province", "fuel_type" from neb_header in order to have only years in neb_header
+    neb_header.delete_if { |item| ["rate_class", "units", "references", "links"].include?(item) } if oerd_utility_pricing # remove additional headers if the OERD data is used
     neb_header.map(&:to_f)  #convert years to float
     year_max = neb_header.max
 
     # Convert a string to a float
-    if npv_start_year.instance_of?(String) && npv_start_year != 'NECB_Default' && npv_start_year != 'none'
+    if npv_start_year.instance_of?(String) && npv_start_year != 'NECB_Default' && npv_start_year != 'none' && !npv_start_yeay.nil?
       npv_start_year = npv_start_year.to_f
     end
-    if npv_end_year.instance_of?(String) && npv_end_year != 'NECB_Default' && npv_end_year != 'none'
+    if npv_end_year.instance_of?(String) && npv_end_year != 'NECB_Default' && npv_end_year != 'none' && !npv_end_year.nil?
       npv_end_year = npv_end_year.to_f
     end
-    if npv_discount_rate.instance_of?(String) && npv_discount_rate != 'NECB_Default' && npv_discount_rate != 'none'
+    if npv_discount_rate.instance_of?(String) && npv_discount_rate != 'NECB_Default' && npv_discount_rate != 'none' && !npv_discount_rate.nil?
       npv_discount_rate = npv_discount_rate.to_f
     end
+    if npv_discount_rate_carbon.instance_of?(String) && npv_discount_rate_carbon != 'NECB_Default' && npv_discount_rate_carbon != 'none' && !npv_discount_rate_carbon.nil?
+      npv_discount_rate_carbon = npv_discount_rate_carbon.to_f
+    end
+
 
     # Set default npv_start_year as 2022, npv_end_year as 2041, npv_discount_rate as 3%
-    if npv_start_year == 'NECB_Default' || npv_start_year == nil || npv_start_year == 'none'
+    if npv_start_year == 'NECB_Default' || npv_start_year.nil? || npv_start_year == 'none'
       npv_start_year = 2022
     end
-    if npv_end_year == 'NECB_Default' || npv_end_year == nil || npv_end_year == 'none'
+    if npv_end_year == 'NECB_Default' || npv_end_year.nil? || npv_end_year == 'none'
       npv_end_year = 2041
     end
-    if npv_discount_rate == 'NECB_Default' || npv_discount_rate == nil || npv_discount_rate == 'none'
+    if npv_discount_rate == 'NECB_Default' || npv_discount_rate.nil? || npv_discount_rate == 'none'
       npv_discount_rate = 0.03
     end
+    if npv_discount_rate_carbon == 'NECB_Default' || npv_discount_rate_carbon.nil? || npv_discount_rate_carbon == 'none'
+      npv_discount_rate_carbon = 0.03
+    end
 
     # Set npv_end_year as year_max if users' input > neb's end year
     if npv_end_year > year_max.to_f
@@ -211,7 +223,7 @@ class BTAPData
     # puts "npv_discount_rate is #{npv_discount_rate}"
 
     # Get energy end-use prices (CER data from https://apps.cer-rec.gc.ca/ftrppndc/dflt.aspx?GoCTemplateCulture=en-CA)
-    @neb_prices_csv_file_name = "#{File.dirname(__FILE__)}/neb_end_use_prices.csv"
+    # @neb_prices_csv_file_name = "#{File.dirname(__FILE__)}/neb_end_use_prices.csv"
 
     # Create a hash of the neb data.
     neb_data = CSV.parse(File.read(@neb_prices_csv_file_name), headers: true, converters: :numeric).map(&:to_h)
@@ -233,20 +245,36 @@ class BTAPData
     onsite_elec_generation = @btap_data['total_site_eui_gj_per_m_sq'] - @btap_data['net_site_eui_gj_per_m_sq']
     if onsite_elec_generation > 0.0
       eui_elec = @btap_data['energy_eui_electricity_gj_per_m_sq'] - onsite_elec_generation
+      # Calculate the saved GHG emissions from onsite electricity generatation (assume it does not emmit GHGs)
+      ghg_saved = get_utility_ghg_kg_per_gj(province: province_abbreviation, fuel_type: "Electricity") * onsite_elec_generation
+      # Convert to tonnes of ghg/m^2
+      ghg_elec = (@btap_data['cost_utility_ghg_electricity_kg_per_m_sq'].to_f - ghg_saved.to_f)/1000.0
     else
       eui_elec = @btap_data['energy_eui_electricity_gj_per_m_sq']
+      # Convert to tonnes of ghg/m^2
+      ghg_elec = @btap_data['cost_utility_ghg_electricity_kg_per_m_sq'].to_f/1000.0
     end
     # puts "onsite_elec_generation is #{onsite_elec_generation}"
     # puts "eui_elec is #{eui_elec}"
     row = neb_data.detect do |data|
       (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Electricity')
     end
+    row_peak = nil
+    if oerd_utility_pricing && !annual_peak_kW_per_m_sq.nil?
+      row_peak = neb_data.detect do |data|
+        (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Electricity Peak')
+      end
+    end
     npv_elec = 0.0
     year_index = 1.0
+    npv_elec_ghg = 0.0
+    npv_elec_peak = 0.0
     if eui_elec > 0.0
       for year in npv_start_year.to_int..npv_end_year.to_int
         # puts "year, #{year}, #{row[year.to_s]}, year_index, #{year_index}"
         npv_elec += (eui_elec * row[year.to_s]) / (1+npv_discount_rate)**year_index
+        npv_elec_ghg += (ghg_elec * get_national_ghg_cost(year: year.to_i)) / (1+npv_discount_rate_carbon)**year_index
+        npv_elec_peak += (annual_peak_kW_per_m_sq * row_peak[year.to_s]) / (1+npv_discount_rate)**year_index unless row_peak.nil? || annual_peak_kW_per_m_sq.nil?
         year_index += 1.0
       end
     end
@@ -254,35 +282,46 @@ class BTAPData
 
     # Calculate npv of natural gas
     eui_ngas= @btap_data['energy_eui_natural_gas_gj_per_m_sq']
+    # Convert to tonnes of ghg/m^2
+    ghg_ngas = @btap_data['cost_utility_ghg_natural gas_kg_per_m_sq'].to_f/1000.0
     row = neb_data.detect do |data|
       (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Natural Gas')
     end
     npv_ngas = 0.0
+    npv_ngas_ghg = 0.0
     year_index = 1.0
     for year in npv_start_year.to_int..npv_end_year.to_int
       npv_ngas += (eui_ngas * row[year.to_s]) / (1+npv_discount_rate)**year_index
+      npv_ngas_ghg += (ghg_ngas * get_national_ghg_cost(year: year.to_i)) / (1+npv_discount_rate_carbon)**year_index
       year_index += 1.0
     end
     # puts "npv_ngas is #{npv_ngas}"
 
     # Calculate npv of oil
     eui_oil= @btap_data['energy_eui_additional_fuel_gj_per_m_sq']
+    # Convert to tonnes of ghg/m^2
+    ghg_oil = @btap_data['cost_utility_ghg_oil_kg_per_m_sq'].to_f/1000.0
     row = neb_data.detect do |data|
       (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Oil')
     end
     npv_oil = 0.0
+    npv_oil_ghg = 0.0
     year_index = 1.0
     for year in npv_start_year.to_int..npv_end_year.to_int
       npv_oil += (eui_oil * row[year.to_s]) / (1+npv_discount_rate)**year_index
+      npv_oil_ghg += (ghg_oil * get_national_ghg_cost(year: year.to_i)) / (1+npv_discount_rate_carbon)**year_index
       year_index += 1.0
     end
     # puts "npv_oil is #{npv_oil}"
 
     # Calculate total npv
     npv_total = @btap_data['cost_equipment_total_cost_per_m_sq'] + npv_elec + npv_ngas + npv_oil
-
+    npv_ghg_total = npv_elec_ghg + npv_ngas_ghg + npv_oil_ghg
+    npv_total_with_ghg_and_peak = npv_ghg_total + npv_total + npv_elec_peak
     @btap_data.merge!('npv_total_per_m_sq' => npv_total)
-
+    @btap_data.merge!('npv_carbon_pricing_per_m_sq' => npv_ghg_total)
+    @btap_data.merge!('npv_peak_elec_per_m_sq' => npv_elec_peak)
+    @btap_data.merge!('npv_with_carbon_and_peak_pricing_total_per_m_sq' => npv_total_with_ghg_and_peak)
   end
 
   def envelope(model)
@@ -515,7 +554,148 @@ class BTAPData
     return geography_data
   end
 
-  def utility(model)
+  ### The 'annual_peak_electricity_cost_dollar' function calculates annual peak electricity cost (dollar)
+  ### for OEE-Electrification project using the OERD's electricity rates for commercial buildings
+  ### that Danielle Krauel of OEE provided to CE-O
+  def oerd_electricity_cost(model:, utility_pricing_year: 2020, oerd_utility_pricing: false)
+    unless oerd_utility_pricing
+      @btap_data.merge!('cost_utility_oerd_electricity_peak_annual_cost_per_m_sq' => 0.00) unless oerd_utility_pricing
+      @btap_data.merge!('cost_utility_oerd_electricity_energy_annual_cost_per_m_sq' => 0.00) unless oerd_utility_pricing
+      return 0.00
+    end
+
+    #===================================================================================================================
+    ### OERD's electricity rates for commercial buildings
+    neb_data = CSV.parse(File.read(@neb_prices_csv_file_name), headers: true, converters: :numeric).map(&:to_h)
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    ##################### Calculate annual electricity peak cost using OERD's electricity rate #########################
+    #===================================================================================================================
+    #===================================================================================================================
+    ### Find index for hourly data of 'ElectricityNet:Facility' (J)
+    query = "
+        SELECT ReportDataDictionaryIndex
+        FROM ReportDataDictionary
+        WHERE Name=='ElectricityNet:Facility' AND ReportingFrequency == 'Hourly' AND Units == 'J'
+        "
+    index_timestep_electricity = model.sqlFile.get.execAndReturnVectorOfInt(query).get[0]
+    number_of_timesteps_per_hour = 1
+    puts "Trying hourly ElectricityNet:Facility"
+
+    ### Find index for timestep data of 'Electricity:Facility' (J) if 'ElectricityNet:Facility' data is not available
+    if index_timestep_electricity.nil?
+      query = "
+        SELECT ReportDataDictionaryIndex
+        FROM ReportDataDictionary
+        WHERE Name=='Electricity:Facility' AND ReportingFrequency == 'Zone Timestep' AND Units == 'J'
+        "
+      index_timestep_electricity = model.sqlFile.get.execAndReturnVectorOfInt(query).get[0]
+      number_of_timesteps_per_hour = model.getTimestep.numberOfTimestepsPerHour
+      puts "Trying timestep Electricity:Facility"
+    end
+
+    ### Find index for hourly data of 'Electricity:Facility' (J) if timestep data is not available
+    if index_timestep_electricity.nil?
+      query = "
+        SELECT ReportDataDictionaryIndex
+        FROM ReportDataDictionary
+        WHERE Name=='Electricity:Facility' AND ReportingFrequency == 'Hourly' AND Units == 'J'
+        "
+      index_timestep_electricity = model.sqlFile.get.execAndReturnVectorOfInt(query).get[0]
+      number_of_timesteps_per_hour = 1
+      puts "Trying hourly Electricity:Facility"
+    end
+
+    if index_timestep_electricity.nil?
+      puts "No hourly or timestep data available.  Peak data not available"
+      @btap_data.merge!('cost_utility_oerd_electricity_peak_annual_cost_per_m_sq' => 0.00) unless oerd_utility_pricing
+      @btap_data.merge!('cost_utility_oerd_electricity_energy_annual_cost_per_m_sq' => 0.00) unless oerd_utility_pricing
+      return 0.00
+    end
+    ### Get number of timesteps from the model
+    timestep_second = 3600 / number_of_timesteps_per_hour
+    #===================================================================================================================
+    ### Calculate number of timesteps of the whole year, and create dates/times for the whole year
+    number_of_timesteps_of_year = 365 * 24 * number_of_timesteps_per_hour
+    timesteps_of_year = []
+    d = Time.new(2006, 1, 1, 0)
+    (0...number_of_timesteps_of_year).each do |increment|
+      timesteps_of_year << (d + (60 * 60 / number_of_timesteps_per_hour) * increment).strftime('%Y-%m-%d %H:%M')
+    end
+    #===================================================================================================================
+
+    #===================================================================================================================
+    ### Get timestep output for Electricity:Facility output.
+    query = "
+      Select VariableValue
+      FROM ReportVariableData
+      WHERE
+      ReportVariableDataDictionaryIndex = #{index_timestep_electricity}
+    "
+    timestep_values = model.sqlFile.get.execAndReturnVectorOfDouble(query).get
+    #===================================================================================================================
+    ### Calculate electricity peak (J) for each month of the year
+    # Find month of each timestep
+    keys_month = timesteps_of_year.map{ |timestep| DateTime.parse(timestep).to_date.month }
+    # Create a hash where its keys are months and values for eahc month are electricity energy use (J) of all timesteps for that month
+    hash_months_electricity = keys_month.zip(timestep_values).group_by(&:first).map{|key, value| [key, value.map(&:last)]}.to_h
+    # Find maximum of electricity energy use (J) among all timesteps for each month of the year
+    monthly_peak_J = hash_months_electricity.map { |key, value| [key, value.max()] }.to_h
+    #===================================================================================================================
+    ### Convert J to kW of maximum electricity energy use (J)
+    monthly_peak_kW = monthly_peak_J.map { |key, value| [key, value * 0.001 / timestep_second] }.to_h
+    ### Normalize by building floor area
+    annual_peak_kW_per_m_sq = monthly_peak_kW.values.sum / @btap_data['bldg_conditioned_floor_area_m_sq'].to_f
+    #===================================================================================================================
+    ### Get province of the model and find its peak electricity price from the utility_pricing_2025-02-20.csv
+    province = @btap_data['location_state_province_region']
+    # Find which province the proposed building is located in
+    building_type = 'Commercial'
+    geography_data = climate_data
+    province_abbreviation = geography_data['location_state_province_region']
+    province = @standards_data['province_map'][province_abbreviation]
+    row_peak = neb_data.detect do |data|
+      (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Electricity Peak')
+    end
+    province_dollar_kW_month = row_peak[utility_pricing_year.to_i.to_s]
+    #===================================================================================================================
+    ### Calculate cost of peak electricity for each month
+    monthly_peak_cost = monthly_peak_kW.map { |key, value| [key, value * province_dollar_kW_month] }.to_h
+    #===================================================================================================================
+    ### Calculate cost of peak electricity for the whole year in dollar
+    annual_peak_cost_dollar = monthly_peak_cost.values.sum
+    #===================================================================================================================
+    ### Calculate cost of peak electricity for the whole year in dollar normalized by floor area
+    annual_peak_cost_dollar_per_m_sq = annual_peak_cost_dollar / @btap_data['bldg_conditioned_floor_area_m_sq']
+    #===================================================================================================================
+    ### Merge the calculated value to @btap_data
+    @btap_data.merge!('cost_utility_oerd_electricity_peak_annual_cost_per_m_sq' => annual_peak_cost_dollar_per_m_sq.round(2))
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    #===================================================================================================================
+    ################### Calculate annual electricity energy use cost using OERD's electricity rate #####################
+    #===================================================================================================================
+    ### Get province of the model and find its peak electricity price from the pricing_2025-02-20.csv
+    row_elec = neb_data.detect do |data|
+      (data['building_type'] == building_type) && (data['province'] == province) && (data['fuel_type'] == 'Electricity')
+    end
+    province_dollar_kWh = row_elec[utility_pricing_year.to_i.to_s]
+    #===================================================================================================================
+    # Calculate cost of energy electricity for the whole year in dollar normalized by floor area
+    annual_energy_cost_dollar_per_m_sq = @btap_data['energy_eui_electricity_gj_per_m_sq'] * 277.778 * province_dollar_kWh
+    #===================================================================================================================
+    ### Merge the calculated value to @btap_data
+    @btap_data.merge!('cost_utility_oerd_electricity_energy_annual_cost_per_m_sq' => annual_energy_cost_dollar_per_m_sq.round(2))
+    #===================================================================================================================
+    return annual_peak_kW_per_m_sq
+  end
+
+  def utility(model:, utility_pricing_year: 2020)
     economics_data = {}
     building_type = 'Commercial'
     province = @standards_data['province_map'][model.getWeatherFile.stateProvinceRegion]
@@ -538,12 +718,14 @@ class BTAPData
     neb_data = CSV.parse(File.read(@neb_prices_csv_file_name), headers: true, converters: :numeric).map(&:to_h)
 
     neb_eplus_fuel_map.each do |neb_fuel, ep_fuel|
+      next if neb_fuel.to_s.downcase == 'electricity peak'
       row = neb_data.detect do |data|
-        (data['building_type'] == building_type) &&
-          (data['province'] == province) &&
-          (data['fuel_type'] == neb_fuel)
+        (data['building_type'].to_s == building_type) &&
+          (data['province'].to_s == province) &&
+          (data['fuel_type'].to_s == neb_fuel)
       end
-      neb_fuel_cost = row['2021']
+      utility_pricing_year_s = utility_pricing_year.to_i.to_s
+      neb_fuel_cost = row[utility_pricing_year_s]
       fuel_consumption_gj = 0.0
       sql_command = "SELECT Value FROM tabulardatawithstrings
                      WHERE ReportName='EnergyMeters'
@@ -2282,4 +2464,19 @@ class BTAPData
     end
     # def phius_metrics(model)
   end
+
+  def get_national_ghg_cost(year:)
+    raise "Nil year submitted for national ghg cost" if year.nil?
+    year = year.to_i
+    if year < 2019
+      price = 0.0
+    elsif (year >= 2019) && (year <= 2030)
+      ghg_price_data = @standards_data["tables"]["canada_national_carbon_pricing"]["table"]
+      year_price = ghg_price_data.detect { |item| (item["year"].to_i == year) }
+      price = year_price["price_per_tonne"].to_f
+    elsif (year > 2030)
+      price = 170.0
+    end
+    return price.to_f
+  end
 end

data/lib/openstudio-standards/standards/necb/common/btap_datapoint.rb

@@ -84,6 +84,7 @@ class BTAPDatapoint
     @npv_start_year = @options[:npv_start_year]
     @npv_end_year = @options[:npv_end_year]
     @npv_discount_rate = @options[:npv_discount_rate]
+    @npv_discount_rate_carbon = @options[:npv_discount_rate_carbon]
 
     # Save configuration to temp folder.
     File.open(File.join(@dp_temp_folder, 'run_options.yml'), 'w') { |file| file.write(@options.to_yaml) }
@@ -93,6 +94,10 @@ class BTAPDatapoint
       @options[:template] = 'NECB2011' if @options[:algorithm_type] == 'osm_batch'
       @standard = Standard.build(@options[:template])
 
+      # Set use the convert_arg_to_bool method from the standard class to set the @oerd_utility_pricing_flag
+      @oerd_utility_pricing = @standard.convert_arg_to_bool(variable: @options[:oerd_utility_pricing], default: false)
+      @utility_pricing_year = @standard.convert_arg_to_f(variable: @options[:utility_pricing_year], default: 2020)
+
       # This allows you to select the skeleton model from our built in starting points. You can add a custom file as
       # it will search the libary first,.
       # model = load_osm(@options[:building_type]) # loads skeleton file from path.
@@ -178,11 +183,13 @@ class BTAPDatapoint
                                        tbd_option: @options[:tbd_option],
                                        necb_hdd: @options[:necb_hdd],
                                        boiler_fuel: @options[:boiler_fuel],
-                                       boiler_cap_ratio: @options[:boiler_cap_ratio]
+                                       boiler_cap_ratio: @options[:boiler_cap_ratio],
+                                       swh_fuel: @options[:swh_fuel],
+                                       oerd_utility_pricing: @oerd_utility_pricing
                                        )
       end
 
-      # Save model to to disk.
+      # Save model to disk.
       puts "saving model to #{File.join(@dp_temp_folder, 'output.osm')}"
       BTAP::FileIO.save_osm(model, File.join(@dp_temp_folder, 'output.osm'))
 
@@ -252,7 +259,10 @@ class BTAPDatapoint
                                   qaqc: @qaqc,
                                   npv_start_year: @npv_start_year,
                                   npv_end_year: @npv_end_year,
-                                  npv_discount_rate: @npv_discount_rate).btap_data
+                                  npv_discount_rate: @npv_discount_rate,
+                                  npv_discount_rate_carbon: @npv_discount_rate_carbon,
+                                  oerd_utility_pricing: @oerd_utility_pricing,
+                                  utility_pricing_year: @utility_pricing_year).btap_data
 
         # Write Files
         File.open(File.join(@dp_temp_folder, 'btap_data.json'), 'w') { |f| f.write(JSON.pretty_generate(@btap_data.sort.to_h, allow_nan: true)) }
@@ -263,6 +273,9 @@ class BTAPDatapoint
 
         #output hourly data
         self.output_hourly_data(model,@dp_temp_folder, @options[:datapoint_id])
+
+        # Output timestep data
+        self.output_timestep_data(model,@dp_temp_folder, @options[:datapoint_id])
       end
     rescue StandardError => bang
       puts "Error occured: #{bang}"
@@ -361,8 +374,7 @@ class BTAPDatapoint
     return exit_code
   end
 
-
-  def output_hourly_data(model, output_folder,datapoint_id)
+  def output_hourly_data(model, output_folder, datapoint_id)
     osm_path = File.join(output_folder, "run_dir/in.osm")
     sql_path = File.join(output_folder, "run_dir/run/eplusout.sql")
     csv_output = File.join(output_folder, "hourly.csv")
@@ -373,20 +385,18 @@ class BTAPDatapoint
       hours_of_year << (d + (60 * 60) * increment).strftime('%Y-%m-%d %H:%M')
     end
 
-
     array_of_hashes = []
 
-
-#Find hourly outputs available for this datapoint.
+    # Find hourly outputs available for this datapoint.
     query = "
         SELECT ReportDataDictionaryIndex
         FROM ReportDataDictionary
         WHERE ReportingFrequency == 'Hourly'
                                                        "
-# Get hourly data for each output.
+    # Get hourly data for each output.
     model.sqlFile.get.execAndReturnVectorOfInt(query).get.each do |rdd_index|
 
-      #Get Name
+      # Get Name
       query = "
         SELECT Name
         FROM ReportDataDictionary
@@ -394,7 +404,7 @@ class BTAPDatapoint
       "
       name = model.sqlFile.get.execAndReturnFirstString(query).get
 
-      #Get KeyValue
+      # Get KeyValue
       query = "
         SELECT KeyValue
         FROM ReportDataDictionary
@@ -411,7 +421,7 @@ class BTAPDatapoint
         key_value = ""
       end
 
-      #Get Units
+      # Get Units
       query = "
         SELECT Units
         FROM ReportDataDictionary
@@ -419,7 +429,7 @@ class BTAPDatapoint
       "
       units = model.sqlFile.get.execAndReturnFirstString(query).get
 
-      #Get hourly data
+      # Get hourly data
       query = "
                     Select Value
                     FROM ReportData
@@ -430,7 +440,7 @@ class BTAPDatapoint
 
       hourly_hash = Hash[hours_of_year.zip(hourly_values)]
 
-      data_hash = {"datapoint_id": datapoint_id, "Name": name, "KeyValue": key_value, "Units": units}.merge(hourly_hash)
+      data_hash = { "datapoint_id": datapoint_id, "Name": name, "KeyValue": key_value, "Units": units }.merge(hourly_hash)
       array_of_hashes << data_hash
     end
 
@@ -443,4 +453,169 @@ class BTAPDatapoint
       end
     end
   end
-end
+  #=====================================================================================================================
+  def output_timestep_data(model, output_folder,datapoint_id)
+    osm_path = File.join(output_folder, "run_dir/in.osm")
+    sql_path = File.join(output_folder, "run_dir/run/eplusout.sql")
+    csv_output = File.join(output_folder, "timestep.csv")
+    #===================================================================================================================
+    # Get number of timesteps from the model
+    number_of_timesteps_per_hour = model.getTimestep.numberOfTimestepsPerHour
+    #===================================================================================================================
+    # Calculate number of timesteps of the whole year
+    number_of_timesteps_of_year = 365 * 24 * number_of_timesteps_per_hour
+
+    timesteps_of_year = []
+    d = Time.new(2006, 1, 1, 0)
+    (0...number_of_timesteps_of_year).each do |increment|
+      timesteps_of_year << (d + (60 * 60 / number_of_timesteps_per_hour) * increment).strftime('%Y-%m-%d %H:%M')
+    end
+    timesteps_index = Array(0..number_of_timesteps_of_year-1)
+    #===================================================================================================================
+    # Create a hash with indices ('timesteps_index') as keys and timesteps as values ('timesteps_of_year')
+    # Note from Sara Gilani: 'I had to do this, as when I used 'timesteps_of_year' as keys to create all hashes below
+    # (e.g. timestep_hash_datapoint_id, timestep_hash_name, timestep_hash_key_value, ...),
+    # it did not create the right number of timesteps for the whole year'
+    timesteps_of_year_with_index = Hash[timesteps_index.zip(timesteps_of_year)]
+    #===================================================================================================================
+    array_of_hashes = []
+    array_of_hashes_transposed = []
+    #===================================================================================================================
+    # Find timestep outputs available for this datapoint.
+    query = "
+        SELECT ReportDataDictionaryIndex
+        FROM ReportDataDictionary
+        WHERE ReportingFrequency == 'Zone Timestep'
+        "
+    #===================================================================================================================
+    # Get timestep data for each output.
+    model.sqlFile.get.execAndReturnVectorOfInt(query).get.each do |rdd_index|
+      #=================================================================================================================
+      # Get Name
+      query = "
+        SELECT Name
+        FROM ReportDataDictionary
+        WHERE ReportDataDictionaryIndex == #{rdd_index}
+      "
+      name = model.sqlFile.get.execAndReturnFirstString(query).get
+      #=================================================================================================================
+      # Get KeyValue
+      query = "
+        SELECT KeyValue
+        FROM ReportDataDictionary
+        WHERE ReportDataDictionaryIndex == #{rdd_index}
+      "
+      #=================================================================================================================
+      # In some cases KeyValue has a value and sometimes it does not.  In some cases KeyValue is null.  If the command
+      # below is run and KeyValue is null then the command fails and returns an error.  The fix below assumes that if
+      # the command below fails it is because KeyValue is null.  In that case the "key_value" variable is set to a
+      # blank.
+      begin
+        key_value = model.sqlFile.get.execAndReturnFirstString(query).get
+      rescue StandardError => bang
+        key_value = ""
+      end
+      #=================================================================================================================
+      # Get Units
+      query = "
+        SELECT Units
+        FROM ReportDataDictionary
+        WHERE ReportDataDictionaryIndex == #{rdd_index}
+      "
+      units = model.sqlFile.get.execAndReturnFirstString(query).get
+      #=================================================================================================================
+      # Get timestep data
+      query = "
+        Select VariableValue
+        FROM ReportVariableData
+        WHERE
+        ReportVariableDataDictionaryIndex = #{rdd_index}
+      "
+      timestep_values = model.sqlFile.get.execAndReturnVectorOfDouble(query).get
+
+      timestep_hash = Hash[timesteps_index.zip(timestep_values)]
+
+      data_hash = { "datapoint_id": datapoint_id, "Name": name, "KeyValue": key_value, "Units": units }.merge(timestep_hash)
+
+      array_of_hashes << data_hash
+
+      #=================================================================================================================
+      # Create a hash of data for having timesteps as rows instead of columns that is used for hourly outputs START
+      number_of_timesteps = timesteps_of_year.length()
+
+      array = [datapoint_id]
+      array_datapoint_id = array.zip(*[array]*number_of_timesteps).flatten
+      timestep_hash_datapoint_id = Hash[timesteps_index.zip(array_datapoint_id)]
+
+      array = [name]
+      array_name = array.zip(*[array]*number_of_timesteps).flatten
+      timestep_hash_name = Hash[timesteps_index.zip(array_name)]
+
+      array = [key_value]
+      array_key_value = array.zip(*[array]*number_of_timesteps).flatten
+      timestep_hash_key_value = Hash[timesteps_index.zip(array_key_value)]
+
+      array = [units]
+      array_units = array.zip(*[array]*number_of_timesteps).flatten
+      timestep_hash_units = Hash[timesteps_index.zip(array_units)]
+
+      timestep_hash_values = Hash[timesteps_index.zip(timestep_values)]
+
+      data_hash_transposed = Hash.new
+      timestep_hash_values.keys.each do |key|
+        data_hash_transposed[key] = [
+          timesteps_of_year_with_index[key],
+          timestep_hash_datapoint_id[key],
+          timestep_hash_name[key],
+          timestep_hash_key_value[key],
+          timestep_hash_units[key],
+          timestep_hash_values[key]
+        ]
+      end
+
+      array_of_hashes_transposed << data_hash_transposed
+      # Create a hash of data for having timesteps as rows instead of columns that is used for hourly outputs END
+      #=================================================================================================================
+
+    end #model.sqlFile.get.execAndReturnVectorOfInt(query).get.each do |rdd_index|
+    #===================================================================================================================
+    # # This csv file has timesteps as the first row
+    # CSV.open(csv_output, "wb") do |csv|
+    #   unless array_of_hashes.empty?
+    #     csv << array_of_hashes.first.keys # adds the attributes name on the first line
+    #     array_of_hashes.each do |hash|
+    #       csv << hash.values
+    #     end
+    #   end
+    # end
+    #===================================================================================================================
+    # This csv file has timesteps as the first column
+    header = ['Index', 'Timestep', 'datapoint_id', 'Name', 'KeyValue', 'Units', 'Value']
+    CSV.open(csv_output, "wb") do |csv|
+      csv << header
+      array_of_hashes_transposed.each do |hash|
+        hash.keys().each do |index|
+          row_index = index
+          row_timestep = hash[index][0]
+          row_datapoint_id = hash[index][1]
+          row_name = hash[index][2]
+          row_key_value = hash[index][3]
+          row_units = hash[index][4]
+          row_value = hash[index][5]
+
+          row = CSV::Row.new(header,[])
+          row['Index'] = row_index
+          row['Timestep'] = row_timestep
+          row['datapoint_id'] = row_datapoint_id
+          row['Name'] = row_name
+          row['KeyValue'] = row_key_value
+          row['Units'] = row_units
+          row['Value'] = row_value
+          csv << row
+        end
+      end
+    end
+    #===================================================================================================================
+  end #output_timestep_data
+  #=====================================================================================================================
+end