Skip to content

Commit 8247972

Browse files
committed
minor touch ups to the data and readme markdown files
1 parent 4feccd7 commit 8247972

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

DATA.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ The network data dictionary structure is roughly as follows,
4747

4848
The following commands can be used to explore the network data dictionary generated by a given Matpower data file,
4949
```
50-
using PowerModels
5150
network_data = PowerModels.parse_file("$(Pkg.dir("PowerModels"))/test/data/case14.m")
5251
display(network_data)
5352
```
@@ -58,12 +57,13 @@ For a detailed list of all possible parameters refer to the specification docume
5857

5958
The PowerModels network data dictionary differs from the Matpower format in the following ways,
6059

61-
* All PowerModels components have an `index` parameter, which can be used to uniquely identify that network element.
62-
* All network parameters are in per-unit and angles are in radians.
63-
* All non-transformer branches are given nominal transformer values (i.e. a tap of 1.0 and a shift of 0).
64-
* When present, the `gencost` data is incorporated into the `gen` data, the column names remain the same.
65-
* Only quadratic active power generation cost functions are supported at this time.
66-
* Some additional derived values are added to branches, such as line admittance values (see `src/core/data.jl` for details).
60+
- All PowerModels components have an `index` parameter, which can be used to uniquely identify that network element.
61+
- All network parameters are in per-unit and angles are in radians.
62+
- All non-transformer branches are given nominal transformer values (i.e. a tap of 1.0 and a shift of 0).
63+
- When present, the `gencost` data is incorporated into the `gen` data, the column names remain the same.
64+
- Only quadratic active power generation cost functions are supported at this time.
65+
- Some additional derived values are added to branches, such as line admittance values (see `update_derived_values` in `src/core/data.jl` for details).
66+
- Special treatment is given to the optional `ne_branch` matrix to support the TNEP problem.
6767

6868

6969
## Working with Matpower Data Files

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For the current development version, "checkout" this package with,
3737

3838
`Pkg.checkout("PowerModels")`
3939

40-
At least one solver is required for running PowerModels. The open-source solver Ipopt is recommended, as it is extremely fast, and can be used to solve a wide variety of the problems and network formulations provided in PowerModels. The Ipopt solver can be installed via tha package manager with,
40+
At least one solver is required for running PowerModels. The open-source solver Ipopt is recommended, as it is extremely fast, and can be used to solve a wide variety of the problems and network formulations provided in PowerModels. The Ipopt solver can be installed via the package manager with,
4141

4242
`Pkg.add("Ipopt")`
4343

@@ -73,7 +73,7 @@ Extending PowerModels with new problems and formulations will be covered in a an
7373

7474
### Modifying Network Data
7575

76-
The follow example demonstrates how to modify the network data in Julia.
76+
The follow example demonstrates how to perform multiple PowerModels solves while modify the network data in Julia,
7777

7878
```
7979
network_data = PowerModels.parse_file("nesta_case3_lmbd.m")

0 commit comments

Comments
 (0)