Massive update documentation for PowerSimulations

Project.toml

@@ -1,7 +1,7 @@
 name = "PowerSimulations"
 uuid = "e690365d-45e2-57bb-ac84-44ba829e73c4"
 authors = ["Jose Daniel Lara", "Clayton Barrows", "Daniel Thom", "Dheepak Krishnamurthy", "Sourabh Dalvi"]
-version = "0.27.7"
+version = "0.27.8"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

docs/make.jl

@@ -15,9 +15,9 @@ pages = OrderedDict(
         "modeler_guide/psi_structure.md",
         "modeler_guide/problem_templates.md",
         "modeler_guide/running_a_simulation.md",
+        "modeler_guide/read_results.md",
         "modeler_guide/simulation_recorder.md",
         "modeler_guide/logging.md",
-        "modeler_guide/tips_and_tricks.md",
         "modeler_guide/debugging_infeasible_models.md",
         "modeler_guide/parallel_simulations.md",
         "modeler_guide/modeling_faq.md",
@@ -31,12 +31,16 @@ pages = OrderedDict(
         "Troubleshooting" => "code_base_developer_guide/troubleshooting.md",
     ],
     "Formulation Library" => Any[
+        "Introduction" => "formulation_library/Introduction.md",
         "General" => "formulation_library/General.md",
+        "Network" => "formulation_library/Network.md",
         "Thermal Generation" => "formulation_library/ThermalGen.md",
         "Renewable Generation" => "formulation_library/RenewableGen.md",
         "Load" => "formulation_library/Load.md",
-        "Network" => "formulation_library/Network.md",
         "Branch" => "formulation_library/Branch.md",
+        "Services" => "formulation_library/Service.md",
+        "Feedforwards" => "formulation_library/Feedforward.md",
+        "Piecewise Linear Cost" => "formulation_library/Piecewise.md",
     ],
     "API Reference" => "api/PowerSimulations.md",
 )

docs/src/api/PowerSimulations.md

@@ -9,14 +9,38 @@ end
 
 ### Table of Contents
 
-1. [Device Models](#device-models)
-2. [Decision Models](#decision-models)
-3. [Emulation Models](#emulation-models)
-4. [Service Models](#service-models)
-5. [Simulation Models](#simulation-models)
-6. [Variables](#variables)
-7. [Constraints](#constraints)
-8. [Parameters](#parameters)
+* [Device Models](#Device-Models)
+    * [Formulations](#Formulations)
+    * [Problem Templates](#Problem-Templates)
+* [Decision Models](#Decision-Models)
+* [Emulation Models](#Emulation-Models)
+* [Service Models](#Service-Models)
+* [Simulation Models](#Simulation-Models)
+* [Variables](#Variables)
+    * [Common Variables](#Common-Variables)
+    * [Thermal Unit Variables](#Thermal-Unit-Variables)
+    * [Storage Unit Variables](#Storage-Unit-Variables)
+    * [Branches and Network Variables](#Branches-and-Network-Variables)
+    * [Services Variables](#Services-Variables)
+    * [Feedforward Variables](#Feedforward-Variables)
+* [Constraints](#Constraints)
+    * [Common Constraints](#Common-Constraints)
+    * [Network Constraints](#Network-Constraints)
+    * [Power Variable Limit Constraints](#Power-Variable-Limit-Constraints)
+    * [Services Constraints](#Services-Constraints)
+    * [Thermal Unit Constraints](#Thermal-Unit-Constraints)
+    * [Renewable Unit Constraints](#Renewable-Unit-Constraints)
+    * [Branches Constraints](#Branches-Constraints)
+    * [Feedforward Constraints](#Feedforward-Constraints)
+* [Parameters](#Parameters)
+    * [Time Series Parameters](#Time-Series-Parameters)
+    * [Variable Value Parameters](#Variable-Value-Parameters)
+    * [Objective Function Parameters](#Objective-Function-Parameters)
+
+```@raw html
+ 
+ 
+```
 
 # Device Models
 
@@ -34,22 +58,13 @@ Refer to the [Formulations Page](@ref formulation_library) for each Abstract Dev
 
 Refer to the [Problem Templates Page](@ref op_problem_template) for available `ProblemTemplate`s.
 
-### Problem Templates
-
-Refer to the [Problem Templates Page](https://nrel-siip.github.io/PowerSimulations.jl/latest/modeler_guide/problem_templates/) for available `ProblemTemplate`s.
 
 ```@raw html
  
  
 ```
 
-# Service Models
-
-List of structures and methods for Service models
-
-```@docs
-ServiceModel
-```
+---
 
 # Decision Models
 
@@ -66,6 +81,8 @@ solve!(::DecisionModel)
  
 ```
 
+---
+
 # Emulation Models
 
 ```@docs
@@ -81,6 +98,23 @@ run!(::EmulationModel)
  
 ```
 
+---
+
+# Service Models
+
+List of structures and methods for Service models
+
+```@docs
+ServiceModel
+```
+
+```@raw html
+ 
+ 
+```
+
+---
+
 # Simulation Models
 
 Refer to the [Simulations Page](@ref running_a_simulation) to explanations on how to setup a Simulation, with Sequencing and Feedforwards.
@@ -99,6 +133,8 @@ execute!(::Simulation)
  
 ```
 
+---
+
 # Variables
 
 For a list of variables for each device refer to its Formulations page.
@@ -122,6 +158,7 @@ HotStartVariable
 WarmStartVariable
 ColdStartVariable
 PowerAboveMinimumVariable
+PowerOutput
 ```
 
 ### Storage Unit Variables
@@ -134,6 +171,8 @@ ReservationVariable
 
 ```@docs
 FlowActivePowerVariable
+FlowActivePowerSlackUpperBound
+FlowActivePowerSlackLowerBound
 FlowActivePowerFromToVariable
 FlowActivePowerToFromVariable
 FlowReactivePowerFromToVariable
@@ -145,28 +184,32 @@ VoltageMagnitude
 VoltageAngle
 ```
 
-### Regulation and Services Variables
+### Services Variables
 
 ```@docs
 ActivePowerReserveVariable
 ServiceRequirementVariable
-DeltaActivePowerUpVariable
-DeltaActivePowerDownVariable
-AdditionalDeltaActivePowerUpVariable
-AdditionalDeltaActivePowerDownVariable
-AreaMismatchVariable
-SteadyStateFrequencyDeviation
-SmoothACE
 SystemBalanceSlackUp
 SystemBalanceSlackDown
 ReserveRequirementSlack
+InterfaceFlowSlackUp
+InterfaceFlowSlackDown
+```
+
+### Feedforward Variables
+
+```@docs
+UpperBoundFeedForwardSlack
+LowerBoundFeedForwardSlack
 ```
 
 ```@raw html
  
  
 ```
 
+---
+
 # Constraints
 
 ### Common Constraints
@@ -180,10 +223,7 @@ PieceWiseLinearCostConstraint
 
 ```@docs
 AreaDispatchBalanceConstraint
-AreaParticipationAssignmentConstraint
-BalanceAuxConstraint
 CopperPlateBalanceConstraint
-FrequencyResponseConstraint
 NodalBalanceActiveConstraint
 NodalBalanceReactiveConstraint
 ```
@@ -198,13 +238,11 @@ InputActivePowerVariableLimitsConstraint
 OutputActivePowerVariableLimitsConstraint
 ```
 
-### Regulation and Services Constraints
+### Services Constraints
 
 ```@docs
-ParticipationAssignmentConstraint
-RegulationLimitsConstraint
 RequirementConstraint
-ReserveEnergyCoverageConstraint
+ParticipationFractionConstraint
 ReservePowerConstraint
 ```
 
@@ -215,7 +253,6 @@ ActiveRangeICConstraint
 CommitmentConstraint
 DurationConstraint
 RampConstraint
-RampLimitConstraint
 StartupInitialConditionConstraint
 StartupTimeLimitTemperatureConstraint
 ```
@@ -224,57 +261,54 @@ StartupTimeLimitTemperatureConstraint
 
 ```@docs
 EqualityConstraint
-
 ```
 
 ### Branches Constraints
 
 ```@docs
-AbsoluteValueConstraint
-FlowLimitFromToConstraint
-FlowLimitToFromConstraint
+FlowLimitConstraint
 FlowRateConstraint
 FlowRateConstraintFromTo
 FlowRateConstraintToFrom
-HVDCDirection
 HVDCLossesAbsoluteValue
 HVDCPowerBalance
 NetworkFlowConstraint
 RateLimitConstraint
-RateLimitConstraintFromTo
-RateLimitConstraintToFrom
 PhaseAngleControlLimit
 ```
 
 ### Feedforward Constraints
 
 ```@docs
-FeedforwardSemiContinousConstraint
-FeedforwardIntegralLimitConstraint
+FeedforwardSemiContinuousConstraint
 FeedforwardUpperBoundConstraint
 FeedforwardLowerBoundConstraint
-FeedforwardEnergyTargetConstraint
 ```
 
+```@raw html
+ 
+ 
+```
+
+---
+
 # Parameters
 
-## Time Series Parameters
+### Time Series Parameters
 
 ```@docs
 ActivePowerTimeSeriesParameter
 ReactivePowerTimeSeriesParameter
 RequirementTimeSeriesParameter
 ```
 
-## Variable Value Parameters
+### Variable Value Parameters
 
 ```@docs
 UpperBoundValueParameter
 LowerBoundValueParameter
 OnStatusParameter
-EnergyLimitParameter
 FixValueParameter
-EnergyTargetParameter
 ```
 
 ### Objective Function Parameters