Skip to content

Commit

Permalink
updating readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
ccoffrin committed Jul 15, 2018
1 parent c81080e commit 05d4d8a
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 6 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ThreePhasePowerModels.jl Change Log
===================================

### Staged
- nothing

### v0.1.0
- Initial release
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,32 @@ Dev:
[![Build Status](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl.svg?branch=master)](https://travis-ci.org/lanl-ansi/ThreePhasePowerModels.jl)
[![codecov](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/lanl-ansi/ThreePhasePowerModels.jl)

A Julia/JuMP Package for Three Phase Power Network Optimization
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, ...).
This enables the definition of a wide variety of power network formulations and their comparison on common problem specifications.

**Core Problem Specifications**
* Power Flow (pf)
* Optimal Power Flow (opf)

**Core Network Formulations**
* AC (polar and rectangular coordinates)
* SOC Relaxation (W-space)

**Network Data Formats**
* Matlab ".m" files
* OpenDSS ".dss" files

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

This package can be installed with the following command,
```
Pkg.clone("[email protected]:lanl-ansi/ThreePhasePowerModels.jl.git")
```
## Development

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.


## Acknowledgments

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,
- Frederik Geth (@frederikgeth) CSIRO, Distribution modeling advise

## License

Expand Down
2 changes: 1 addition & 1 deletion REQUIRE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
julia 0.6

JuMP 0.17 0.19-
PowerModels 0.6 0.8-
PowerModels 0.8 0.9-
InfrastructureModels 0.0.4 0.2-
Memento 0.8

0 comments on commit 05d4d8a

Please sign in to comment.