Skip to content

Commit 05d4d8a

Browse files
committed
updating readme and changelog
1 parent c81080e commit 05d4d8a

File tree

3 files changed

+32
-6
lines changed

3 files changed

+32
-6
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
ThreePhasePowerModels.jl Change Log
2+
===================================
3+
4+
### Staged
5+
- nothing
6+
7+
### v0.1.0
8+
- Initial release

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,32 @@ Dev:
44
[![Build Status](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl.svg?branch=master)](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl)
55
[![codecov](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl)
66

7-
A Julia/JuMP Package for Three Phase Power Network Optimization
7+
ThreePhasePowerModels.jl is an extention package of PowerModels.jl for Steady-State Power Distribution Network Optimization. It is designed to enable computational evaluation of emerging power network formulations and algorithms in a common platform. The code is engineered to decouple problem specifications (e.g. Power Flow, Optimal Power Flow, ...) from the power network formulations (e.g. AC, linear-approximation, SOC-relaxation, ...).
8+
This enables the definition of a wide variety of power network formulations and their comparison on common problem specifications.
9+
10+
**Core Problem Specifications**
11+
* Power Flow (pf)
12+
* Optimal Power Flow (opf)
13+
14+
**Core Network Formulations**
15+
* AC (polar and rectangular coordinates)
16+
* SOC Relaxation (W-space)
17+
18+
**Network Data Formats**
19+
* Matlab ".m" files
20+
* OpenDSS ".dss" files
821

922
**Warning:** This package is under active development and may change drastically without warning.
1023

11-
This package can be installed with the following command,
12-
```
13-
Pkg.clone("git@github.com:lanl-ansi/ThreePhasePowerModels.jl.git")
14-
```
24+
## Development
25+
26+
Community-driven development and enhancement of ThreePhasePowerModels are welcome and encouraged. Please fork this repository and share your contributions to the master with pull requests.
27+
28+
29+
## Acknowledgments
30+
31+
This code has been developed as part of the Advanced Network Science Initiative at Los Alamos National Laboratory. The primary developers are David Fobes(@pseudocubic) and Carleton Coffrin(@ccoffrin) with support from the following contributors,
32+
- Frederik Geth (@frederikgeth) CSIRO, Distribution modeling advise
1533

1634
## License
1735

REQUIRE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
julia 0.6
22

33
JuMP 0.17 0.19-
4-
PowerModels 0.6 0.8-
4+
PowerModels 0.8 0.9-
55
InfrastructureModels 0.0.4 0.2-
66
Memento 0.8
77

0 commit comments

Comments
 (0)