Skip to content

Commit 793e16c

Browse files
iagochavarryiagochavarry
committed
Improve docs, try to fix image path erros
1 parent 00b36c0 commit 793e16c

File tree

19 files changed

+355
-240
lines changed

19 files changed

+355
-240
lines changed

‎Project.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ uuid = "0f4c3beb-4231-4c4d-93e1-709cb40a89e6"
33
version = "0.0.1"
44

55
[deps]
6-
PowerModels = "c36e90e8-916a-50a6-bd94-075b64ef4655"
76
Memento = "f28f55f0-a522-5efc-85c2-fe41dfb9b2d9"
7+
PowerModels = "c36e90e8-916a-50a6-bd94-075b64ef4655"
88

99
[compat]
1010
PowerModels = "~0.18, ~0.19"

‎README.md‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,36 @@ Additionaly, PWF provides parsing .pwf file directly to [PowerModels.jl](https:/
1313
The implementations were made based on the ANAREDE user guide manual (v09).
1414

1515
**Quickstart**
16+
Until the creating of PWF.jl, '.pwf' files could only be parsed through Brazilian commercial softwares, such as ANAREDE and Organon. Therefore, the Brazilian Power System community was compelled to use one of the two solutions to run Power Flow analysis.
1617

17-
Parsing a .pwf file to Julia dictionary is as simple as:
18+
PWF.jl unlocks the power of open-source to the Power System community. Therefore, now, anyone can read the standard Brazilian file ('.pwf') and run steady-state electrical analysis with state-of-the-art methodologies. For the Power Flow algorithm, we encourage the usage of the package PowerModels.jl, which already have integration with the PWF.jl package.
1819

19-
```julia
20-
using PWF
20+
To perform Power Flow analysis using PWF.jl in Julia, follow the steps bellow:
2121

22-
file = "3bus.pwf"
23-
pwf_dict = parse_file(file)
24-
```
22+
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;
2523

26-
Converting the .pwf file into PowerModels.jl network data dictionary:
24+
2. Then, add PWF.jl and PowerModels.jl to known packages;
2725

2826
```julia
29-
network_data = parse_file(file; pm = true)
27+
using Pkg
28+
29+
Pkg.add("PWF")
30+
Pkg.add("PowerModels")
3031
```
3132

32-
Then you are ready to use PowerModels!
33+
3. Finally, you are ready to perform power flow analysis
3334

3435
```julia
35-
using PowerModels, Ipopt
36+
using PWF, PowerModels
37+
38+
network_path = "network.pwf"
39+
40+
network = PWF.parse_file(network_path)
41+
42+
results = PowerModels.run_ac_pf(network)
3643

37-
run_ac_pf(network_data, Ipopt.Optimizer)
44+
results["solution"]["bus"]["1"]["vm"] # folution for voltage magniture of bus 1
45+
results["solution"]["bus"]["1"]["va"] # solution for voltage angle of bus 1
3846
```
3947

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

‎docs/src/dbar.md‎

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,35 @@
11
# DBAR
2+
23
## Description
4+
35
This section includes general information about AC buses, in columns described as follows:
6+
47
## Usage
5-
Column | Description
6-
--- | ---
7-
Number | Bus identification number
8-
Operation | Bus addition, removal or modification
9-
Status | Bus status - on or off
10-
Type | Bus type - PQ, PV or swing
11-
Base voltage group | Bus voltage group identifier, defined in DGBT section. If there is no such section or the group is not defined there, base voltage will be set to 1.0 kv
12-
Name | Bus alphanumeric identification
13-
Voltage limit group | Bus voltage bounds group identifier, defined in DGLT section. If there is no such section or the group is not defined there, bounds will be set to 0.9 and 1.1.
14-
Voltage | Initial voltage (per unit)
15-
Angle | Initial phase angle (degrees)
16-
Active generation | Bus active generation (MW)
17-
Reactive generation | Bus reactive generation (Mvar)
18-
Minimum reactive generation | Lower bound for bus reative generation (Mvar)
19-
Maximum reactive generation | Upper bound for bus reative generation (Mvar)
20-
Controlled bus | Bus which voltage magnitude will be controlled as defined in Voltage field
21-
Active charge | Bus active charge (MW)
22-
Reactive charge | Bus reactive charge (Mvar)
23-
Total reactive power | Total injected power by capacitor reactor banks; Positive value for capacitor and negative for reactors
24-
Area | Number of area which the bus is a part of
25-
Charge definition voltage | Voltage in which active and reactive charge were measured
26-
Visualization mode | Bus visualization in ANAREDE software
27-
Aggregator 1-10 | Additional information
8+
9+
| Column | Description |
10+
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| Number | Bus identification number |
12+
| Operation | Bus addition, removal or modification |
13+
| Status | Bus status - on or off |
14+
| Type | Bus type - PQ, PV or swing |
15+
| Base voltage group | Bus voltage group identifier, defined in DGBT section. If there is no such section or the group is not defined there, base voltage will be set to 1.0 kv |
16+
| Name | Bus alphanumeric identification |
17+
| Voltage limit group | Bus voltage bounds group identifier, defined in DGLT section. If there is no such section or the group is not defined there, bounds will be set to 0.9 and 1.1. |
18+
| Voltage | Initial voltage (per unit) |
19+
| Angle | Initial phase angle (degrees) |
20+
| Active generation | Bus active generation (MW) |
21+
| Reactive generation | Bus reactive generation (Mvar) |
22+
| Minimum reactive generation | Lower bound for bus reative generation (Mvar) |
23+
| Maximum reactive generation | Upper bound for bus reative generation (Mvar) |
24+
| Controlled bus | Bus which voltage magnitude will be controlled as defined in Voltage field |
25+
| Active charge | Bus active charge (MW) |
26+
| Reactive charge | Bus reactive charge (Mvar) |
27+
| Total reactive power | Total injected power by capacitor reactor banks; Positive value for capacitor and negative for reactors |
28+
| Area | Number of area which the bus is a part of |
29+
| Charge definition voltage | Voltage in which active and reactive charge were measured |
30+
| Visualization mode | Bus visualization in ANAREDE software |
31+
| Aggregator 1-10 | Additional information |
32+
2833
## Example
29-
![Alt text](assets/DBAR.png)
34+
35+
![Alt text](docs/assets/DBAR.png)

‎docs/src/dbsh.md‎

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,37 @@
11
# DBSH
2+
23
## Description
4+
35
Capacitor or reactor banks connected to AC buses or branches. For groups or banks connected to the same bus, minimum and maximum voltage, controlled bus and voltage control strategies will always be the same. In that sense, capacitors/reactors connected to a branch are considered as connected to the bus of the end which they are connected.
6+
47
## Usage
5-
Column | Description
6-
--- | ---
7-
From bus | Either the bus number which shunt capacitor/reactor banks are connected or bus number from one of the circuit ends where line capacitor/reactor banks are connected.
8-
Operation | Groups or banks addition, removal or modification
9-
To bus | Bus number from the other end where line capacitor/reacor banks are connected; Not used for shunt capacitor/reactor banks
10-
Circuit | AC circuit identification number
11-
Control mode | Automatic switching control; C for continuous, D for discrete and F for fixed
12-
Minimum voltage | Lower bound for voltage range that determinates automatic switching control
13-
Maximum voltage | Upper bound for voltage range that determinates automatic switching control
14-
Controlled bus | Bus number which voltage will be controlled by automatic switching control or reactors connected to the bus defined in Bus field; Controlled voltage value depends on the fields Control and Control Type
15-
Initial reactive injection | Initial reactive injection due to capacitor/reactor banks connected in the bus (Mvar); This field aims to represent initial reactive power injection value for power flow solving; If control mode is fixed, this value represents what is effectively injected in the bus
16-
Control type | C if control is made by the center of the voltage range, L if it is made by the violated bounds
17-
Erase DBAR data? | If filled with 'S', value in Capacitor/Reactor field (DBAR section) will be erased
18-
Extremity | Bus number from the circuit end where shunt capacitor/reactor banks are connected to
8+
9+
| Column | Description |
10+
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11+
| From bus | Either the bus number which shunt capacitor/reactor banks are connected or bus number from one of the circuit ends where line capacitor/reactor banks are connected. |
12+
| Operation | Groups or banks addition, removal or modification |
13+
| To bus | Bus number from the other end where line capacitor/reacor banks are connected; Not used for shunt capacitor/reactor banks |
14+
| Circuit | AC circuit identification number |
15+
| Control mode | Automatic switching control; C for continuous, D for discrete and F for fixed |
16+
| Minimum voltage | Lower bound for voltage range that determinates automatic switching control |
17+
| Maximum voltage | Upper bound for voltage range that determinates automatic switching control |
18+
| Controlled bus | Bus number which voltage will be controlled by automatic switching control or reactors connected to the bus defined in Bus field; Controlled voltage value depends on the fields Control and Control Type |
19+
| Initial reactive injection | Initial reactive injection due to capacitor/reactor banks connected in the bus (Mvar); This field aims to represent initial reactive power injection value for power flow solving; If control mode is fixed, this value represents what is effectively injected in the bus |
20+
| Control type | C if control is made by the center of the voltage range, L if it is made by the violated bounds |
21+
| Erase DBAR data? | If filled with 'S', value in Capacitor/Reactor field (DBAR section) will be erased |
22+
| Extremity | Bus number from the circuit end where shunt capacitor/reactor banks are connected to |
23+
1924
### Capacitor/Reactor banks
20-
Column | Description
21-
--- | ---
22-
Group or bank | Identification number; Each group or bank can have one or more switching stages
23-
Operation | Capacitor/reactor banks or group data addition, removal or modification
24-
Status | L if the group or bank is on, D if it is off
25-
Unities | Total number of unities or stages that constitute the group or bank. This field is used as memory of the total number and the maximum allowed for each bus is 6
26-
Operating unities | Total number of unities or stages that constitute the group or bank that are effectively in operation
27-
Capacitor reactor | Total reactive power injected by one unity(Mvar); This value refers to the injected reactive power at nominal voltage (1.0 p.u.) and should be positive for capacitors and negative for reactors
25+
26+
| Column | Description |
27+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28+
| Group or bank | Identification number; Each group or bank can have one or more switching stages |
29+
| Operation | Capacitor/reactor banks or group data addition, removal or modification |
30+
| Status | L if the group or bank is on, D if it is off |
31+
| Unities | Total number of unities or stages that constitute the group or bank. This field is used as memory of the total number and the maximum allowed for each bus is 6 |
32+
| Operating unities | Total number of unities or stages that constitute the group or bank that are effectively in operation |
33+
| Capacitor reactor | Total reactive power injected by one unity(Mvar); This value refers to the injected reactive power at nominal voltage (1.0 p.u.) and should be positive for capacitors and negative for reactors |
34+
2835
## Example
29-
![Alt text](assets/DBSH.png)
36+
37+
![Alt text](docs/assets/DBSH.png)

‎docs/src/dcba.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
# DCBA
2+
23
## Description
4+
35
DC bus data.
6+
47
## Usage
5-
Column | Description
6-
--- | ---
7-
Number | DC bus identification number
8-
Operation | Bus addition or modification
9-
Type | 0 for non-specified voltage, 1 for specified voltage (slack bus); one slack bus must be specified to each pole
10-
Polarity | +- for positive pole; -- for negative pole; 0 for neutral bus
11-
Name | Bus alphanumeric identification
12-
Voltage limit group | Not used in PWF current version
13-
Voltage | Initial bus voltage (kV); for slack buses, voltage to be kept constant
14-
Ground electrode | Ground electrode resistance (\(\Omega\)); should only be filled for neutral buses
15-
DC link | DC link number, as defined in DELO; each bus on the same pole or bipole must be from the same DC link
8+
9+
| Column | Description |
10+
| ------------------- | -------------------------------------------------------------------------------------------------------------- |
11+
| Number | DC bus identification number |
12+
| Operation | Bus addition or modification |
13+
| Type | 0 for non-specified voltage, 1 for specified voltage (slack bus); one slack bus must be specified to each pole |
14+
| Polarity | +- for positive pole; -- for negative pole; 0 for neutral bus |
15+
| Name | Bus alphanumeric identification |
16+
| Voltage limit group | Not used in PWF current version |
17+
| Voltage | Initial bus voltage (kV); for slack buses, voltage to be kept constant |
18+
| Ground electrode | Ground electrode resistance (\(\Omega\)); should only be filled for neutral buses |
19+
| DC link | DC link number, as defined in DELO; each bus on the same pole or bipole must be from the same DC link |
20+
1621
## Example
17-
![Alt text](assets/DCBA.png)
22+
23+
![Alt text](docs/assets/DCBA.png)

0 commit comments

Comments
 (0)