Class: URBANopt::REopt::FeatureReportAdapter
- Inherits:
-
Object
- Object
- URBANopt::REopt::FeatureReportAdapter
- Defined in:
- lib/urbanopt/reopt/feature_report_adapter.rb
Instance Method Summary collapse
-
#initialize ⇒ FeatureReportAdapter
constructor
FeatureReportAdapter can convert a URBANopt::Scenario::DefaultReports::FeatureReport into a REopt Lite posts or update a URBANopt::Scenario::DefaultReports::FeatureReport from a REopt Lite response.
-
#modrow(x, i) ⇒ Object
:nodoc:.
-
#reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil) ⇒ Object
Convert a FeatureReport into a REopt Lite post.
-
#update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil) ⇒ Object
Update a FeatureReport from a REopt Lite response.
Constructor Details
#initialize ⇒ FeatureReportAdapter
FeatureReportAdapter can convert a URBANopt::Scenario::DefaultReports::FeatureReport into a REopt Lite posts or update a URBANopt::Scenario::DefaultReports::FeatureReport from a REopt Lite response.
- parameters:
44 45 46 47 |
# File 'lib/urbanopt/reopt/feature_report_adapter.rb', line 44 def initialize # initialize @@logger @@logger ||= URBANopt::REopt.reopt_logger end |
Instance Method Details
#modrow(x, i) ⇒ Object
:nodoc:
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/urbanopt/reopt/feature_report_adapter.rb', line 325 def modrow(x, i) # :nodoc: x[$generation_timeseries_kwh_col] = $generation_timeseries_kwh[i] || 0 x[$load_col] = $load[i] || 0 x[$utility_to_load_col] = $utility_to_load[i] || 0 x[$utility_to_battery_col] = $utility_to_battery[i] || 0 x[$storage_to_load_col] = $storage_to_load[i] || 0 x[$storage_to_grid_col] = $storage_to_grid[i] || 0 x[$storage_soc_col] = $storage_soc[i] || 0 x[$generator_total_col] = $generator_total[i] || 0 x[$generator_to_battery_col] = $generator_to_battery[i] || 0 x[$generator_to_load_col] = $generator_to_load[i] || 0 x[$generator_to_grid_col] = $generator_to_grid[i] || 0 x[$pv_total_col] = $pv_total[i] || 0 x[$pv_to_battery_col] = $pv_to_battery[i] || 0 x[$pv_to_load_col] = $pv_to_load[i] || 0 x[$pv_to_grid_col] = $pv_to_grid[i] || 0 x[$wind_total_col] = $wind_total[i] || 0 x[$wind_to_battery_col] = $wind_to_battery[i] || 0 x[$wind_to_load_col] = $wind_to_load[i] || 0 x[$wind_to_grid_col] = $wind_to_grid[i] || 0 return x end |
#reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil) ⇒ Object
Convert a FeatureReport into a REopt Lite post
- parameters:
-
feature_report
- URBANopt::Scenario::DefaultReports::FeatureReport - FeatureReport to use in converting the optionalreopt_assumptions_hash
to a REopt Lite post. If areopt_assumptions_hash
is not provided, a default post will be updated from this FeatureReport and submitted to the REopt Lite API. -
reopt_assumptions_hash
- Hash - Optional. A hash formatted for submittal to the REopt Lite API containing default values. Values will be overwritten from the FeatureReport where available (i.e. latitude, roof_squarefeet). Missing optional parameters will be filled in with default values by the API.
- return:
-
Hash - Returns hash formatted for submittal to the REopt Lite API
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/urbanopt/reopt/feature_report_adapter.rb', line 59 def reopt_json_from_feature_report(feature_report, reopt_assumptions_hash = nil) name = feature_report.name.delete ' ' description = "feature_report_#{name}_#{feature_report.id}" reopt_inputs = { Scenario: { Site: { ElectricTariff: { blended_monthly_demand_charges_us_dollars_per_kw: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0], blended_monthly_rates_us_dollars_per_kwh: [0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13, 0.13] }, LoadProfile: {}, Wind: { max_kw: 0 } } } } if !reopt_assumptions_hash.nil? reopt_inputs = reopt_assumptions_hash else @@logger.info('Using default REopt Lite assumptions') end # Check FeatureReport has required data requireds_names = ['latitude', 'longitude'] requireds = [feature_report.location.latitude, feature_report.location.longitude] if requireds.include?(nil) || requireds.include?(0) requireds.each_with_index do |i, x| if [nil, 0].include? x n = requireds_names[i] p 'a' # @@logger.error("Missing value for #{n} - this is a required input") raise "Missing value for #{n} - this is a required input" end end end reopt_inputs[:Scenario][:description] = description # Parse Location reopt_inputs[:Scenario][:Site][:latitude] = feature_report.location.latitude reopt_inputs[:Scenario][:Site][:longitude] = feature_report.location.longitude # Parse Optional FeatureReport metrics unless feature_report.program.roof_area.nil? reopt_inputs[:Scenario][:Site][:roof_squarefeet] = feature_report.program.roof_area[:available_roof_area] end unless feature_report.program.site_area.nil? reopt_inputs[:Scenario][:Site][:land_acres] = feature_report.program.site_area * 1.0 / 43560 # acres/sqft end # Parse Load Profile begin col_num = feature_report.timeseries_csv.column_names.index('Electricity:Facility') t = CSV.read(feature_report.timeseries_csv.path, headers: true, converters: :numeric) energy_timeseries_kwh = t.by_col[col_num].map { |e| ((e || 0) * 0.293071) } # convert kBTU to KWH if (feature_report.timesteps_per_hour || 1) > 1 energy_timeseries_kwh = energy_timeseries_kwh.each_slice(feature_report.timesteps_per_hour).to_a.map { |x| x.inject(0, :+) / x.length.to_f } end if energy_timeseries_kwh.length < feature_report.timesteps_per_hour * 8760 energy_timeseries_kwh += [0] * ((feature_report.timesteps_per_hour * 8760) - energy_timeseries_kwh.length) @@logger.info("Assuming load profile for Feature Report #{feature_report.name} #{feature_report.id} starts January 1 - filling in rest with zeros") end reopt_inputs[:Scenario][:Site][:LoadProfile][:loads_kw] = energy_timeseries_kwh.map { |e| e ? e : 0 } rescue StandardError @@logger.error("Could not parse the annual electric load from the timeseries csv - #{feature_report.timeseries_csv.path}") raise "Could not parse the annual electric load from the timeseries csv - #{feature_report.timeseries_csv.path}" end return reopt_inputs end |
#update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil) ⇒ Object
Update a FeatureReport from a REopt Lite response
- parameters:
-
feature_report
- URBANopt::Scenario::DefaultReports::FeatureReport - FeatureReport to update from a REopt Lite reponse hash. -
reopt_output
- Hash - A reponse hash from the REopt Lite API to use in overwriting FeatureReport technology sizes, costs and dispatch strategies. -
timeseries_csv_path
- String - Optional. The path to a file at which a new timeseries CSV will be written. If not provided a file is created based on the run_uuid of the REopt Lite optimization task.
- return:
-
URBANopt::Scenario::DefaultReports::FeatureReport - Returns an updated FeatureReport.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/urbanopt/reopt/feature_report_adapter.rb', line 130 def update_feature_report(feature_report, reopt_output, timeseries_csv_path = nil) # Check if the \REopt Lite response is valid if reopt_output['outputs']['Scenario']['status'] != 'optimal' @@logger.info("Warning cannot Feature Report #{feature_report.name} #{feature_report.id} - REopt optimization was non-optimal") return feature_report end # Update location feature_report.location.latitude = reopt_output['inputs']['Scenario']['Site']['latitude'] feature_report.location.longitude = reopt_output['inputs']['Scenario']['Site']['longitude'] # Update timeseries csv from \REopt Lite dispatch data feature_report.timesteps_per_hour = reopt_output['inputs']['Scenario']['time_steps_per_hour'] # Update distributed generation sizing and financials (feature_report.distributed_generation.lcc_us_dollars = reopt_output['outputs']['Scenario']['Site']['Financial']['lcc_us_dollars']) || 0 (feature_report.distributed_generation.npv_us_dollars = reopt_output['outputs']['Scenario']['Site']['Financial']['npv_us_dollars']) || 0 (feature_report.distributed_generation.year_one_energy_cost_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_energy_cost_us_dollars']) || 0 (feature_report.distributed_generation.year_one_demand_cost_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_demand_cost_us_dollars']) || 0 (feature_report.distributed_generation.year_one_bill_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_bill_us_dollars']) || 0 (feature_report.distributed_generation.total_energy_cost_us_dollars = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['total_energy_cost_us_dollars']) || 0 (feature_report.distributed_generation.solar_pv.size_kw = reopt_output['outputs']['Scenario']['Site']['PV']['size_kw']) || 0 (feature_report.distributed_generation.wind.size_kw = reopt_output['outputs']['Scenario']['Site']['Wind']['size_kw']) || 0 (feature_report.distributed_generation.generator.size_kw = reopt_output['outputs']['Scenario']['Site']['Generator']['size_kw']) || 0 (feature_report.distributed_generation.storage.size_kw = reopt_output['outputs']['Scenario']['Site']['Storage']['size_kw']) || 0 (feature_report.distributed_generation.storage.size_kwh = reopt_output['outputs']['Scenario']['Site']['Storage']['size_kwh']) || 0 generation_timeseries_kwh = Matrix[[0] * 8760] unless reopt_output['outputs']['Scenario']['Site']['PV'].nil? if (reopt_output['outputs']['Scenario']['Site']['PV']['size_kw'] || 0) > 0 if !reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw'].nil? generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw']] end end end # unless reopt_output['outputs']['Scenario']['Site']['Storage'].nil? # if (reopt_output['outputs']['Scenario']['Site']['Storage']['size_kw'] or 0) > 0 # if !reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw'].nil? # generation_timeseries_kwh = generation_timeseries_kwh + Matrix[reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw']] # end # end # end unless reopt_output['outputs']['Scenario']['Site']['Wind'].nil? if (reopt_output['outputs']['Scenario']['Site']['Wind']['size_kw'] || 0) > 0 if !reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw'].nil? generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw']] end end end unless reopt_output['outputs']['Scenario']['Site']['Generator'].nil? if (reopt_output['outputs']['Scenario']['Site']['Generator']['size_kw'] || 0) > 0 if !reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw'].nil? generation_timeseries_kwh += Matrix[reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw']] end end end $generation_timeseries_kwh = generation_timeseries_kwh.to_a[0] || [0] * 8760 $generation_timeseries_kwh_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Total') if $generation_timeseries_kwh_col.nil? $generation_timeseries_kwh_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Total') end $load = reopt_output['outputs']['Scenario']['Site']['LoadProfile']['year_one_electric_load_series_kw'] || [0] * 8760 $load_col = feature_report.timeseries_csv.column_names.index('Electricity:Load:Total') if $load_col.nil? $load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Load:Total') end $utility_to_load = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_to_load_series_kw'] || [0] * 8760 $utility_to_load_col = feature_report.timeseries_csv.column_names.index('Electricity:Grid:ToLoad') if $utility_to_load_col.nil? $utility_to_load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Grid:ToLoad') end $utility_to_battery = reopt_output['outputs']['Scenario']['Site']['ElectricTariff']['year_one_to_battery_series_kw'] || [0] * 8760 $utility_to_battery_col = feature_report.timeseries_csv.column_names.index('Electricity:Grid:ToBattery') if $utility_to_battery_col.nil? $utility_to_battery_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Grid:ToBattery') end $storage_to_load = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_load_series_kw'] || [0] * 8760 $storage_to_load_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:ToLoad') if $storage_to_load_col.nil? $storage_to_load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Storage:ToLoad') end $storage_to_grid = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_to_grid_series_kw'] || [0] * 8760 $storage_to_grid_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:ToGrid') if $storage_to_grid_col.nil? $storage_to_grid_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Storage:ToGrid') end $storage_soc = reopt_output['outputs']['Scenario']['Site']['Storage']['year_one_soc_series_pct'] || [0] * 8760 $storage_soc_col = feature_report.timeseries_csv.column_names.index('Electricity:Storage:StateOfCharge') if $storage_soc_col.nil? $storage_soc_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('Electricity:Storage:StateOfCharge') end $generator_total = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_power_production_series_kw'] || [0] * 8760 $generator_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:Total') if $generator_total_col.nil? $generator_total_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:Total') end $generator_to_battery = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_battery_series_kw'] || [0] * 8760 $generator_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToBattery') if $generator_to_battery_col.nil? $generator_to_battery_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToBattery') end $generator_to_load = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_load_series_kw'] || [0] * 8760 $generator_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToLoad') if $generator_to_load_col.nil? $generator_to_load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToLoad') end $generator_to_grid = reopt_output['outputs']['Scenario']['Site']['Generator']['year_one_to_grid_series_kw'] || [0] * 8760 $generator_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Generator:ToGrid') if $generator_to_grid_col.nil? $generator_to_grid_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Generator:ToGrid') end $pv_total = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_power_production_series_kw'] || [0] * 8760 $pv_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:Total') if $pv_total_col.nil? $pv_total_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:Total') end $pv_to_battery = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_battery_series_kw'] || [0] * 8760 $pv_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToBattery') if $pv_to_battery_col.nil? $pv_to_battery_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToBattery') end $pv_to_load = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_load_series_kw'] || [0] * 8760 $pv_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToLoad') if $pv_to_load_col.nil? $pv_to_load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToLoad') end $pv_to_grid = reopt_output['outputs']['Scenario']['Site']['PV']['year_one_to_grid_series_kw'] || [0] * 8760 $pv_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:PV:ToGrid') if $pv_to_grid_col.nil? $pv_to_grid_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:PV:ToGrid') end $wind_total = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_power_production_series_kw'] || [0] * 8760 $wind_total_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:Total') if $wind_total_col.nil? $wind_total_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:Total') end $wind_to_battery = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_battery_series_kw'] || [0] * 8760 $wind_to_battery_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToBattery') if $wind_to_battery_col.nil? $wind_to_battery_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToBattery') end $wind_to_load = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_load_series_kw'] || [0] * 8760 $wind_to_load_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToLoad') if $wind_to_load_col.nil? $wind_to_load_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToLoad') end $wind_to_grid = reopt_output['outputs']['Scenario']['Site']['Wind']['year_one_to_grid_series_kw'] || [0] * 8760 $wind_to_grid_col = feature_report.timeseries_csv.column_names.index('ElectricityProduced:Wind:ToGrid') if $wind_to_grid_col.nil? $wind_to_grid_col = feature_report.timeseries_csv.column_names.length feature_report.timeseries_csv.column_names.push('ElectricityProduced:Wind:ToGrid') end def modrow(x, i) # :nodoc: x[$generation_timeseries_kwh_col] = $generation_timeseries_kwh[i] || 0 x[$load_col] = $load[i] || 0 x[$utility_to_load_col] = $utility_to_load[i] || 0 x[$utility_to_battery_col] = $utility_to_battery[i] || 0 x[$storage_to_load_col] = $storage_to_load[i] || 0 x[$storage_to_grid_col] = $storage_to_grid[i] || 0 x[$storage_soc_col] = $storage_soc[i] || 0 x[$generator_total_col] = $generator_total[i] || 0 x[$generator_to_battery_col] = $generator_to_battery[i] || 0 x[$generator_to_load_col] = $generator_to_load[i] || 0 x[$generator_to_grid_col] = $generator_to_grid[i] || 0 x[$pv_total_col] = $pv_total[i] || 0 x[$pv_to_battery_col] = $pv_to_battery[i] || 0 x[$pv_to_load_col] = $pv_to_load[i] || 0 x[$pv_to_grid_col] = $pv_to_grid[i] || 0 x[$wind_total_col] = $wind_total[i] || 0 x[$wind_to_battery_col] = $wind_to_battery[i] || 0 x[$wind_to_load_col] = $wind_to_load[i] || 0 x[$wind_to_grid_col] = $wind_to_grid[i] || 0 return x end old_data = CSV.open(feature_report.timeseries_csv.path).read mod_data = old_data.map.with_index do |x, i| if i > 0 modrow(x, i) else x end end mod_data[0] = feature_report.timeseries_csv.column_names feature_report.timeseries_csv.reload_data(mod_data) return feature_report end |