Skip to content

Commit

Permalink
edit docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkhraijah committed Dec 9, 2022
1 parent 7b59e28 commit 6c4ddf2
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/data_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To calculate the objective function of the central algorithm use `calc_dist_gen_
calc_dist_gen_cost
```

To compare the distributed algorithm objective function value with the central OPF, use `compare_solution` to get the absolute value of the relative error.
To compare the distributed algorithm objective function value with the central OPF, use `compare_solution` to get the absolute value of the relative error.

```@docs
compare_solution
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ CurrentModule = PowerModelsADA

The `PowerModelsADA` framework is designed to easily incorporate new alternating distributed algorithms. The framework provides means to decompose a test case into multiple areas, model the subproblems associated with each area using `PowerModels`, solve the supropblems in parallel using multi-threading, communicate the shared data between the areas, and calculate the mismatches to decide if the termination criteria are satisfied.

The current version of `PowerModelsADA` implements four distributed algorithms:
The current version of `PowerModelsADA` implements four distributed algorithms:

- Alternating Direction Method of Multipliers (ADMM)
- Analytical Target Cascading (ATC)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/newalgorithm.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ end
_var
```

The last function is to update the area dictionary after communicating the shared variables results with other areas.
The last function is to update the area dictionary after communicating the shared variables results with other areas.

```julia
"update the xx algorithm before each iteration"
Expand Down

2 comments on commit 6c4ddf2

@mkhraijah
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/73813

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 6c4ddf2fa2aa2367eb3c2630032223a95403a37c
git push origin v0.1.0

Please sign in to comment.