Merge pull request #7 from LAMPSPUC/develop

iagochavarry · web-flow · commit 6e42e2523cf2 · 2021-11-22T11:14:21.000-03:00
change devbranch to main in make.jl
diff --git a/Project.toml b/Project.toml
@@ -1,4 +1,4 @@
-name = "ParserPWF"
+name = "PWF"
 uuid = "0f4c3beb-4231-4c4d-93e1-709cb40a89e6"
 version = "0.3.0"
 
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 <img src="docs/src/assets/lampspucpptreduced.png" align="right" width=300>
-<h1>ParserPWF.jl</h1>
+<h1>PWF.jl</h1>
 
 <br>
 <br>
 
 ---
 
-ParserPWF.jl is a Julia package for converting ANAREDE data format (".pwf") into a Julia dictionary.
+PWF.jl is a Julia package for converting ANAREDE data format (".pwf") into a Julia dictionary.
 
-Additionaly, ParserPWF provides parsing .pwf file directly to [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl) network data dictionary.
+Additionaly, PWF provides parsing .pwf file directly to [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl) network data dictionary.
 
 The implementations were made based on the ANAREDE user guide manual (v09).
 
@@ -17,7 +17,7 @@ The implementations were made based on the ANAREDE user guide manual (v09).
 Parsing a .pwf file to Julia dictionary is as simple as:
 
 ```julia
-using ParserPWF
+using PWF
 
 file = "3bus.pwf"
 pwf_dict = parse_file(file)
@@ -41,10 +41,10 @@ For more information about PowerModels.jl visit the PowerModels [documentation](
 
 ## Parser
 
-The package parses all available sections into a julia dictionary. Every key represents a .pwf section as shown below:
+The package parses all available sections into a julia dictionary. Each key represents a .pwf section as shown below:
 
 ```julia
-julia> ParserPWF.parse_file(file)
+julia> PWF.parse_file(file)
 Dict{String, Any} with 6 entries:
   "DLIN" => Dict{String, Any}[Dict("AGGREGATOR 10"=>nothing, "AGGREGATOR 5"=>nothing, "AGGR"…
   "name" => "3bus"
@@ -57,7 +57,7 @@ Dict{String, Any} with 6 entries:
 **PWF Sections Available:**
 
 - DBAR
-- DBSH (fban)
+- DBSH
 - DCBA
 - DCCV
 - DCER
@@ -72,9 +72,6 @@ Dict{String, Any} with 6 entries:
 - DLIN
 - DOPC
 - DSHL
-
-  **Incoming Sections:**
-
 - DARE
 - DCAI
 - DCAR
@@ -83,13 +80,16 @@ Dict{String, Any} with 6 entries:
 - DMFL
 - DMOT
 - DMTE
+- DAGR
+- DCMT
+- DTPF
 
 ## PowerModels.jl converter
 
 The package also allow converting .pwf file directly into PowerModels.jl network data structure:
 
 ```julia
-julia> ParserPWF.parse_file(file; pm = true)
+julia> PWF.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"
@@ -133,9 +133,11 @@ julia> data = parse_file(file; pm = true, software = Organon)
 
 **Additional data inside PWF files**
 
-Additional information existing in a PWF file that is not used by PowerModels is stored inside each element in the field "control_data", such as the example below:
+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:
 
 ```julia
+julia> data = PWF.parse_pwf_to_powermodels(file, add_control_data = true);
+
 julia> data["shunt"]["1"]["control_data"]
 Dict{String, Any} with 9 entries:
   "vmmax"              => 1.029
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,10 +1,10 @@
 using Documenter
-using ParserPWF
+using PWF
 
 makedocs(
-    modules = [ParserPWF],
+    modules = [PWF],
     format = Documenter.HTML(analytics = "UA-367975-10", mathengine = Documenter.MathJax()),
-    sitename = "ParserPWF",
+    sitename = "PWF",
     authors = "Iago Chávarry and Pedro Hamacher",
     pages = [
         "Home" => "index.md",
@@ -39,5 +39,6 @@ makedocs(
 # for more information.
 deploydocs(
         repo="github.com/LAMPSPUC/PWF.jl.git",
+        devbranch = "main",
         push_preview = true
     )
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,14 +1,14 @@
-# ParserPWF.jl
+# PWF.jl
 
 ```@meta
-CurrentModule = ParserPWF
+CurrentModule = PWF
 ```
 
 ---
 
-ParserPWF.jl is a Julia package for converting ANAREDE data format (".pwf") into a Julia dictionary.
+PWF.jl is a Julia package for converting ANAREDE data format (".pwf") into a Julia dictionary.
 
-Additionaly, ParserPWF provides parsing .pwf file directly to [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl) network data dictionary.
+Additionaly, PWF provides parsing .pwf file directly to [PowerModels.jl](https://github.com/lanl-ansi/PowerModels.jl) network data dictionary.
 
 The implementations were made based on the ANAREDE user guide manual (v09).
 
@@ -17,7 +17,7 @@ The implementations were made based on the ANAREDE user guide manual (v09).
 Parsing a .pwf file to Julia dictionary is as simple as:
 
 ```julia
-using ParserPWF
+using PWF
 
 file = "3bus.pwf"
 pwf_dict = parse_pwf(file)
diff --git a/docs/src/quickguide.md b/docs/src/quickguide.md
@@ -3,7 +3,7 @@
 Parsing a .pwf file to Julia dictionary is as simple as:
 
 ```julia
-using ParserPWF
+using PWF
 
 file = "3bus.pwf"
 pwf_dict = parse_pwf(file)
@@ -30,7 +30,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> PWF.parse_pwf(file)
 Dict{String, Any} with 6 entries:
   "DLIN" => Dict{String, Any}[Dict("AGGREGATOR 10"=>nothing, "AGGREGATOR 5"=>nothing, "AGGR"…
   "name" => "3bus"
@@ -45,7 +45,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> PWF.parse_pwf_to_powermodels(file)
 Dict{String, Any} with 13 entries:
   "bus"            => Dict{String, Any}("1"=>Dict{String, Any}("zone"=>1, "bus_i"=>1, "bus_"…
   "source_type"    => "pwf"
diff --git a/src/PWF.jl b/src/PWF.jl
@@ -1,10 +1,10 @@
-module ParserPWF
+module PWF
 
 # using packages
 using PowerModels
 
 # include PWF parser file
-include("pwf.jl")
+include("pwf2dict.jl")
 
 # include PowerModels converter files
 include("pwf2pm/bus.jl")
diff --git a/src/pwf2dict.jl b/src/pwf2dict.jl
diff --git a/test/runtests.jl b/test/runtests.jl
@@ -2,13 +2,13 @@ using Ipopt
 using Test
 using PowerModels
 
-include("../src/ParserPWF.jl")
+include("../src/PWF.jl")
 
 include("test_functions.jl")
 
 ipopt = optimizer_with_attributes(Ipopt.Optimizer, "tol" => 0.0001, "print_level" => 0)
 
-@testset "ParserPWF" begin
+@testset "PWF" begin
     include("test_pwf.jl")
     include("test_pwf_to_powermodels.jl")
 end
diff --git a/test/test_pwf.jl b/test/test_pwf.jl
@@ -2,28 +2,28 @@
     @testset "Intermediary functions" begin
         file = open(joinpath(@__DIR__,"data/pwf/test_system.pwf"))
 
-        sections = ParserPWF._split_sections(file)
+        sections = PWF._split_sections(file)
         @test isa(sections, Vector{Vector{String}})
         @test length(sections) == 5
         @test sections[1][1] == "TITU"
 
         data = Dict{String, Any}()
-        ParserPWF._parse_section!(data, sections[1])
+        PWF._parse_section!(data, sections[1])
         @test haskey(data, "TITU")
-        ParserPWF._parse_section!(data, sections[2])
+        PWF._parse_section!(data, sections[2])
         @test haskey(data, "DOPC IMPR")
-        ParserPWF._parse_section!(data, sections[3])
+        PWF._parse_section!(data, sections[3])
         @test haskey(data, "DCTE")
-        ParserPWF._parse_section!(data, sections[4])
+        PWF._parse_section!(data, sections[4])
         @test haskey(data, "DBAR")
-        ParserPWF._parse_section!(data, sections[5])
+        PWF._parse_section!(data, sections[5])
         @test haskey(data, "DLIN")
     end
 
 
     @testset "Resulting Dict" begin
         file = open(joinpath(@__DIR__,"data//pwf/test_system.pwf"))
-        dict = ParserPWF._parse_pwf_data(file)
+        dict = PWF._parse_pwf_data(file)
 
         @testset "Keys" begin
             @test haskey(dict, "TITU")
@@ -159,7 +159,7 @@
                                 "DCSC" => Dict("1" => Dict("FROM BUS" => 1, "OPERATION" => 'A', "TO BUS" => 2, "CIRCUIT" => 0, "STATUS" => 'L', "OWNER" => 'F', "BYPASS" => 'D', "MINIMUM VALUE" => -9999.0, "MAXIMUM VALUE" => 0.0, "INITIAL VALUE" => 0.0, "CONTROL MODE" => 'X', "SPECIFIED VALUE" => nothing, "MEASUREMENT EXTREMITY" => 1, "NUMBER OF STAGES" => nothing, "NORMAL CAPACITY" => Inf, "EMERGENCY CAPACITY" => Inf, "EQUIPAMENT CAPACITY" => Inf, "AGGREGATOR 1" => nothing, "AGGREGATOR 2" => nothing, "AGGREGATOR 3" => nothing, "AGGREGATOR 4" => nothing, "AGGREGATOR 5" => nothing, "AGGREGATOR 6" => nothing, "AGGREGATOR 7" => nothing, "AGGREGATOR 8" => nothing, "AGGREGATOR 9" => nothing, "AGGREGATOR 10" => nothing)),
                                 "DCAI" => Dict("1" => Dict("BUS" => 1, "OPERATION" => 'A', "GROUP" => nothing, "STATUS" => 'L', "UNITIES" => 2, "OPERATING UNITIES" => 2, "ACTIVE CHARGE" => 0.0, "REACTIVE CHARGE" => 0.0, "PARAMETER A" => nothing, "PARAMETER B" => nothing, "PARAMETER C" => nothing, "PARAMETER D" => nothing, "VOLTAGE" => 70.0, "CHARGE DEFINITION VOLTAGE" => 1.0)),
                                 "DGEI" => Dict("1" => Dict("BUS" => 1, "OPERATION" => 'A', "AUTOMATIC MODE" => 'N', "GROUP" => nothing, "STATUS" => 'L', "UNITIES" => 2, "OPERATING UNITIES" => 2, "MINIMUM OPERATING UNITIES" => 1, "ACTIVE GENERATION" => 0.0, "REACTIVE GENERATION" => 0.0, "MINIMUM REACTIVE GENERATION" => -9999.0, "MAXIMUM REACTIVE GENERATION" => 99999.0, "ELEVATOR TRANSFORMER REACTANCE" => nothing, "XD" => 0.0, "XQ" => 0.0, "XL" => 0.0, "POWER FACTOR" => 1.0, "APPARENT POWER" => 99999.0, "MECHANICAL LIMIT" => 99999.0)))
-        parsed_pwf = ParserPWF.parse_file(joinpath(@__DIR__,"data/pwf/test_defaults.pwf"), pm = false)
+        parsed_pwf = PWF.parse_file(joinpath(@__DIR__,"data/pwf/test_defaults.pwf"), pm = false)
 
         @test parsed_pwf == pwf
     end
diff --git a/test/test_pwf_to_powermodels.jl b/test/test_pwf_to_powermodels.jl
@@ -2,11 +2,11 @@
     @testset "PowerModels Dict fields" begin
         @testset "PowerModels conversion" begin
             file = open(joinpath(@__DIR__,"data/pwf/test_system.pwf"))
-            pwf_data = ParserPWF._parse_pwf_data(file)
+            pwf_data = PWF._parse_pwf_data(file)
             pm_data = Dict{String, Any}()
 
             @testset "Bus" begin
-                ParserPWF._pwf2pm_bus!(pm_data, pwf_data, add_control_data = true)
+                PWF._pwf2pm_bus!(pm_data, pwf_data, add_control_data = true)
                 
                 @test haskey(pm_data, "bus")
                 @test length(pm_data["bus"]) == 9
@@ -45,8 +45,8 @@
             end
 
             @testset "Branch" begin
-                ParserPWF._pwf2pm_branch!(pm_data, pwf_data, add_control_data = true)
-                ParserPWF._pwf2pm_transformer!(pm_data, pwf_data, add_control_data = true)
+                PWF._pwf2pm_branch!(pm_data, pwf_data, add_control_data = true)
+                PWF._pwf2pm_transformer!(pm_data, pwf_data, add_control_data = true)
                 
                 @test haskey(pm_data, "branch")
                 @test length(pm_data["branch"]) == 7
@@ -93,7 +93,7 @@
 
             @testset "DCline" begin
                 pwf_dc = open(joinpath(@__DIR__,"data/pwf/300bus.pwf"))
-                pwf_data_dc = ParserPWF.parse_pwf_to_powermodels(pwf_dc)
+                pwf_data_dc = PWF.parse_pwf_to_powermodels(pwf_dc)
 
                 @test haskey(pwf_data_dc, "dcline")
                 @test length(pwf_data_dc["dcline"]) == 1
@@ -107,7 +107,7 @@
 
         @testset "Resulting Dict" begin
             file = open(joinpath(@__DIR__,"data/pwf/test_system.pwf"))
-            pm_data = ParserPWF.parse_pwf_to_powermodels(file; software = ParserPWF.Organon)
+            pm_data = PWF.parse_pwf_to_powermodels(file; software = PWF.Organon)
 
             @testset "PowerModels Dict" begin
                 @test isa(pm_data, Dict)
@@ -163,7 +163,7 @@
                 file_raw = joinpath(@__DIR__,"data/raw/$name.raw")
                 file_pwf = open(joinpath(@__DIR__,"data/pwf/$name.pwf"))
             
-                pwf_data = ParserPWF.parse_pwf_to_powermodels(file_pwf)
+                pwf_data = PWF.parse_pwf_to_powermodels(file_pwf)
                 raw_data = PowerModels.parse_file(file_raw)
                 
                 result_pwf = PowerModels.run_ac_pf(pwf_data, ipopt)
@@ -176,7 +176,7 @@
 
         @testset "PWF to PM corrections" begin
             file = open(joinpath(@__DIR__,"data/pwf/3bus_corrections.pwf"))
-            pm_data = ParserPWF.parse_pwf_to_powermodels(file; software = ParserPWF.Organon)
+            pm_data = PWF.parse_pwf_to_powermodels(file; software = PWF.Organon)
 
             parse_result = PowerModels.run_ac_pf(pm_data, ipopt);
 
@@ -192,7 +192,7 @@
     @testset "Control data fields" begin
         @testset "Shunt control_data" begin
             file = open(joinpath(@__DIR__,"data/pwf/3bus_shunt_fields.pwf"))
-            pm_data = ParserPWF.parse_pwf_to_powermodels(file, software = ParserPWF.ANAREDE, add_control_data = true)
+            pm_data = PWF.parse_pwf_to_powermodels(file, software = PWF.ANAREDE, add_control_data = true)
 
             @test length(pm_data["bus"]) == 3
             @test occursin("B s 1", pm_data["bus"]["1"]["name"])
@@ -231,7 +231,7 @@
 
         @testset "Line shunt" begin
             file = open(joinpath(@__DIR__,"data/pwf/test_line_shunt.pwf"))
-            pm_data = ParserPWF.parse_pwf_to_powermodels(file; software = ParserPWF.Organon)
+            pm_data = PWF.parse_pwf_to_powermodels(file; software = PWF.Organon)
 
             @test pm_data["branch"]["1"]["b_fr"] == 4.5
             @test pm_data["branch"]["1"]["b_to"] == 7.8
@@ -244,7 +244,7 @@
         end
 
         @testset "Transformer control fields" begin
-            data = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/9bus_transformer_fields.pwf"), add_control_data = true)
+            data = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/9bus_transformer_fields.pwf"), add_control_data = true)
 
             tap_automatic_control = findfirst(x -> x["f_bus"] == 1 && x["t_bus"] == 4, data["branch"])
             tap_variable_control = findfirst(x -> x["f_bus"] == 2 && x["t_bus"] == 7, data["branch"])
@@ -303,8 +303,8 @@
 
     @testset "Organon vs ANAREDE parser" begin
         @testset "DBSH" begin
-            data_anarede = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DBSH.pwf"), software = ParserPWF.ANAREDE)
-            data_organon = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DBSH.pwf"), software = ParserPWF.Organon)
+            data_anarede = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DBSH.pwf"), software = PWF.ANAREDE)
+            data_organon = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DBSH.pwf"), software = PWF.Organon)
 
             pm_anarede = PowerModels.instantiate_model(data_anarede, PowerModels.ACPPowerModel, PowerModels.build_pf);
             pm_organon = PowerModels.instantiate_model(data_organon, PowerModels.ACPPowerModel, PowerModels.build_pf);
@@ -331,8 +331,8 @@
         end
 
         @testset "DCER" begin
-            data_anarede = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCER.pwf"), software = ParserPWF.ANAREDE)
-            data_organon = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCER.pwf"), software = ParserPWF.Organon)
+            data_anarede = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCER.pwf"), software = PWF.ANAREDE)
+            data_organon = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCER.pwf"), software = PWF.Organon)
 
             pm_anarede = PowerModels.instantiate_model(data_anarede, PowerModels.ACPPowerModel, PowerModels.build_pf);
             pm_organon = PowerModels.instantiate_model(data_organon, PowerModels.ACPPowerModel, PowerModels.build_pf);
@@ -360,8 +360,8 @@
         end
 
         @testset "DSHL" begin
-            data_anarede = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DSHL.pwf"), software = ParserPWF.ANAREDE)
-            data_organon = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DSHL.pwf"), software = ParserPWF.Organon)
+            data_anarede = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DSHL.pwf"), software = PWF.ANAREDE)
+            data_organon = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DSHL.pwf"), software = PWF.Organon)
 
             pm_anarede = PowerModels.instantiate_model(data_anarede, PowerModels.ACPPowerModel, PowerModels.build_pf);
             pm_organon = PowerModels.instantiate_model(data_organon, PowerModels.ACPPowerModel, PowerModels.build_pf);
@@ -404,8 +404,8 @@
         end
 
         @testset "DCSC" begin
-            data_anarede = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCSC.pwf"), software = ParserPWF.ANAREDE)
-            data_organon = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCSC.pwf"), software = ParserPWF.Organon)
+            data_anarede = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCSC.pwf"), software = PWF.ANAREDE)
+            data_organon = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCSC.pwf"), software = PWF.Organon)
 
             pm_anarede = PowerModels.instantiate_model(data_anarede, PowerModels.ACPPowerModel, PowerModels.build_pf);
             pm_organon = PowerModels.instantiate_model(data_organon, PowerModels.ACPPowerModel, PowerModels.build_pf);
@@ -450,7 +450,7 @@
         end
 
         @testset "DC line" begin
-            data_anarede = ParserPWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCline.pwf"), software = ParserPWF.ANAREDE)
+            data_anarede = PWF.parse_pwf_to_powermodels(joinpath(@__DIR__,"data/pwf/3bus_DCline.pwf"), software = PWF.ANAREDE)
             pm_anarede = PowerModels.instantiate_model(data_anarede, PowerModels.ACPPowerModel, PowerModels.build_pf);
             result_anarede = PowerModels.optimize_model!(pm_anarede, optimizer = ipopt)
             PowerModels.update_data!(data_anarede, result_anarede["solution"])

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name = "ParserPWF"`
	`1`	`+name = "PWF"`
`2`	`2`	`uuid = "0f4c3beb-4231-4c4d-93e1-709cb40a89e6"`
`3`	`3`	`version = "0.3.0"`
`4`	`4`