Skip to content

Commit e48ed84

Browse files
committed
Improve docs
1 parent c6cd8d2 commit e48ed84

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To perform Power Flow analysis using PWF.jl in Julia, follow the steps bellow:
2222

2323
1. First of all, make sure you have [Visual Studio Code](https://code.visualstudio.com/) and [Julia Language](https://julialang.org/downloads/) Long-term support (LTS) 1.6.6 configured correctly;
2424

25-
2. Then, add PWF.jl and PowerModels.jl to known packages;
25+
2. Then, add PWF.jl and PowerModels.jl to the known packages;
2626

2727
```julia
2828
using Pkg
@@ -50,10 +50,10 @@ For more information about PowerModels.jl visit the PowerModels [documentation](
5050

5151
## Parser
5252

53-
The package parses all available sections into a julia dictionary. Each key represents a .pwf section as shown below:
53+
The package can parse all available sections into a julia dictionary withou any modifications. Each key represents a .pwf section as shown below:
5454

5555
```julia
56-
julia> parse_file(file)
56+
julia> parse_file(file; pm = false)
5757
Dict{String, Any} with 6 entries:
5858
"DLIN" => Dict{String, Any}[Dict("AGGREGATOR 10"=>nothing, "AGGREGATOR 5"=>nothing, "AGGR"
5959
"name" => "3bus"
@@ -98,7 +98,7 @@ Dict{String, Any} with 6 entries:
9898
The package also allow converting .pwf file directly into PowerModels.jl network data structure:
9999
100100
```julia
101-
julia> parse_file(file; pm = true)
101+
julia> parse_file(file; pm = true) # default
102102
Dict{String, Any} with 13 entries:
103103
"bus" => Dict{String, Any}("1"=>Dict{String, Any}("zone"=>1, "bus_i"=>1, "bus_"…
104104
"source_type" => "pwf"
@@ -135,7 +135,7 @@ There are two main softwares used for parsing PWF files and each one does slight
135135
136136
```julia
137137
138-
julia> data = parse_file(file; pm = true, software = ANAREDE)
138+
julia> data = parse_file(file; pm = true, software = ANAREDE) # default
139139
140140
julia> data = parse_file(file; pm = true, software = Organon)
141141
```

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To perform Power Flow analysis using PWF.jl in Julia, follow the steps bellow:
2222

2323
1. First of all, make sure you have [Visual Studio Code](https://code.visualstudio.com/) and [Julia Language](https://julialang.org/downloads/) Long-term support (LTS) 1.6.6 configured correctly;
2424

25-
2. Then, add PWF.jl and PowerModels.jl to known packages;
25+
2. Then, add PWF.jl and PowerModels.jl to the known packages;
2626

2727
```julia
2828
using Pkg

0 commit comments

Comments
 (0)