Skip to content

Commit 0b889d1

Browse files
committed
Update documentation in the Quick Guide section. Replace specific function with the parse_file function
1 parent 1a34fbf commit 0b889d1

File tree

2 files changed

+3
-29
lines changed

2 files changed

+3
-29
lines changed

docs/src/index.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -61,20 +61,6 @@ The package parses all available sections into a julia dictionary. Every key rep
6161
- DOPC
6262
- DCTE
6363

64-
**Incoming Sections:**
65-
66-
- DARE
67-
- DCAI
68-
- DCAR
69-
- DCSC
70-
- DGEI
71-
- DGLT
72-
- DINJ
73-
- DMFL
74-
- DMOT
75-
- DMTE
76-
- TITU
77-
7864
## PowerModels.jl converter
7965

8066
The package also allow converting .pwf file directly into PowerModels.jl network data structure:

docs/src/quickguide.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
11
# Quick Start Guide
22

3-
Parsing a .pwf file to Julia dictionary is as simple as:
3+
All functionalities of the PWF.jl package can be used by the following function
44

55
```julia
66
using PWF
77

88
file = "3bus.pwf"
9-
pwf_dict = parse_pwf(file)
9+
pwf_dict = parse_file(file; pm = true, add_control_data = false)
1010
```
1111

12-
Converting the .pwf file into PowerModels.jl network data dictionary:
13-
14-
```julia
15-
network_data = parse_pwf_to_powermodels(file)
16-
```
17-
18-
Then you are ready to use PowerModels!
19-
20-
```julia
21-
using PowerModels, Ipopt
22-
23-
run_ac_pf(network_data, Ipopt.Optimizer)
24-
```
12+
The parameter `pm` indicates if the data should be converted to the PowerModels.jl format. `add_control_data` is used to inform if additional information regarding control actions should be included in the PowerModels.jl data. For more information about Control Actions visit the ControlPowerFlow.jl [documentation](https://github.com/LAMPSPUC/ControlPowerFlow.jl)
2513

2614
For more information about PowerModels.jl visit the PowerModels [documentation](https://lanl-ansi.github.io/PowerModels.jl/stable/)
2715

0 commit comments

Comments
 (0)