Data Model Abstraction Refactor

.gitignore

@@ -6,4 +6,6 @@
 deps/deps.jl
 docs/build
 
-Manifest.toml
+Manifest.toml
+
+.ipynb_checkpoints/

.travis.yml

@@ -5,15 +5,15 @@ os:
   - windows
 julia:
   - 1.0
-  - 1.3
+  - 1.4
   - nightly
 codecov: true
 jobs:
   allow_failures:
     - julia: nightly
   include:
     - stage: "Documentation"
-      julia: 1.3
+      julia: 1.4
       os: linux
       script:
         - julia --project=docs/ -e 'using Pkg; Pkg.instantiate(); Pkg.develop(PackageSpec(path=pwd()))'

CHANGELOG.md

@@ -2,6 +2,31 @@
 
 ## staged
 
+- none
+
+## v0.9.0
+
+- SDP and SOC relaxations were broken but are fixed again (unit tests added)
+- Remove `run_mc_opf_iv`, `run_mc_opf_bf`, `run_mc_opf_bf_lm`, `run_mc_pf_bf`, `run_mc_pf_iv`, these can be accessed by using the correct formulation with `run_mc_opf` and `run_mc_pf`
+- Add support for Memento 1.1
+- Add support for PowerModels v0.17 (breaking)
+- Add support for InfrastructureModels v0.5
+- Updates JSON parser to handle enum (`"data_model"` values)
+- Adds some commonly used InfrastructureModels and PowerModels functions as exports
+- Adds model building functions `add_{component}!` to aid in building simple models for testing (experimental)
+- Add run_mc_model (adds `ref_add_arcs_transformer!` to ref_extensions, and sets `multiconductor=true` by default) (breaking)
+- Rename `ref_add_arcs_trans` -> `ref_add_arcs_transformer` (breaking)
+- Update `count_nodes`, now counts source nodes as well, excludes \_virtual objects
+- Change \_PMs and \_IMs to \_PM, \_IM, respectively
+- Add example for PMD usage (see Jupyter notebooks in `/examples`)
+- Update transformer mathematical model
+- Introduce new data models: ENGINEERING, MATHEMATICAL (see data model documentation) (breaking)
+- Update DSS parser to be more robust, and parse into new format (breaking)
+- Updates DSS paser to parse more options/commands, moves these into `"options"` dict (breaking)
+- Updates how dss `like` is applied to better match opendss (almost all properties are copied with like) (breaking)
+- Add support for new OpenDSS components (loadshape, xfmrcode, xycurve)
+- Add support for JuMP v0.22 (exports `optimizer_with_attributtes` by default)
+- Add support for PowerModels v0.16 (breaking)
 - Add support for Memento v0.13, v1.0
 
 ## v0.8.1

Project.toml

@@ -2,7 +2,7 @@ name = "PowerModelsDistribution"
 uuid = "d7431456-977f-11e9-2de3-97ff7677985e"
 authors = ["David M Fobes <[email protected]>", "Carleton Coffrin"]
 repo = "https://github.com/lanl-ansi/PowerModelsDistribution.jl.git"
-version = "0.8.1"
+version = "0.9.0"
 
 [deps]
 InfrastructureModels = "2030c09a-7f63-5d83-885d-db604e0e9cc0"
@@ -16,14 +16,14 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
 Cbc = ">= 0.4"
-InfrastructureModels = "~0.4"
+InfrastructureModels = "~0.5"
 Ipopt = ">= 0.4"
 JSON = "~0.18, ~0.19, ~0.20, ~0.21"
 JuMP = "~0.19.2, ~0.20, ~0.21"
 Juniper = ">= 0.4"
 MathOptInterface = "~0.8, ~0.9"
-Memento = "~0.10, ~0.11, ~0.12, ~0.13, ~1.0"
-PowerModels = "~0.15"
+Memento = "~0.10, ~0.11, ~0.12, ~0.13, ~1.0, ~1.1"
+PowerModels = "~0.17"
 SCS = ">= 0.4"
 julia = "^1"
 

README.md

@@ -16,22 +16,37 @@ This enables the definition of a wide variety of power network formulations and
 ## Core Problem Specifications
 
 - Power Flow (pf)
-- Optimal Power Flow (opf), for the Bus Injection Model (BIM) as well as the Branch Flow Model (BFM)
-- Continuous load shed, minimum load delta (mld), for the Branch Flow Model (LPLinUBFPowerModel), AC Polar (ACPPowerModel), and Network Flow Approximation (NFAPowerModel)
+  - ACP, ACR, IVR, LinDist3Flow, NFA, DCP
+- Optimal Power Flow (opf)
+  - ACP, ACR, IVR, LinDist3Flow, NFA, DCP
+- Continuous load shed, minimum load delta (mld)
+  - ACP, LinDist3Flow, NFA
+- Optimal Power Flow with on-load tap-changer (opf_oltc)
+  - ACP
+
+**Note: The documentation is somewhat lagging behind development and the parings of network features with problem specifications with formulations has not been enumerated. We are working to correct this for you.**
 
 ## Core Network Formulations
 
-- AC (polar and rectangular coordinates)
-- SDP BFM relaxation
-- SOC BFM and BIM relaxation (W-space)
-- Linear approximation (LinDist3Flow and simplified unbalanced DistFlow)
+- Nonlinear
+  - ACP
+  - ACR
+  - IVR
+- Relaxations
+  - SDP BFM
+  - SOC BFM and BIM relaxation (W-space)
+- Linear Approximations
+  - LinDist3Flow
+  - NFA
+  - DCP
 
 ## Network Data Formats
 
-- Matlab ".m" files (extended for three-phase)
 - OpenDSS ".dss" files
 
-**Warning:** This package is under active development and may change drastically without warning.
+## Examples
+
+Examples of how to use PowerModelsDistribution can be found in the main documentation and in Jupyter Notebooks inside the `/examples` directory
 
 ## Development
 
@@ -44,6 +59,21 @@ This code has been developed as part of the Advanced Network Science Initiative
 - Sander Claeys (@sanderclaeys) KU Leuven, transformer models and ACR formulation
 - Frederik Geth (@frederikgeth) CSIRO, Distribution modeling advise
 
+## Citing PowerModelsDistribution
+
+If you find PowerModelsDistribution useful for your work, we kindly request that you cite the following [https://arxiv.org/abs/2004.10081](publication):
+
+```bibtex
+@misc{fobes2020powermodelsdistributionjl,
+    title={PowerModelsDistribution.jl: An Open-Source Framework for Exploring Distribution Power Flow Formulations},
+    author={David M Fobes and Sander Claeys and Frederik Geth and Carleton Coffrin},
+    year={2020},
+    eprint={2004.10081},
+    archivePrefix={arXiv},
+    primaryClass={cs.CE}
+}
+```
+
 ## License
 
 This code is provided under a BSD license as part of the Multi-Infrastructure Control and Optimization Toolkit (MICOT) project, LA-CC-13-108.

docs/Project.toml

@@ -4,5 +4,5 @@ InfrastructureModels = "2030c09a-7f63-5d83-885d-db604e0e9cc0"
 PowerModels = "c36e90e8-916a-50a6-bd94-075b64ef4655"
 
 [compat]
-InfrastructureModels = "~0.4"
-PowerModels = "~0.15"
+InfrastructureModels = "~0.5"
+PowerModels = "~0.17"

docs/make.jl

@@ -10,7 +10,11 @@ makedocs(
         "Manual" => [
             "Getting Started" => "quickguide.md",
             "Mathematical Model" => "math-model.md",
-            "Data Formats" => "data-formats.md",
+            "Engineering Data Model" => "eng-data-model.md",
+            "Enums in Engineering Model" => "enums.md",
+            "Conversion to Mathematical Model" => "eng2math.md",
+            "External Data Formats" => "external-data-formats.md",
+            "Examples" => "engineering_model.md",
         ],
         "Library" => [
             "Network Formulations" => "formulations.md",