update 0.1.4

mkhraijah · Oct 13, 2023 · f325c17 · f325c17 · mkhraijah · Oct 13, 2023
1 parent b23a784
commit f325c17
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 24 deletions.
diff --git a/docs/src/adaptive_admm.md b/docs/src/adaptive_admm.md
@@ -1,4 +1,4 @@
-# ADMM
+# Adaptive Alternating Direction Method of Multipliers (Adaptive ADMM)
 
 ```@meta
 CurrentModule = PowerModelsADA

diff --git a/docs/src/admm.md b/docs/src/admm.md
@@ -1,4 +1,4 @@
-# ADMM
+# Alternating Direction Method of Multipliers (ADMM)
 
 ```@meta
 CurrentModule = PowerModelsADA

diff --git a/docs/src/aladin.md b/docs/src/aladin.md
@@ -1,4 +1,4 @@
-# ALADIN
+# Augmented Lagrangian Alternating Direction Inexact Newton (ALADIN)
 
 ```@meta
 CurrentModule = PowerModelsADA

diff --git a/docs/src/app.md b/docs/src/app.md
@@ -1,4 +1,4 @@
-# APP
+# Auxiliary Problem Principle (APP)
 
 ```@meta
 CurrentModule = PowerModelsADA

diff --git a/docs/src/atc.md b/docs/src/atc.md
@@ -1,4 +1,4 @@
-# ATC
+# Analytical Target Cascading (ATC)
 
 ```@meta
 CurrentModule = PowerModelsADA

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -19,6 +19,19 @@ The current version of `PowerModelsADA` implements four distributed algorithms:
 - Auxiliary Problem Principle (APP)
 - Augmented Lagrangian Alternating Direction Inexact Newton (ALADIN)
 
+The specifications of the distributed algorithms are contained in modules within `PowerModelsADA` and can be used with the algorithms' solve functions. The distributed algorithms variations and solve functions are listed below.
+
+| **Algorithm**                      | **Module**                          | **Solve Function**                     |
+|------------------------------------|-------------------------------------|----------------------------------------|
+| ADMM (fully distributed)           | `admm_methods`                      | `solve_dopf_admm`                      |
+| ADMM (with a coordinator)          | `admm_coordinated_methods`          | `solve_dopf_admm_coordinated`          |
+| Adaptive ADMM (fully distributed)  | `adaptive_admm_methods`             | `solve_dopf_adaptive_admm`             |
+| Adaptive ADMM (with a coordinator) | `adaptive_admm_coordinated_methods` | `solve_dopf_adaptive_admm_coordinated` |
+| ATC (fully distributed)            | `atc_methods`                       | `solve_dopf_atc`                       |
+| ATC (with a coordinator)           | `atc_coordinated_methods`           | `solve_dopf_atc_coordinated`           |
+| APP                                | `app_methods`                       | `solve_dopf_app`                       |
+| ALADIN (with a coordinator)        | `aladin_coordinated_methods`        | `solve_dopf_aladin_coordinated`        |
+
 `PowerModelsADA` can be extended to include variations of the existing algorithms or new user-defined algorithms. More details about the formulations and algorithm implementations are shown in [Technical Specifications](https://mkhraijah.github.io/PowerModelsADA.jl/dev/specification/)
 
 ## Installation

diff --git a/docs/src/tutorial.md b/docs/src/tutorial.md
@@ -6,11 +6,16 @@ The distributed algorithm-specific functions are stored in modules. Each module
 
 The distributed algorithm module and solve function are:
 
-- ADMM: modules: `admm_methods` and `admm_coordinated_methods`. solve functions: `solve_dopf_admm` and `solve_dopf_admm_coordinated`
-- ATC: modules: `atc_methods` and `atc_coordinated_methods`. solve functions: `solve_dopf_atc` and `solve_dopf_atc_coordinated`
-- APP: modules: `app_methods`. solve functions: `solve_dopf_app`
-- ALADIN: modules: `aladin_coordinated_methods`. solve function: `solve_dopf_aladin_coordinated`
-- Adaptive ADMM: modules: `adaptive_admm_methods` and `adaptive_admm_coordinated_methods`. solve functions: `solve_dopf_adaptive_admm` and `solve_dopf_adaptive_admm_coordinated`
+| **Algorithm**                      | **Module**                          | **Solve Function**                     |
+|------------------------------------|-------------------------------------|----------------------------------------|
+| ADMM (fully distributed)           | `admm_methods`                      | `solve_dopf_admm`                      |
+| ADMM (with a coordinator)          | `admm_coordinated_methods`          | `solve_dopf_admm_coordinated`          |
+| Adaptive ADMM (fully distributed)  | `adaptive_admm_methods`             | `solve_dopf_adaptive_admm`             |
+| Adaptive ADMM (with a coordinator) | `adaptive_admm_coordinated_methods` | `solve_dopf_adaptive_admm_coordinated` |
+| ATC (fully distributed)            | `atc_methods`                       | `solve_dopf_atc`                       |
+| ATC (with a coordinator)           | `atc_coordinated_methods`           | `solve_dopf_atc_coordinated`           |
+| APP                                | `app_methods`                       | `solve_dopf_app`                       |
+| ALADIN (with a coordinator)        | `aladin_coordinated_methods`        | `solve_dopf_aladin_coordinated`        |
 
 ## Run Distributed Algorithm
 
@@ -127,7 +132,7 @@ while iteration < max_iteration && flag_convergence == false
 
     ## solve local problem and update solution
     for i in areas_id
-        result = solve_model(data_area[i], model_type, optimizer, admm_methods.build_method, solution_processors=admm_methods.post_processors)
+        result = solve_pmada_model(data_area[i], model_type, optimizer, admm_methods.build_method, solution_processors=admm_methods.post_processors)
         update_data!(data_area[i], result["solution"])
     end
 

diff --git a/src/core/base.jl b/src/core/base.jl
@@ -3,12 +3,6 @@
 ###############################################################################
 
 
-""
-function solve_pmada_model(file::String, model_type::Type, optimizer, build_method; kwargs...)
-    data = parse_file(file)
-    return solve_pmada_model(data, model_type, optimizer, build_method; kwargs...)
-end
-
 ""
 function solve_pmada_model(data::Dict{String,<:Any}, model_type::Type, optimizer, build_method;
         ref_extensions=[], solution_processors=[], relax_integrality=false,
@@ -31,13 +25,6 @@ function solve_pmada_model(data::Dict{String,<:Any}, model_type::Type, optimizer
     return result
 end
 
-
-""
-function instantiate_pmada_model(file::String, model_type::Type, build_method; kwargs...)
-    data = parse_file(file)
-    return instantiate_pmada_model(data, model_type, build_method; kwargs...)
-end
-
 ""
 function instantiate_pmada_model(data::Dict{String,<:Any}, model_type::Type, build_method; kwargs...)
     return _IM.instantiate_model(data, model_type, build_method, ref_add_core!, _pmada_global_keys, pm_it_sym; kwargs...)