Skip to content

Commit c09ac61

Browse files
committed
improve docs
1 parent 8732a92 commit c09ac61

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For more information about PowerModels.jl visit the PowerModels [documentation](
4444
The package parses all available sections into a julia dictionary. Each key represents a .pwf section as shown below:
4545

4646
```julia
47-
julia> PWF.parse_file(file)
47+
julia> parse_file(file)
4848
Dict{String, Any} with 6 entries:
4949
"DLIN" => Dict{String, Any}[Dict("AGGREGATOR 10"=>nothing, "AGGREGATOR 5"=>nothing, "AGGR"
5050
"name" => "3bus"
@@ -89,7 +89,7 @@ Dict{String, Any} with 6 entries:
8989
The package also allow converting .pwf file directly into PowerModels.jl network data structure:
9090
9191
```julia
92-
julia> PWF.parse_file(file; pm = true)
92+
julia> parse_file(file; pm = true)
9393
Dict{String, Any} with 13 entries:
9494
"bus" => Dict{String, Any}("1"=>Dict{String, Any}("zone"=>1, "bus_i"=>1, "bus_"…
9595
"source_type" => "pwf"
@@ -133,10 +133,10 @@ julia> data = parse_file(file; pm = true, software = Organon)
133133
134134
**Additional data inside PWF files**
135135
136-
If parse_pwf_to_powermodels' argument add_control_data is set to true (default = false), additional information present on the PWF file that is not used by PowerModels will be stored inside each element in the field "control_data", such as the example below:
136+
If parse_file' argument add_control_data is set to true (default = false), additional information present on the PWF file that is not used by PowerModels will be stored inside each element in the field "control_data", such as the example below:
137137

138138
```julia
139-
julia> data = PWF.parse_pwf_to_powermodels(file, add_control_data = true);
139+
julia> data = parse_file(file, pm = true, add_control_data = true);
140140
141141
julia> data["shunt"]["1"]["control_data"]
142142
Dict{String, Any} with 9 entries:

0 commit comments

Comments
 (0)