Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #5

Merged
merged 4 commits into from
Nov 22, 2021
Merged

Develop #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e04985
Update readme
iagoschavarry Nov 22, 2021
c4f9c79
Merge pull request #2 from LAMPSPUC/documentation
iagochavarry Nov 22, 2021
8ed23aa
Merge branch 'main' into documentation
iagoschavarry Nov 22, 2021
e56474a
Merge pull request #4 from LAMPSPUC/documentation
iagochavarry Nov 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Parsing a .pwf file to Julia dictionary is as simple as:
using ParserPWF

file = "3bus.pwf"
pwf_dict = parse_pwf(file)
pwf_dict = parse_file(file)
```

Converting the .pwf file into PowerModels.jl network data dictionary:

```julia
network_data = parse_pwf_to_powermodels(file)
network_data = parse_file(file; pm = true)
```

Then you are ready to use PowerModels!
Expand All @@ -44,7 +44,7 @@ For more information about PowerModels.jl visit the PowerModels [documentation](
The package parses all available sections into a julia dictionary. Every key represents a .pwf section as shown below:

```julia
julia> ParserPWF.parse_pwf(file)
julia> ParserPWF.parse_file(file)
Dict{String, Any} with 6 entries:
"DLIN" => Dict{String, Any}[Dict("AGGREGATOR 10"=>nothing, "AGGREGATOR 5"=>nothing, "AGGR"…
"name" => "3bus"
Expand Down Expand Up @@ -89,7 +89,7 @@ Dict{String, Any} with 6 entries:
The package also allow converting .pwf file directly into PowerModels.jl network data structure:

```julia
julia> ParserPWF.parse_pwf_to_powermodels(file)
julia> ParserPWF.parse_file(file; pm = true)
Dict{String, Any} with 13 entries:
"bus" => Dict{String, Any}("1"=>Dict{String, Any}("zone"=>1, "bus_i"=>1, "bus_"…
"source_type" => "pwf"
Expand Down Expand Up @@ -126,9 +126,9 @@ There are two main softwares used for parsing PWF files and each one does slight

```julia

julia> data = parse_file(file; software = ANAREDE)
julia> data = parse_file(file; pm = true, software = ANAREDE)

julia> data = parse_file(file; software = Organon)
julia> data = parse_file(file; pm = true, software = Organon)
```

**Additional data inside PWF files**
Expand Down
2 changes: 1 addition & 1 deletion src/ParserPWF.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ function parse_file(io::IO; validate::Bool=true, software = ANAREDE, pm::Bool =
pm ? parse_pwf_to_powermodels(io, validate = validate, software = software, add_control_data = add_control_data) : parse_pwf(filename)
end

export parse_file
export parse_file, ANAREDE, Organon

end # end module