Merge pull request #55 from NREL/develop

v0.16.0 offgrid capability, bug fixes, name changes

Author: NLaws

CHANGELOG.md

@@ -1,5 +1,23 @@
 # REopt Changelog
 
+## v0.16.0
+Allows users to model "off-grid" systems as a year-long outage: 
+- add flag to "turn on" off-grid modeling `Settings.off_grid_flag` 
+- when `off_grid_flag` is "true", adjust default values in core/ `electric_storage`, `electric_load`, `financial`, `generator`, `pv` 
+- add operating reserve requirement inputs, outputs, and constraints based on load and PV generation 
+- add minimum load met percent input and constraint
+- add generator replacement year and cost (for off-grid and on-grid) 
+- add off-grid additional annual costs (tax deductible) and upfront capital costs (depreciable via straight line depreciation)
+
+Name changes: 
+- consistently append `_before_tax` and `_after_tax` to results names 
+- change all instances of `timestep` to `time_step` and `timesteps` to `time_steps`
+
+Other changes:
+- report previously missing lcc breakdown components, all reported in `results/financial.jl`  
+- change variable types from Float to Real to allow users to enter Ints (where applicable)
+- `year_one_coincident_peak_cost_after_tax` is now correctly multiplied by `(1 - p.s.financial.offtaker_tax_pct)`
+
 ## v0.15.2
 - bug fix for 15 & 30 minute electric, heating, and cooling loads
 - bug fix for URDB fixed charges
@@ -55,7 +73,7 @@
 - add ElectricLoad.blended_doe_reference_names & blended_doe_reference_percents
 - add ElectricLoad.monthly_totals_kwh builtin profile scaling
 - add ElectricTariff inputs: `add_monthly_rates_to_urdb_rate`, `tou_energy_rates_per_kwh`, 
-    `add_tou_energy_rates_to_urdb_rate`, `coincident_peak_load_charge_per_kw`, `coincident_peak_load_active_timesteps`
+    `add_tou_energy_rates_to_urdb_rate`, `coincident_peak_load_charge_per_kw`, `coincident_peak_load_active_time_steps`
 - handle multiple PV outputs
 
 ## v0.10.0
@@ -67,7 +85,7 @@
 - add option to run Business As Usual scenario in parallel with optimal scenario (default is `true`)
 - add incentives (and cost curves) to `Wind` and `Generator`
 - fixed bug in URDB fixed charges
-- renamed `outage_start(end)_timestep` to `outage_start(end)_time_step`
+- renamed `outage_start(end)_time_step` to `outage_start(end)_time_step`
 
 ## v0.9.0
 - `ElectricTariff.NEM` boolean is now determined by `ElectricUtility.net_metering_limit_kw` (true if limit > 0)
@@ -172,7 +190,7 @@
 #### bug fixes
 - allow non-integer `outage_probabilities`
 - correct `total_unserved_load` output
-- don't `add_min_hours_crit_ld_met_constraint` unless `min_resil_timesteps <= length(elecutil.outage_timesteps)`
+- don't `add_min_hours_crit_ld_met_constraint` unless `min_resil_time_steps <= length(elecutil.outage_time_steps)`
 
 ## v0.2.0
 #### Improvements
@@ -181,7 +199,7 @@
     - previously only had to pay to upgrade new capacity
 - implement ElectricLoad `loads_kw_is_net` and `critical_loads_kw_is_net`
     - add existing PV production to raw load profile if `true`
-- add `min_resil_timesteps` input and optional constraint for minimum timesteps that critical load must be met in every outage
+- add `min_resil_time_steps` input and optional constraint for minimum time_steps that critical load must be met in every outage
 #### bug fixes
 - enforce storage cannot grid charge
 

Project.toml

@@ -1,7 +1,7 @@
 name = "REopt"
 uuid = "d36ad4e8-d74a-4f7a-ace1-eaea049febf6"
 authors = ["Nick Laws <nick.laws@nrel.gov>"]
-version = "0.15.2"
+version = "0.16.0"
 
 [deps]
 ArchGDAL = "c9ce4bd3-c3d5-55b8-8973-c0e20141b8c3"

docs/src/developer/concept.md

@@ -18,7 +18,7 @@ The `max_kw` input value for any technology is considered to be the maximum _add
 The `min_kw` input value for any technology sets the lower bound on the capacity. If `min_kw` is non-zero then the model will be forced to choose at least that system size. The `min_kw` value is set equal to the `existing_kw` value in the Business As Usual scenario.
 
 # Business As Usual Scenario
-In order to calculate the Net Present Value of the optimal solution, as well as other baseline metrics, one can optionally run the Business As Usual (BAU) scenario. The option for running the BAU scenario in addition to the optimal scenario is in the [Settings](@ref). The default value for `Settings.run_bau` is `true` so that when an array of `JuMP.Model`s is provided to `run_reopt` the BAU scenario is also run. For example:
+In order to calculate the Net Present Value of the optimal solution, as well as other baseline metrics, one can optionally run the Business As Usual (BAU) scenario. When an array of `JuMP.Model`s is provided to `run_reopt` the BAU scenario is also run. For example:
 ```julia
 m1 = Model(optimizer_with_attributes(Xpress.Optimizer, "OUTPUTLOG" => 0))
 m2 = Model(optimizer_with_attributes(Xpress.Optimizer, "OUTPUTLOG" => 0))

docs/src/developer/inputs.md

@@ -51,7 +51,7 @@ techs_by_exportbin = Dict(
 ```
 A use-case example for the `techs_by_exportbin` map is defining the net metering benefit:
 ```julia
-NEM_benefit = @expression(m, p.pwf_e * p.hours_per_timestep *
+NEM_benefit = @expression(m, p.pwf_e * p.hours_per_time_step *
     sum( sum(p.s.electric_tariff.export_rates[:NEM][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :NEM, ts] 
         for t in p.techs_by_exportbin[:NEM]) for ts in p.time_steps)
 )

docs/src/mpc/inputs.md

@@ -132,7 +132,7 @@ Here is a more complex `MPCScenario`, which is used in [MPC Examples](@ref):
         "monthly_demand_rates": [10.0],
         "monthly_previous_peak_demands": [98.0],
         "tou_demand_rates": [0.0, 15.0],
-        "tou_demand_timesteps": [
+        "tou_demand_time_steps": [
             [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15], 
             [16, 17, 18, 19, 20, 21, 22, 23, 24]
         ],

docs/src/reopt/examples.md

@@ -20,9 +20,6 @@ results = run_reopt([m1,m2], "./scenarios/pv_storage.json")
 ```
 With the [BAUScenario](@ref) results we can calculate the net present value of the optimal system.
 
-!!! note
-    The `Settings.run_bau` is `true` by default and so there is no need to change the `run_bau` value in general since it is ignored when only one `JuMP.Model` is passed to the `run_reopt` method. We include the `run_bau` option to align with the REopt API Settings.
-
 ## Advanced
 
 ### Modifying the mathematical model

src/REopt.jl

@@ -64,8 +64,13 @@ using ArchGDAL
 using Roots: fzero  # for IRR
 global hdl = nothing
 
-const M3_TO_GAL = 264.172  # [gal/m^3]
-const GAL_DIESEL_TO_KWH = 40.7  # [kWh/gal_diesel]
+const EXISTING_BOILER_EFFICIENCY = 0.8
+
+const GAL_PER_M3 = 264.172  # [gal/m^3]
+const KWH_PER_GAL_DIESEL = 40.7  # [kWh/gal_diesel]
+const KWH_PER_MMBTU = 293.07107  # [kWh/mmbtu]
+const KWH_THERMAL_PER_TONHOUR = 3.51685
+const TONNE_PER_LB = 1/2204.62  # [tonne/lb]
 
 include("keys.jl")
 include("core/types.jl")
@@ -109,6 +114,7 @@ include("constraints/cost_curve_constraints.jl")
 include("constraints/production_incentive_constraints.jl")
 include("constraints/thermal_tech_constraints.jl")
 include("constraints/chp_constraints.jl")
+include("constraints/operating_reserve_constraints.jl")
 include("constraints/battery_degradation.jl")
 
 include("mpc/structs.jl")

src/constraints/battery_degradation.jl

@@ -40,7 +40,7 @@ end
 
 function constrain_degradation_variables(m, p; b="ElectricStorage")
     days = 1:365*p.s.financial.analysis_years
-    ts_per_day = 24 / p.hours_per_timestep
+    ts_per_day = 24 / p.hours_per_time_step
     ts_per_year = ts_per_day * 365
     for d in days
         ts0 = Int((ts_per_day * (d - 1) + 1) % ts_per_year)
@@ -53,13 +53,13 @@ function constrain_degradation_variables(m, p; b="ElectricStorage")
         )
         @constraint(m,
             m[:Eplus_sum][d] == 
-                p.hours_per_timestep * (
+                p.hours_per_time_step * (
                     sum(m[:dvProductionToStorage][b, t, ts] for t in p.techs.elec, ts in ts0:tsF) 
                     + sum(m[:dvGridToStorage][b, ts] for ts in ts0:tsF)
                 )
         )
         @constraint(m,
-            m[:Eminus_sum][d] == p.hours_per_timestep * sum(m[:dvDischargeFromStorage][b, ts] for ts in ts0:tsF)
+            m[:Eminus_sum][d] == p.hours_per_time_step * sum(m[:dvDischargeFromStorage][b, ts] for ts in ts0:tsF)
         )
         @constraint(m,
             m[:EFC][d] == (m[:Eplus_sum][d] + m[:Eminus_sum][d]) / 2
@@ -104,7 +104,7 @@ function add_degradation(m, p;
     constrain_degradation_variables(m, p, b=b)
 
     @constraint(m, [d in 2:days[end]],
-        SOH[d] == SOH[d-1] - p.hours_per_timestep * (
+        SOH[d] == SOH[d-1] - p.hours_per_time_step * (
             p.s.storage.attr[b].degradation.calendar_fade_coefficient * time_exponent * 
             m[:Eavg][d-1] * d^(time_exponent-1) + 
             p.s.storage.attr[b].degradation.cycle_fade_coefficient * m[:EFC][d-1]

src/constraints/chp_constraints.jl

@@ -35,7 +35,7 @@ function add_chp_fuel_burn_constraints(m, p; _n="")
     fuel_burn_intercept = fuel_burn_full_load - fuel_burn_slope * 1.0  # [kWt/kWe_rated]
 
     # Fuel cost
-    fuel_cost_per_kwh = p.s.chp.fuel_cost_per_mmbtu / MMBTU_TO_KWH
+    fuel_cost_per_kwh = p.s.chp.fuel_cost_per_mmbtu / KWH_PER_MMBTU
     fuel_cost_series = per_hour_value_to_time_series(fuel_cost_per_kwh, p.s.settings.time_steps_per_hour, 
                                                      "CHP.fuel_cost_per_mmbtu")
     m[:TotalCHPFuelCosts] = @expression(m, p.pwf_fuel["CHP"] *
@@ -48,7 +48,7 @@ function add_chp_fuel_burn_constraints(m, p; _n="")
 
         #Constraint (1c1): Total Fuel burn for CHP **with** y-intercept fuel burn and supplementary firing
         @constraint(m, CHPFuelBurnCon[t in p.techs.chp, ts in p.time_steps],
-            m[Symbol("dvFuelUsage"*_n)][t,ts]  == p.hours_per_timestep * (
+            m[Symbol("dvFuelUsage"*_n)][t,ts]  == p.hours_per_time_step * (
                 m[Symbol("dvFuelBurnYIntercept"*_n)][t,ts] +
                 p.production_factor[t,ts] * fuel_burn_slope * m[Symbol("dvRatedProduction"*_n)][t,ts] +
                 m[Symbol("dvSupplementaryThermalProduction"*_n)][t,ts] / p.s.chp.supplementary_firing_efficiency
@@ -62,7 +62,7 @@ function add_chp_fuel_burn_constraints(m, p; _n="")
     else
         #Constraint (1c2): Total Fuel burn for CHP **without** y-intercept fuel burn
         @constraint(m, CHPFuelBurnConLinear[t in p.techs.chp, ts in p.time_steps],
-            m[Symbol("dvFuelUsage"*_n)][t,ts]  == p.hours_per_timestep * (
+            m[Symbol("dvFuelUsage"*_n)][t,ts]  == p.hours_per_time_step * (
                 p.production_factor[t,ts] * fuel_burn_slope * m[Symbol("dvRatedProduction"*_n)][t,ts] +
                 m[Symbol("dvSupplementaryThermalProduction"*_n)][t,ts] / p.s.chp.supplementary_firing_efficiency
             )
@@ -184,7 +184,7 @@ function add_chp_hourly_om_charges(m, p; _n="")
     )
 
     m[:TotalHourlyCHPOMCosts] = @expression(m, p.third_party_factor * p.pwf_om * 
-    sum(m[Symbol(dv)][t, ts] * p.hours_per_timestep for t in p.techs.chp, ts in p.time_steps))
+    sum(m[Symbol(dv)][t, ts] * p.hours_per_time_step for t in p.techs.chp, ts in p.time_steps))
     nothing
 end
 
@@ -206,7 +206,7 @@ function add_chp_constraints(m, p; _n="")
     m[:TotalHourlyCHPOMCosts] = 0
     m[:TotalCHPFuelCosts] = 0
     m[:TotalCHPPerUnitProdOMCosts] = @expression(m, p.third_party_factor * p.pwf_om *
-        sum(p.s.chp.om_cost_per_kwh * p.hours_per_timestep *
+        sum(p.s.chp.om_cost_per_kwh * p.hours_per_time_step *
         m[:dvRatedProduction][t, ts] for t in p.techs.chp, ts in p.time_steps)
     )
 

src/constraints/electric_utility_constraints.jl

@@ -46,11 +46,11 @@ function add_export_constraints(m, p; _n="")
 
     if !isempty(NEM_techs)
         # Constraint (9c): Net metering only -- can't sell more than you purchase
-        # hours_per_timestep is cancelled on both sides, but used for unit consistency (convert power to energy)
+        # hours_per_time_step is cancelled on both sides, but used for unit consistency (convert power to energy)
         @constraint(m,
-            p.hours_per_timestep * sum( m[Symbol("dvProductionToGrid"*_n)][t, :NEM, ts] 
+            p.hours_per_time_step * sum( m[Symbol("dvProductionToGrid"*_n)][t, :NEM, ts] 
             for t in NEM_techs, ts in p.time_steps)
-            <= p.hours_per_timestep * sum( m[Symbol("dvGridPurchase"*_n)][ts, tier]
+            <= p.hours_per_time_step * sum( m[Symbol("dvGridPurchase"*_n)][ts, tier]
                 for ts in p.time_steps, tier in 1:p.s.electric_tariff.n_energy_tiers)
         )
 
@@ -60,12 +60,12 @@ function add_export_constraints(m, p; _n="")
             @constraint(m,
                 sum(m[Symbol("dvSize"*_n)][t] for t in NEM_techs) <= p.s.electric_utility.interconnection_limit_kw
             )
-            NEM_benefit = @expression(m, p.pwf_e * p.hours_per_timestep *
+            NEM_benefit = @expression(m, p.pwf_e * p.hours_per_time_step *
                 sum( sum(p.s.electric_tariff.export_rates[:NEM][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :NEM, ts] 
                     for t in p.techs_by_exportbin[:NEM]) for ts in p.time_steps)
             )
             if :EXC in p.s.electric_tariff.export_bins
-                EXC_benefit = @expression(m, p.pwf_e * p.hours_per_timestep *
+                EXC_benefit = @expression(m, p.pwf_e * p.hours_per_time_step *
                     sum( sum(p.s.electric_tariff.export_rates[:EXC][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :EXC, ts] 
                         for t in p.techs_by_exportbin[:EXC]) for ts in p.time_steps)
                 )
@@ -93,7 +93,7 @@ function add_export_constraints(m, p; _n="")
 
             # binary choice for NEM benefit
             @constraint(m,
-                binNEM => {NEM_benefit >= p.pwf_e * p.hours_per_timestep *
+                binNEM => {NEM_benefit >= p.pwf_e * p.hours_per_time_step *
                     sum( sum(p.s.electric_tariff.export_rates[:NEM][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :NEM, ts] 
                         for t in p.techs_by_exportbin[:NEM]) for ts in p.time_steps)
                 }
@@ -104,7 +104,7 @@ function add_export_constraints(m, p; _n="")
             if :EXC in p.s.electric_tariff.export_bins
                 EXC_benefit = @variable(m, lower_bound = max_bene)
                 @constraint(m,
-                    binNEM => {EXC_benefit >= p.pwf_e * p.hours_per_timestep *
+                    binNEM => {EXC_benefit >= p.pwf_e * p.hours_per_time_step *
                         sum( sum(p.s.electric_tariff.export_rates[:EXC][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :EXC, ts] 
                             for t in p.techs_by_exportbin[:EXC]) for ts in p.time_steps)
                     }
@@ -118,7 +118,7 @@ function add_export_constraints(m, p; _n="")
 
         if typeof(binNEM) <: Real  # no need for wholesale binary
             binWHL = 1
-            WHL_benefit = @expression(m, p.pwf_e * p.hours_per_timestep *
+            WHL_benefit = @expression(m, p.pwf_e * p.hours_per_time_step *
                 sum( sum(p.s.electric_tariff.export_rates[:WHL][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :WHL, ts] 
                         for t in p.techs_by_exportbin[:WHL]) for ts in p.time_steps)
             )
@@ -131,7 +131,7 @@ function add_export_constraints(m, p; _n="")
             @constraint(m, binNEM + binWHL == 1)  # can either NEM or WHL export, not both
 
             @constraint(m,
-                binWHL => {WHL_benefit >= p.pwf_e * p.hours_per_timestep *
+                binWHL => {WHL_benefit >= p.pwf_e * p.hours_per_time_step *
                     sum( sum(p.s.electric_tariff.export_rates[:WHL][ts] * m[Symbol("dvProductionToGrid"*_n)][t, :WHL, ts] 
                             for t in p.techs_by_exportbin[:WHL]) for ts in p.time_steps)
                 }
@@ -201,7 +201,7 @@ end
 
 function add_tou_peak_constraint(m, p; _n="")
     ## Constraint (12d): Ratchet peak demand is >= demand at each hour in the ratchet` 
-    @constraint(m, [r in p.ratchets, ts in p.s.electric_tariff.tou_demand_ratchet_timesteps[r]],
+    @constraint(m, [r in p.ratchets, ts in p.s.electric_tariff.tou_demand_ratchet_time_steps[r]],
         sum(m[Symbol("dvPeakDemandTOU"*_n)][r, tier] for tier in 1:p.s.electric_tariff.n_tou_demand_tiers) >= 
         sum(m[Symbol("dvGridPurchase"*_n)][ts, tier] for tier in 1:p.s.electric_tariff.n_energy_tiers)
     )
@@ -230,7 +230,7 @@ function add_tou_peak_constraint(m, p; _n="")
         )
 
         # Ratchet peak demand is >= demand at each hour in the ratchet
-        @constraint(m, [r in p.ratchets, ts in p.s.electric_tariff.tou_demand_ratchet_timesteps[r]],
+        @constraint(m, [r in p.ratchets, ts in p.s.electric_tariff.tou_demand_ratchet_time_steps[r]],
             sum(m[Symbol("dvPeakDemandTOU"*_n)][r, tier] for tier in 1:ntiers) 
             >= sum( m[Symbol("dvGridPurchase"*_n)][ts, tier] for tier in 1:p.s.electric_tariff.n_energy_tiers )
         )
@@ -275,7 +275,7 @@ function add_energy_tier_constraints(m, p; _n="")
     b = m[Symbol(dv)]
     ##Constraint (10a): Usage limits by pricing tier, by month
     @constraint(m, [mth in p.months, tier in 1:p.s.electric_tariff.n_energy_tiers],
-        p.hours_per_timestep * sum( m[Symbol("dvGridPurchase"*_n)][ts, tier] for ts in p.s.electric_tariff.time_steps_monthly[mth] ) 
+        p.hours_per_time_step * sum( m[Symbol("dvGridPurchase"*_n)][ts, tier] for ts in p.s.electric_tariff.time_steps_monthly[mth] ) 
         <= b[mth, tier] * p.s.electric_tariff.energy_tier_limits[tier]
     )
     ##Constraint (10b): Ordering of pricing tiers
@@ -347,12 +347,12 @@ end
 
 
 function add_coincident_peak_charge_constraints(m, p; _n="")
-	## Constraint (14a): in each coincident peak period, charged CP demand is the max of demand in all CP timesteps
+	## Constraint (14a): in each coincident peak period, charged CP demand is the max of demand in all CP time_steps
     dv = "dvPeakDemandCP" * _n
     m[Symbol(dv)] = @variable(m, [p.s.electric_tariff.coincpeak_periods], lower_bound = 0, base_name = dv)
 	@constraint(m, 
         [prd in p.s.electric_tariff.coincpeak_periods, 
-         ts in p.s.electric_tariff.coincident_peak_load_active_timesteps[prd]],
+         ts in p.s.electric_tariff.coincident_peak_load_active_time_steps[prd]],
 		m[Symbol("dvPeakDemandCP"*_n)][prd] >= sum(m[Symbol("dvGridPurchase"*_n)][ts, tier] 
                                                                       for tier in 1:p.s.electric_tariff.n_energy_tiers)
 	)
@@ -369,7 +369,7 @@ function add_elec_utility_expressions(m, p; _n="")
         m[Symbol("TotalExportBenefit"*_n)] = 0
     end
 
-    m[Symbol("TotalEnergyChargesUtil"*_n)] = @expression(m, p.pwf_e * p.hours_per_timestep * 
+    m[Symbol("TotalEnergyChargesUtil"*_n)] = @expression(m, p.pwf_e * p.hours_per_time_step * 
         sum( p.s.electric_tariff.energy_rates[ts, tier] * m[Symbol("dvGridPurchase"*_n)][ts, tier] 
             for ts in p.time_steps, tier in 1:p.s.electric_tariff.n_energy_tiers) 
     )