Release 7.0

CHANGES.md

@@ -9,8 +9,15 @@ For change history for [MIPS][2], see [mips/CHANGES.md](mips/CHANGES.md).
 For change history for [MOST][3], see [most/CHANGES.md](most/CHANGES.md).
 
 
-Since last release
-------------------
+Version 7.0 - *Jun 20, 2019*
+----------------------------
+
+#### 6/20/19
+  - Release 7.0.
+  - Add `CITATION` file.
+  - Other miscellaneous documentation updates, e.g. MATPOWER website
+    links updated to https://matpower.org, separate references for
+    MATPOWER software and User's Manual, with DOIs.
 
 #### 6/5/19
   - **INCOMPATIBLE CHANGE:** Fix [issue #60][20] by adding missing
@@ -91,7 +98,7 @@ Since last release
     *Thanks to Amin Gholami.*
 
 #### 1/16/19
-  - Add option for `install_matpower()` (non-interactively) uninstall
+  - Add option for `install_matpower()` to (non-interactively) uninstall
     MATPOWER, i.e. remove MATPOWER directories from MATLAB/Octave path.
 
 #### 1/14/19
@@ -106,6 +113,7 @@ Since last release
 #### 11/26/18
   - Fix [bug #53][13] where certain OPF cases (e.g. `case33bw`) resulted in
     a fatal error under versions of MATLAB prior to R2016b (v9.1).
+    *Thanks to Jane Cheung.*
 
 #### 11/9/18
   - Add support for IPOPT solver under Octave, including in the

CITATION

@@ -40,11 +40,11 @@ corresponding case files.
 
 For the sake of reproducibility of research results, it is best to cite
 the specific version of the software used with the version-specfic DOI.
-For example, for version 6.0 of MATPOWER, use:
+For example, for version 7.0 of MATPOWER, use:
 
-  R. D. Zimmerman, C. E. Murillo-Sanchez (2016). MATPOWER (Version 6.0)
+  R. D. Zimmerman, C. E. Murillo-Sanchez (2019). MATPOWER (Version 7.0)
   [Software]. Available: https://matpower.org
-  doi: 10.5281/zenodo.3237810
+  doi: 10.5281/zenodo.3251119
 
 To cite the MATPOWER software generally, without reference to a specific
 version, use the following citation and DOI, with <YEAR> replaced by the
@@ -62,13 +62,13 @@ found via the general DOI at https://doi.org/10.5281/zenodo.3236535.
 The MATPOWER, MIPS and MOST User's Manuals should also be cited
 explicitly in work that refers to or is derived from their content. As
 with the software, the citation and DOI can be version-specific or
-general, as appropriate. For version 6.0 of the MATPOWER User's Manual,
+general, as appropriate. For version 7.0 of the MATPOWER User's Manual,
 use:
 
   R. D. Zimmerman, C. E. Murillo-Sanchez. MATPOWER User's Manual,
-  Version 6.0. 2016. [Online].
-  Available: https://matpower.org/docs/MATPOWER-manual-6.0.pdf
-  doi: 10.5281/zenodo.3236526
+  Version 7.0. 2019. [Online].
+  Available: https://matpower.org/docs/MATPOWER-manual-7.0.pdf
+  doi: 10.5281/zenodo.3251118
 
 For a version non-specific citation, use the following citation and DOI,
 with <YEAR> replaced by the year of the most recent release:

README.md

@@ -320,11 +320,11 @@ corresponding case files.
 
 For the sake of reproducibility of research results, it is best to cite
 the specific version of the software used, with the version-specfic DOI.
-For example, for version 6.0 of MATPOWER, use:
+For example, for version 7.0 of MATPOWER, use:
 
->   R. D. Zimmerman, C. E. Murillo-Sanchez (2016). *MATPOWER (Version 6.0)*
+>   R. D. Zimmerman, C. E. Murillo-Sanchez (2019). *MATPOWER (Version 7.0)*
     [Software]. Available: https://matpower.org  
-    doi: [10.5281/zenodo.3237810](https://doi.org/10.5281/zenodo.3237810)
+    doi: [10.5281/zenodo.3251119](https://doi.org/10.5281/zenodo.3251119)
 
 To cite the MATPOWER software generally, without reference to a specific
 version, use the following citation and DOI, with *\<YEAR\>* replaced by the
@@ -342,13 +342,13 @@ found via the general DOI at https://doi.org/10.5281/zenodo.3236535.
 The MATPOWER, MIPS and MOST User's Manuals should also be cited
 explicitly in work that refers to or is derived from their content. As
 with the software, the citation and DOI can be version-specific or
-general, as appropriate. For version 6.0 of the [MATPOWER User's Manual][8],
+general, as appropriate. For version 7.0 of the [MATPOWER User's Manual][8],
 use:
 
 >   R. D. Zimmerman, C. E. Murillo-Sanchez. *MATPOWER User's Manual,
-    Version 6.0.* 2016.  
-    [Online]. Available: https://matpower.org/docs/MATPOWER-manual-6.0.pdf  
-    doi: [10.5281/zenodo.3236526](https://doi.org/10.5281/zenodo.3236526)
+    Version 7.0.* 2019.  
+    [Online]. Available: https://matpower.org/docs/MATPOWER-manual-7.0.pdf  
+    doi: [10.5281/zenodo.3251118](https://doi.org/10.5281/zenodo.3251118)
 
 For a version non-specific citation, use the following citation and DOI,
 with *\<YEAR\>* replaced by the year of the most recent release:

docs/relnotes/MATPOWER-Announce-7.0.md

@@ -0,0 +1,71 @@
+What's New in MATPOWER 7.0
+--------------------------
+
+#### Released Jun 20, 2019
+
+Below are some of the highlights of the changes since version 6.0 of
+MATPOWER. See the [full release notes][1] and the [`CHANGES.md`][2]
+file for more details. For release notes for previous versions, see
+Appendix H of the [MATPOWER User's Manual][3].
+
+#### New Features:
+- New MATPOWER installer script `install_matpower()`
+- User-defined general nonlinear constraints and costs in AC OPF
+- PSS/E RAW export
+- Cartesian coordinate voltage and current mismatch formulations of AC power flow
+  and OPF.
+- Three new radial power flow algorithms
+- Major update to OPF soft limit functionality
+- [MATPOWER Docker image][8]
+- Many new functions and program options.
+
+#### New Extras:
+- [SynGrid][7], a new tool for sythetic grid creation for MATPOWER.
+
+#### New Case Files:
+- Seven new purely synthetic cases, up to 82,000 buses.
+- New [RTS-GMLC][4] case.
+- Six new radial distribution system cases.
+
+#### New Documentation:
+- Two new Tech Notes, [TN3][5] and [TN4][6]
+- LaTeX source code for manuals
+
+#### New Website
+- MATPOWER has a new website at https://matpower.org. Please discontinue
+  use of the old http://www.pserc.cornell.edu/matpower/ address.
+
+#### Other Improvements:
+- Update versions of included packages:
+  - MIPS 1.3.1.
+  - MOST 1.0.2.
+  - MP-Test 7.0.
+- Continuous integration testing via GitHub and Travis-CI integration.
+- Support for IPOPT solver under Octave.
+- Support in core optimization model for:
+  - general nonlinear constraints
+  - general nonlinear costs
+  - quadratic costs
+- Refactor OPF code to take advantage of new `opt_model` capabilities
+  for nonlinear constraints and quadratic and nonlinear costs.
+- Support for polar and cartesian voltages in derivative functions.
+- Improved performance (up to 2x speedup) for Newton power flow.
+- Handling of generator types, fuel types and bus names.
+- Numerous bug fixes.
+
+#### Incompatible Changes:
+- Move included MATPOWER case files to new `data` subdirectory.
+- Default soft limit behavior relaxes all constraints.
+- Minor corrections to data for Polish system cases.
+- Add `mpopt` to input args for some OPF callbacks.
+- Eliminate unnecessary reordering of on-line generators by `ext2int()`.
+
+
+[1]: https://github.com/MATPOWER/matpower/blob/master/docs/relnotes/MATPOWER-Release-Notes-7.0.md
+[2]: https://github.com/MATPOWER/matpower/blob/master/CHANGES.md
+[3]: https://github.com/MATPOWER/matpower/blob/master/docs/MATPOWER-manual.pdf
+[4]: https://github.com/GridMod/RTS-GMLC
+[5]: https://matpower.org/docs/TN3-More-OPF-Derivatives.pdf
+[6]: https://matpower.org/docs/TN4-OPF-Derivatives-Cartesian.pdf
+[7]: https://github.com/MATPOWER/mx-syngrid
+[8]: https://github.com/MATPOWER/matpower/blob/master/docker/MATPOWER-Docker.md

docs/relnotes/MATPOWER-Release-Notes-7.0.md

@@ -1,7 +1,7 @@
-What's New in MATPOWER 7.0b1
-----------------------------
+What's New in MATPOWER 7.0
+--------------------------
 
-#### Released Oct 31, 2018
+#### Released Jun 20, 2019
 
 Below is a summary of the changes since version 6.0 of MATPOWER. See the
 [`CHANGES.md`][1] file for all the gory details. For release notes for
@@ -14,6 +14,11 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
 - Support for additional user-defined general nonlinear constraints and
   costs in AC OPF.
 - Support for exporting MATPOWER case to PSS/E RAW data format.
+- Three new variants of the standard Newton AC power flow, for a total
+  of four, including both nodal power and current balance constraints
+  and both polar and cartesian representations of voltage. See the new
+  `pf.current_balance` and `pf.v_cartesian` options.
+  *Thanks to Baljinnyam Sereeter.*
 - Three new variants of the standard AC OPF formulation, for a total of
   four, including both nodal power and current balance constraints and
   both polar and cartesian representations of voltage. See the new
@@ -25,11 +30,16 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
   `pf.radial.max_it` and `pf.radial.vcorr`. See Section 4.3 on
   "Distribution Power Flow" in the [MATPOWER User's Manual][2] for
   details. *Thanks to Mirko Todorovski.*
-- Major update to OPF soft limit functionality, supporting soft limits
+- Major upgrade to OPF soft limit functionality, supporting soft limits
   on all AC and DC OPF inequality constraints, including branch flow
   constraints, bus voltage bounds, generator active and reactive
   bounds, branch flow and branch angle difference limits.
   *Thanks to Eran Schweitzer.*
+- Docker image tagged [`matpower/matpower-desktop`][10], providing a
+  pre-packaged Ubuntu desktop environment with Octave, MATPOWER, and
+  the [MATPOWER Extras][11] all pre-installed. See the
+  [`docker/MATPOWER-Docker.md`][12] page for more details.
+  *Thanks to Richard Lincoln.*
 - New options:
   - `pf.nr.lin_solver` controls the linear solver used to compute the
     Newton update step in the Newton-Raphson power flow.
@@ -40,6 +50,8 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
     continuation power flow and `cpf.flow_lims_tol` and `cpf.v_lims_tol`
     control the respective detection tolerances.
     *Thanks to Ahmad Sadiq Abubakar and Shrirang Abhyankar.*
+  - `pf.current_balance` and `pf.v_cartesian` control formulation used
+    for Newton AC power flow. *Thanks to Baljinnyam Sereeter.*
   - `opf.current_balance` and `opf.v_cartesian` control formulation
     used for AC OPF. *Thanks to Baljinnyam Sereeter.*
   - `opf.softlims.default` determines whether or not to include soft
@@ -143,11 +155,15 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
   `docs/src`, for [MIPS User's Manual][8] in `mips/docs/src` and for
   [MOST User's Manual][9] in `most/docs/src`.
 
+#### New Website
+- MATPOWER has a new website at https://matpower.org. Please discontinue
+  use of the old http://www.pserc.cornell.edu/matpower/ address.
+
 #### Other Improvements:
 - Update versions of included packages:
-  - MIPS 1.3.
-  - MOST 1.0.1.
-  - MP-Test 7.0b1.
+  - MIPS 1.3.1.
+  - MOST 1.0.2.
+  - MP-Test 7.0.
 - Continuous integration testing via GitHub and Travis-CI integration.
 - Support added in core optimization model `opt_model` for:
   - general nonlinear constraints
@@ -180,6 +196,11 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
 - Add support for IPOPT solver under Octave, including in the Travis-CI
   testing.
   *Thanks to Richard Lincoln.*
+- Add support for YALMIP, SeDuMi and SDPT3 to be recognized under Octave.
+  *Thanks to Richard Lincoln.*
+- Add `'clear_cache'` options to `have_fcn()` (see #65) to facilitate
+  re-checking for optional functionality after changes to the MATLAB/Octave
+  path.
 - Deprecated functions:
     - `d2AIbr_dV2()` -- use `dA2br_dV2()` instead.
     - `d2ASbr_dV2()` -- use `dA2br_dV2()` instead.
@@ -227,6 +248,29 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
   *Thanks to Elis Nycander and Shrirang Abhyankar.*
 - Fix `runpf` handling of case where individual power flow fails during
   Q limit enforcement.
+- Fix #53 where certain OPF cases (e.g. `case33bw`) resulted in a fatal
+  error under versions of MATLAB prior to R2016b (v9.1).
+  *Thanks to Jane Cheung.*
+- Fix #56 where `save2psse` was missing entries for two transformer
+  columns, namely, `VMA1` and `VMI1`.
+  *Thanks to Amin Gholami.*
+- Fix #57 where `save2psse` always used 1 for the `CKT` number, even for
+  parallel branches or transformers.
+  *Thanks to Amin Gholami.*
+- Fix bug in `have_fcn()` where it would incorrectly mark Gurobi as
+  available even if it had an expired license or failed for some other
+  reason.
+- Fix #60 by adding missing generator at slack bus in RTE cases. Affects
+  the following cases:
+  - `case1888rte`
+  - `case1951rte`
+  - `case2848rte`
+  - `case2868rte`
+  - `case6468rte`
+  - `case6470rte`
+  - `case6495rte`
+  - `case6515rte`
+  *Thanks to Jean Maeght.*
 
 #### Incompatible Changes:
 - Move included MATPOWER case files to new `data` subdirectory.
@@ -255,6 +299,11 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
 - Modify order of default output arguments of `opt_model/get_idx()`.
 - Add `mpopt` to input args for OPF `'ext2int'`, `'formulation'`, and
   `'int2ext'` callbacks.
+- Eliminate unnecessary reordering of on-line generators (sorted by
+  increasing bus index) from `ext2int()`. The order is now left
+  unmodified by `ext2int()`. This change should only affect user code
+  that explicitly depends on the order of generators with internal
+  numbering (hopefully quite rare).
 
 
 [1]: https://github.com/MATPOWER/matpower/blob/master/CHANGES.md
@@ -263,6 +312,9 @@ previous versions, see Appendix H of the [MATPOWER User's Manual][2].
 [4]: https://matpower.org
 [5]: https://matpower.org/docs/TN3-More-OPF-Derivatives.pdf
 [6]: https://matpower.org/docs/TN4-OPF-Derivatives-Cartesian.pdf
-[7]: https://matpower.org/docs/MATPOWER-manual-7.0b1.pdf
+[7]: https://matpower.org/docs/MATPOWER-manual-7.0.pdf
 [8]: https://matpower.org/docs/MIPS-manual-1.3.pdf
 [9]: https://matpower.org/docs/MOST-manual-1.0.1.pdf
+[10]: https://hub.docker.com/r/matpower/matpower-desktop
+[11]: https://github.com/MATPOWER/matpower-extras
+[12]: https://github.com/MATPOWER/matpower/blob/master/docker/MATPOWER-Docker.md

docs/relnotes/MATPOWER-Release-Notes-7.0b1-7.0.md

@@ -0,0 +1,88 @@
+What's New in MATPOWER 7.0
+--------------------------
+
+#### Released Jun 20, 2019
+
+Below is a summary of the changes since version 7.0b1 of MATPOWER. See the
+[`CHANGES.md`][1] file for all the gory details. For release notes for
+previous versions, see Appendix H of the [MATPOWER User's Manual][2].
+
+#### New Features:
+- Three new variants of the standard Newton AC power flow, for a total
+  of four, including both nodal power and current balance constraints
+  and both polar and cartesian representations of voltage. See the new
+  `pf.current_balance` and `pf.v_cartesian` options.
+  *Thanks to Baljinnyam Sereeter.*
+- Docker image tagged [`matpower/matpower-desktop`][10], providing a
+  pre-packaged Ubuntu desktop environment with Octave, MATPOWER, and
+  the [MATPOWER Extras][11] all pre-installed. See the
+  [`docker/MATPOWER-Docker.md`][12] page for more details.
+  *Thanks to Richard Lincoln.*
+- New options:
+  - `pf.current_balance` and `pf.v_cartesian` control formulation used
+    for Newton AC power flow. *Thanks to Baljinnyam Sereeter.*
+
+#### New Website
+- MATPOWER has a new website at https://matpower.org. Please discontinue
+  use of the old http://www.pserc.cornell.edu/matpower/ address.
+
+#### Other Improvements:
+- Update versions of included packages:
+  - MIPS 1.3.1.
+  - MOST 1.0.2.
+  - MP-Test 7.0.
+- Improve performance of `makeYbus()`. *Thanks to Binbin Chen.*
+- Add support for IPOPT solver under Octave, including in the Travis-CI
+  testing.
+  *Thanks to Richard Lincoln.*
+- Add support for YALMIP, SeDuMi and SDPT3 to be recognized under Octave.
+  *Thanks to Richard Lincoln.*
+- Add `'clear_cache'` options to `have_fcn()` (see #65) to facilitate
+  re-checking for optional functionality after changes to the MATLAB/Octave
+  path.
+
+#### Bugs Fixed:
+- Fix #53 where certain OPF cases (e.g. `case33bw`) resulted in a fatal
+  error under versions of MATLAB prior to R2016b (v9.1).
+  *Thanks to Jane Cheung.*
+- Fix #56 where `save2psse` was missing entries for two transformer
+  columns, namely, `VMA1` and `VMI1`.
+  *Thanks to Amin Gholami.*
+- Fix #57 where `save2psse` always used 1 for the `CKT` number, even for
+  parallel branches or transformers.
+  *Thanks to Amin Gholami.*
+- Fix bug in `have_fcn()` where it would incorrectly mark Gurobi as
+  available even if it had an expired license or failed for some other
+  reason.
+- Fix #60 by adding missing generator at slack bus in RTE cases. Affects
+  the following cases:
+  - `case1888rte`
+  - `case1951rte`
+  - `case2848rte`
+  - `case2868rte`
+  - `case6468rte`
+  - `case6470rte`
+  - `case6495rte`
+  - `case6515rte`
+  *Thanks to Jean Maeght.*
+
+#### Incompatible Changes:
+- Eliminate unnecessary reordering of on-line generators (sorted by
+  increasing bus index) from `ext2int()`. The order is now left
+  unmodified by `ext2int()`. This change should only affect user code
+  that explicitly depends on the order of generators with internal
+  numbering (hopefully quite rare).
+
+
+[1]: https://github.com/MATPOWER/matpower/blob/master/CHANGES.md
+[2]: https://github.com/MATPOWER/matpower/blob/master/docs/MATPOWER-manual.pdf
+[3]: https://github.com/GridMod/RTS-GMLC
+[4]: https://matpower.org
+[5]: https://matpower.org/docs/TN3-More-OPF-Derivatives.pdf
+[6]: https://matpower.org/docs/TN4-OPF-Derivatives-Cartesian.pdf
+[7]: https://matpower.org/docs/MATPOWER-manual-7.0.pdf
+[8]: https://matpower.org/docs/MIPS-manual-1.3.pdf
+[9]: https://matpower.org/docs/MOST-manual-1.0.1.pdf
+[10]: https://hub.docker.com/r/matpower/matpower-desktop
+[11]: https://github.com/MATPOWER/matpower-extras
+[12]: https://github.com/MATPOWER/matpower/blob/master/docker/MATPOWER-Docker.md