NREL-Sienna · jd-lara · Jun 24, 2024 · May 20, 2024 · May 20, 2024 · May 20, 2024
diff --git a/docs/src/api/PowerSimulations.md b/docs/src/api/PowerSimulations.md
@@ -7,7 +7,7 @@ end
 
 # API Reference
 
-### Table of Contents
+## Table of Contents
 
 * [Device Models](#Device-Models)
     * [Formulations](#Formulations)
@@ -42,7 +42,7 @@ end
 &nbsp;
 ```
 
-# Device Models
+## Device Models
 
 List of structures and methods for Device models
 
@@ -66,7 +66,7 @@ Refer to the [Problem Templates Page](@ref op_problem_template) for available `P
 
 ---
 
-# Decision Models
+## Decision Models
 
 ```@docs
 DecisionModel
@@ -83,7 +83,7 @@ solve!(::DecisionModel)
 
 ---
 
-# Emulation Models
+## Emulation Models
 
 ```@docs
 EmulationModel
@@ -100,7 +100,7 @@ run!(::EmulationModel)
 
 ---
 
-# Service Models
+## Service Models
 
 List of structures and methods for Service models
 
@@ -115,7 +115,7 @@ ServiceModel
 
 ---
 
-# Simulation Models
+## Simulation Models
 
 Refer to the [Simulations Page](@ref running_a_simulation) to explanations on how to setup a Simulation, with Sequencing and Feedforwards.
 
@@ -210,7 +210,7 @@ LowerBoundFeedForwardSlack
 
 ---
 
-# Constraints
+## Constraints
 
 ### Common Constraints
 
@@ -222,7 +222,6 @@ PieceWiseLinearCostConstraint
 ### Network Constraints
 
 ```@docs
-AreaDispatchBalanceConstraint
 CopperPlateBalanceConstraint
 NodalBalanceActiveConstraint
 NodalBalanceReactiveConstraint
@@ -292,7 +291,7 @@ FeedforwardLowerBoundConstraint
 
 ---
 
-# Parameters
+## Parameters
 
 ### Time Series Parameters
 

diff --git a/docs/src/formulation_library/Branch.md b/docs/src/formulation_library/Branch.md
@@ -39,7 +39,7 @@ If Slack variables are enabled:
 
 **Static Parameters**
 
-- ``R^\text{max}`` = `PowerSystems.get_rate(branch)`
+- ``R^\text{max}`` = `PowerSystems.get_rating(branch)`
 
 **Objective:**
 
@@ -80,7 +80,7 @@ StaticBranchBounds
 
 **Static Parameters**
 
-- ``R^\text{max}`` = `PowerSystems.get_rate(branch)`
+- ``R^\text{max}`` = `PowerSystems.get_rating(branch)`
 
 **Objective:**
 
@@ -308,7 +308,7 @@ PhaseAngleControl
 
 **Static Parameters**
 
-- ``R^\text{max}`` = `PowerSystems.get_rate(branch)`
+- ``R^\text{max}`` = `PowerSystems.get_rating(branch)`
 - ``\Theta^\text{min}`` = `PowerSystems.get_phase_angle_limits(branch).min`
 - ``\Theta^\text{max}`` = `PowerSystems.get_phase_angle_limits(branch).max`
 - ``X`` = `PowerSystems.get_x(branch)` (series reactance)

diff --git a/docs/src/formulation_library/Network.md b/docs/src/formulation_library/Network.md
@@ -7,8 +7,10 @@ Network formulations are used to describe how the network and buses are handled
 | `CopperPlatePowerModel` | Copper plate connection between all components, i.e. infinite transmission capacity |
 | `AreaBalancePowerModel` | Network model approximation to represent inter-area flow with each area represented as a single node |
 | `PTDFPowerModel` | Uses the PTDF factor matrix to compute the fraction of power transferred in the network across the branches |
+| `AreaPTDFPowerModel` | Uses the PTDF factor matrix to compute the fraction of power transferred in the network across the branches and balances power by Area instead of system-wide |
 
 [`PowerModels.jl`](https://github.com/lanl-ansi/PowerModels.jl) available formulations:
+
 - Exact non-convex models: `ACPPowerModel`, `ACRPowerModel`, `ACTPowerModel`.
 - Linear approximations: `DCPPowerModel`, `NFAPowerModel`.
 - Quadratic approximations: `DCPLLPowerModel`, `LPACCPowerModel`
@@ -28,10 +30,11 @@ CopperPlatePowerModel
 **Variables:**
 
 If Slack variables are enabled:
+
 - [`SystemBalanceSlackUp`](@ref):
   - Bounds: [0.0, ]
   - Default initial value: 0.0
-  - Default proportional cost: 1e6 
+  - Default proportional cost: 1e6
   - Symbol: ``p^\text{sl,up}``
 - [`SystemBalanceSlackDown`](@ref):
   - Bounds: [0.0, ]
@@ -66,20 +69,30 @@ AreaBalancePowerModel
 ```
 
 **Variables:**
+If Slack variables are enabled:
 
-Slack variables are not supported for `AreaBalancePowerModel`
+- [`SystemBalanceSlackUp`](@ref) by area:
+  - Bounds: [0.0, ]
+  - Default initial value: 0.0
+  - Default proportional cost: 1e6
+  - Symbol: ``p^\text{sl,up}``
+- [`SystemBalanceSlackDown`](@ref) by area:
+  - Bounds: [0.0, ]
+  - Default initial value: 0.0
+  - Default proportional cost: 1e6
+  - Symbol: ``p^\text{sl,dn}``
 
 **Objective:**
 
-No changes to the objective function.
+Adds ``p^\text{sl,up}`` and ``p^\text{sl,dn}`` terms to the respective active power balance expressions `ActivePowerBalance` per area.
 
 **Expressions:**
 
-Creates `ActivePowerBalance` expressions for each bus that then are used to balance active power for all buses within a single area.
+Creates `ActivePowerBalance` expressions for each area that then are used to balance active power for all buses within a single area.
 
 **Constraints:**
 
-Adds the `AreaDispatchBalanceConstraint` to balance the active power of all components available in an area.
+Adds the `CopperPlateBalanceConstraint` to balance the active power of all components available in an area.
 
 ```math
 \begin{align}
@@ -98,10 +111,11 @@ PTDFPowerModel
 **Variables:**
 
 If Slack variables are enabled:
+
 - [`SystemBalanceSlackUp`](@ref):
   - Bounds: [0.0, ]
   - Default initial value: 0.0
-  - Default proportional cost: 1e6 
+  - Default proportional cost: 1e6
   - Symbol: ``p^\text{sl,up}``
 - [`SystemBalanceSlackDown`](@ref):
   - Bounds: [0.0, ]
@@ -128,4 +142,3 @@ Adds the `CopperPlateBalanceConstraint` to balance the active power of all compo
 ```
 
 In addition creates `NodalBalanceActiveConstraint` for HVDC buses balance, if DC components are connected to an HVDC network.
-
diff --git a/docs/src/formulation_library/Service.md b/docs/src/formulation_library/Service.md
@@ -46,7 +46,7 @@ Depending on the `PowerSystems.jl` type associated to the `RangeReserve` formula
 
 - ``\text{PF}`` = `PowerSystems.get_max_participation_factor(service)`
 
-For a `StaticReserve` `PowerSystems` type:
+For a `ConstantReserve` `PowerSystems` type:
 - ``\text{Req}`` = `PowerSystems.get_requirement(service)`
 
 **Time Series Parameters** 
@@ -94,14 +94,14 @@ similarly if ``s_3`` is a `ReserveDown` service (e.g. Reg-Down):
 A RangeReserve implements two fundamental constraints. The first is that the sum of all reserves of contributing devices must be larger than the `RangeReserve` requirement. Thus, for a service ``s``:
 
 ```math
-\sum_{d\in\mathcal{D}_s} r_{d,t} + r_t^\text{sl} \ge \text{Req},\quad \forall t\in \{1,\dots, T\} \quad \text{(for a StaticReserve)} \\
+\sum_{d\in\mathcal{D}_s} r_{d,t} + r_t^\text{sl} \ge \text{Req},\quad \forall t\in \{1,\dots, T\} \quad \text{(for a ConstantReserve)} \\
 \sum_{d\in\mathcal{D}_s} r_{d,t} + r_t^\text{sl} \ge \text{RequirementTimeSeriesParameter}_{t},\quad \forall t\in \{1,\dots, T\} \quad \text{(for a VariableReserve)}
 ```
 
 In addition, there is a restriction on how much each contributing device ``d`` can contribute to the requirement, based on the max participation factor allowed.
 
 ```math
-r_{d,t} \le \text{Req} \cdot \text{PF} ,\quad \forall d\in \mathcal{D}_s, \forall t\in \{1,\dots, T\} \quad \text{(for a StaticReserve)} \\
+r_{d,t} \le \text{Req} \cdot \text{PF} ,\quad \forall d\in \mathcal{D}_s, \forall t\in \{1,\dots, T\} \quad \text{(for a ConstantReserve)} \\
 r_{d,t} \le \text{RequirementTimeSeriesParameter}_{t} \cdot \text{PF}\quad  \forall d\in \mathcal{D}_s, \forall t\in \{1,\dots, T\}, \quad \text{(for a VariableReserve)}
 ```
 
@@ -176,7 +176,7 @@ A `StepwiseCostReserve` implements a single constraint, such that the sum of all
 
 ## `GroupReserve`
 
-Service must be used with `StaticReserveGroup` `PowerSystems.jl` type. This service model is used to model an aggregation of services.
+Service must be used with `ConstantReserveGroup` `PowerSystems.jl` type. This service model is used to model an aggregation of services.
 
 ```@docs
 GroupReserve

diff --git a/docs/src/modeler_guide/read_results.md b/docs/src/modeler_guide/read_results.md
@@ -4,14 +4,14 @@ Once a `DecisionModel` is solved via `solve!(model)` or a Simulation is executed
 
 ## Read results of a Decision Problem
 
-Once a `DecisionModel` is solved, results are accessed using `ProblemResults(model)` as follows:
+Once a `DecisionModel` is solved, results are accessed using `OptimizationProblemResults(model)` as follows:
 
 ```julia
 # The DecisionModel is already constructed
 build!(model, output_dir = mktempdir())
 solve!(model)
 
-results = ProblemResults(model)
+results = OptimizationProblemResults(model)
 ```
 
 The output will showcase the available expressions, parameters and variables to read. For example it will look like:
@@ -40,7 +40,7 @@ PowerSimulations Problem Duals Results
 
 PowerSimulations Problem Parameters Results
 ┌────────────────────────────────────────────────────────────────────────┐
-│ ActivePowerTimeSeriesParameter__RenewableFix                           │
+│ ActivePowerTimeSeriesParameter__RenewableNonDispatch                           │
 │ RenewablePowerTimeSeries__HybridSystem                                 │
 │ RequirementTimeSeriesParameter__VariableReserve__ReserveUp__Spin_Up_R3 │
 │ RequirementTimeSeriesParameter__VariableReserve__ReserveUp__Reg_Up     │

diff --git a/docs/src/tutorials/adding_new_problem_model.md b/docs/src/tutorials/adding_new_problem_model.md
@@ -62,7 +62,7 @@ my_model = DecisionModel{MyCustomDecisionProblem}(
 These methods can be defined optionally for your problem. By default for problems subtyped from `DecisionProblem` these checks are not executed. If the problems are subtyped from `DefaultDecisionProblem` these checks are always conducted with PowerSimulations defaults and require compliance with those defaults to pass. In any case, these can be overloaded when necessary depending on the problem requirements.
 
 1. `validate_template`
-2. `validate_time_series`
+2. `validate_time_series!`
 3. `reset!`
 4. `solve_impl!`
 

diff --git a/docs/src/tutorials/decision_problem.md b/docs/src/tutorials/decision_problem.md
@@ -59,14 +59,14 @@ Here we define template entries for all devices that inject or withdraw power on
 network. For each device type, we can define a distinct `AbstractDeviceFormulation`. In
 this case, we're defining a basic unit commitment model for thermal generators,
 curtailable renewable generators, and fixed dispatch (net-load reduction) formulations
-for `HydroDispatch` and `RenewableFix` devices.
+for `HydroDispatch` and `RenewableNonDispatch` devices.
 
 ```@example op_problem
 set_device_model!(template_uc, ThermalStandard, ThermalStandardUnitCommitment)
 set_device_model!(template_uc, RenewableDispatch, RenewableFullDispatch)
 set_device_model!(template_uc, PowerLoad, StaticPowerLoad)
 set_device_model!(template_uc, HydroDispatch, HydroDispatchRunOfRiver)
-set_device_model!(template_uc, RenewableFix, FixedOutput)
+set_device_model!(template_uc, RenewableNonDispatch, FixedOutput)
 ```
 
 ### Service Formulations

diff --git a/docs/src/tutorials/pcm_simulation.md b/docs/src/tutorials/pcm_simulation.md
@@ -244,7 +244,7 @@ problem definition), we can use:
 ```@example pcm
 read_parameter(
     ed_results,
-    "ActivePowerTimeSeriesParameter__RenewableFix",
+    "ActivePowerTimeSeriesParameter__RenewableNonDispatch",
     initial_time = DateTime("2020-01-01T06:00:00"),
     count = 5,
 )

diff --git a/src/PowerSimulations.jl b/src/PowerSimulations.jl
@@ -21,6 +21,7 @@ export NetworkModel
 export PTDFPowerModel
 export CopperPlatePowerModel
 export AreaBalancePowerModel
+export AreaPTDFPowerModel
 
 ######## Device Models ########
 export DeviceModel
@@ -112,7 +113,6 @@ export run_parallel_simulation
 ## Template Exports
 export template_economic_dispatch
 export template_unit_commitment
-export template_agc_reserve_deployment
 export EconomicDispatchProblem
 export UnitCommitmentProblem
 export AGCReserveDeployment
@@ -239,10 +239,10 @@ export PowerOutput
 
 # Constraints
 export AbsoluteValueConstraint
+export LineFlowBoundConstraint
 export ActivePowerVariableLimitsConstraint
 export ActivePowerVariableTimeSeriesLimitsConstraint
 export ActiveRangeICConstraint
-export AreaDispatchBalanceConstraint
 export AreaParticipationAssignmentConstraint
 export BalanceAuxConstraint
 export CommitmentConstraint
@@ -553,12 +553,13 @@ include("devices_models/devices/renewable_generation.jl")
 include("devices_models/devices/thermal_generation.jl")
 include("devices_models/devices/electric_loads.jl")
 include("devices_models/devices/AC_branches.jl")
+include("devices_models/devices/area_interchange.jl")
 include("devices_models/devices/TwoTerminalDC_branches.jl")
 include("devices_models/devices/HVDCsystems.jl")
-include("devices_models/devices/regulation_device.jl")
+#include("devices_models/devices/regulation_device.jl")
 
 # Services Models
-include("services_models/agc.jl")
+#include("services_models/agc.jl")
 include("services_models/reserves.jl")
 include("services_models/reserve_group.jl")
 include("services_models/transmission_interface.jl")
@@ -582,7 +583,7 @@ include("devices_models/device_constructors/hvdcsystems_constructor.jl")
 include("devices_models/device_constructors/branch_constructor.jl")
 include("devices_models/device_constructors/renewablegeneration_constructor.jl")
 include("devices_models/device_constructors/load_constructor.jl")
-include("devices_models/device_constructors/regulationdevice_constructor.jl")
+#include("devices_models/device_constructors/regulationdevice_constructor.jl")
 
 # Network constructors
 include("network_models/network_constructor.jl")