Release 1.0.1

MATPOWER · Jun 20, 2019 · bab1f48 · bab1f48
1 parent 8efe058
commit bab1f48
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 24 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,8 +2,14 @@ Change history for SynGrid
 ==========================
 
 
-since last release
-------------------
+Version 1.0.1 - *Jun 20, 2019*
+------------------------------
+
+#### 6/20/19
+  - Release 1.0.1.
+  - Add `CITATION` file.
+  - Other miscellaneous documentation updates, e.g. MATPOWER website
+    links updated to https://matpower.org.
 
 #### 1/23/19
   - Fix bug [matpower-extras #3][1], MATLAB incompatibility introduced

diff --git a/CITATION b/CITATION
@@ -19,12 +19,12 @@ acknowledge that fact by citing one or more of the following references:
 
 The SynGrid User's Manual should also be cited explicitly in work that
 refers to or is derived from its content. The citation and DOI can be
-version-specific or general, as appropriate. For version 1.0, use:
+version-specific or general, as appropriate. For version 1.0.1, use:
 
   Z. Wang, H. Sadeghian, S. H. Elyas, R. D. Zimmerman, E. Schweitzer,
-  A. Scaglione. SynGrid User's Manual, Version 1.0. 2018. [Online].
-  Available: https://matpower.org/docs/SynGrid-manual-1.0.pdf
-  doi: 10.5281/zenodo.3238680
+  A. Scaglione. SynGrid User's Manual, Version 1.0.1. 2019. [Online].
+  Available: https://matpower.org/docs/SynGrid-manual-1.0.1.pdf
+  doi: 10.5281/zenodo.3251099
 
 For a version non-specific citation, use the following citation and DOI,
 with <YEAR> replaced by the year of the most recent release:

diff --git a/README.md b/README.md
@@ -186,12 +186,12 @@ acknowledge that fact by citing one or more of the following references:
 
 The [SynGrid User's Manual][6] should also be cited explicitly in work that
 refers to or is derived from its content. The citation and DOI can be
-version-specific or general, as appropriate. For version 1.0, use:
+version-specific or general, as appropriate. For version 1.0.1, use:
 
 >   Z. Wang, H. Sadeghian, S. H. Elyas, R. D. Zimmerman, E. Schweitzer,
-    A. Scaglione. *SynGrid User's Manual, Version 1.0*. 2018. [Online].
-    Available: https://matpower.org/docs/SynGrid-manual-1.0.pdf  
-    doi: [10.5281/zenodo.3238680](https://doi.org/10.5281/zenodo.3238680)
+    A. Scaglione. *SynGrid User's Manual, Version 1.0.1*. 2019. [Online].
+    Available: https://matpower.org/docs/SynGrid-manual-1.0.1.pdf  
+    doi: [10.5281/zenodo.3251099](https://doi.org/10.5281/zenodo.3251099)
 
 For a version non-specific citation, use the following citation and DOI,
 with *\<YEAR\>* replaced by the year of the most recent release:

diff --git a/docs/SynGrid-manual.pdf b/docs/SynGrid-manual.pdf
diff --git a/docs/relnotes/SynGrid-Release-Notes-1.0.1.md b/docs/relnotes/SynGrid-Release-Notes-1.0.1.md
@@ -0,0 +1,18 @@
+What's New in SynGrid 1.0.1
+---------------------------
+
+#### Released June 20, 2019
+
+Below is a summary of the changes since version 1.0 of SynGrid. See the
+[`CHANGES.md`][1] file for all the gory details. For release notes for
+previous versions, see Appendix A of the [SynGrid User's Manual][2].
+
+#### Changes:
+  - Move local functions to private methods for Octave 4.2 compatibility.
+  - Add `CITATION` file.
+  - Other miscellaneous documentation updates, e.g. MATPOWER website
+    links updated to https://matpower.org.
+
+
+[1]: https://github.com/MATPOWER/mx-syngrid/blob/master/CHANGES.md
+[2]: https://github.com/MATPOWER/mx-syngrid/blob/master/docs/SynGrid-manual.pdf
diff --git a/docs/src/SynGrid-manual/SynGrid-manual.tex b/docs/src/SynGrid-manual/SynGrid-manual.tex
@@ -139,7 +139,7 @@
 
 %\hyphenation{matpower}
 
-\newcommand{\mpver}[0]{6.0}
+\newcommand{\mpver}[0]{7.0}
 %\newcommand{\matlab}[0]{{Matlab}}
 %\newcommand{\matlab}[0]{{\sc Matlab}\textsuperscript{\tiny \textregistered}}
 \newcommand{\matlab}[0]{{\sc Matlab}}
@@ -157,10 +157,10 @@
 \newcommand{\mipsurl}[0]{https://github.com/MATPOWER/mips}
 \newcommand{\mipslink}[0]{\href{\mipsurl}{\mips{}}}
 \newcommand{\mipsname}[0]{{{\bf M}{\sc atpower} \textbf{I}nterior \textbf{P}oint \textbf{S}olver}}
-\newcommand{\mipsver}[0]{1.2.2}
+\newcommand{\mipsver}[0]{1.3.1}
 
 \newcommand{\syngrid}[0]{{SynGrid}}
-\newcommand{\syngridver}[0]{1.0}
+\newcommand{\syngridver}[0]{1.0.1}
 \newcommand{\syngridurl}[0]{https://github.com/MATPOWER/mx-syngrid}
 \newcommand{\syngridlink}[0]{\href{\syngridurl}{\syngrid{}}}
 \newcommand{\syngridpath}[1]{\textsf{\textsl{{\relsize{-1.0}\textless{}\mbox{SYNGRID}\textgreater{}}}}\code{{#1}}}
@@ -185,7 +185,7 @@
 \newcommand{\most}[0]{{MOST}}
 \newcommand{\mostname}[0]{{{\bf M}{\sc atpower} \textbf{O}ptimal \textbf{S}cheduling \textbf{T}ool}}
 \newcommand{\mosturl}[0]{https://github.com/MATPOWER/most}
-\newcommand{\mostver}[0]{1.0}
+\newcommand{\mostver}[0]{1.0.2}
 \newcommand{\md}[0]{{\most{} Data struct}}
 \newcommand{\powerweb}[0]{{\sc PowerWeb}}
 \newcommand{\pserc}[0]{{\sc PSerc}}
@@ -200,7 +200,7 @@
 \newcommand{\ot}[0]{{Optimization Toolbox}}
 \newcommand{\pardiso}[0]{{PARDISO}}
 \newcommand{\sdppf}[0]{\texttt{SDP\_PF}}
-\newcommand{\sdppfver}[0]{1.0}
+\newcommand{\sdppfver}[0]{1.0.1}
 \newcommand{\sdpopf}[0]{SDPOPF}
 \newcommand{\lcb}[0]{\char '173}
 \newcommand{\rcb}[0]{\char '175}
@@ -265,7 +265,7 @@
 %%% BEFORE PUBLISHING A NEW VERSION:
 %%%   Update the publication year for \bibitem{matpower} and
 %%%   \bibitem{matpower_manual} to the year of the latest release
-\date{December 18, 2018} % comment this line to display the current date
+\date{June 20, 2019} % comment this line to display the current date
 %\date{December 14, 2011\thanks{Second revision. First revision was December 13, 2011}} % comment this line to display the current date
 
 %%% BEGIN DOCUMENT
@@ -275,7 +275,7 @@
 \vfill
 \begin{center}
 {\scriptsize
-\copyright~2018~individual contributors (see AUTHORS file for details)\\
+\copyright~2018, 2019~individual contributors (see AUTHORS file for details)\\
 All Rights Reserved}
 \end{center}
 
@@ -362,13 +362,13 @@ \subsection{Citing \syngrid{}}
 
 The \syngrid{} User's Manual should also be cited explicitly in work that
 refers to or is derived from its content. The citation and DOI can be
-version-specific or general, as appropriate. For version 1.0, use:
+version-specific or general, as appropriate. For version 1.0.1, use:
 
 \begin{quote}
 \footnotesize
 Z.~Wang, H.~Sadeghian, S.~H. Elyas, R.~D. Zimmerman, E.~Schweitzer,
-A.~Scaglione. \syngrid{} User's Manual, Verision 1.0. 2018. [Online]. Available: \url{https://matpower.org/docs/SynGrid-manual-1.0.pdf}\\
-\doi{10.5281/zenodo.3238680}
+A.~Scaglione. \syngrid{} User's Manual, Verision 1.0.1. 2019. [Online]. Available: \url{https://matpower.org/docs/SynGrid-manual-1.0.1.pdf}\\
+\doi{10.5281/zenodo.3251099}
 \end{quote}
 For a version non-specific citation, use the following citation and DOI,
 with \emph{\textless{}YEAR\textgreater{}} replaced by the year of the most recent release:
@@ -1366,6 +1366,18 @@ \subsection{Version 1.0 -- released December 18, 2018}
 \item Initial release.
 \end{itemize}
 
+\subsection{Version 1.0.1 -- released June 20, 2019}
+\label{app:v10}
+
+The \href{https://matpower.org/docs/SynGrid-manual-1.0.1.pdf}{\syngrid{} 1.0.1 User's Manual} is available online.\footnote{\url{https://matpower.org/docs/SynGrid-manual-1.0.1.pdf}}
+
+\subsubsection*{Changes}
+\begin{itemize}
+\item Move local functions to private methods for Octave 4.2 compatibility.
+\item Add \code{CITATION} file.
+\item Other miscellaneous documentation updates, e.g. \matpower{} website links updated to \url{https://matpower.org}.
+\end{itemize}
+
 
 % %%------------------------------------------
 % \clearpage
@@ -1463,7 +1475,7 @@ \subsection{Version 1.0 -- released December 18, 2018}
 
 \bibitem{syngrid_manual}
 Z.~Wang, H.~Sadeghian, S.~H. Elyas, R.~D. Zimmerman, E.~Schweitzer,
-A.~Scaglione. \syngridman{}. 2018.
+A.~Scaglione. \syngridman{}. 2019.
 [Online]. Available: \url{https://matpower.org/docs/SynGrid-manual.pdf}\\
 \doi{10.5281/zenodo.3238679}
 

diff --git a/lib/sgver.m b/lib/sgver.m
@@ -9,16 +9,16 @@
 %   See also MPVER.
 
 %   SynGrid
-%   Copyright (c) 2018, Power Systems Engineering Research Center (PSERC)
+%   Copyright (c) 2018-2019, Power Systems Engineering Research Center (PSERC)
 %   by Ray Zimmerman, PSERC Cornell
 %
 %   This file is part of SynGrid.
 %   Covered by the 3-clause BSD License (see LICENSE file for details).
 
 v = struct( 'Name',     'SynGrid', ... 
-            'Version',  '1.0', ...
+            'Version',  '1.0.1', ...
             'Release',  '', ...
-            'Date',     '18-Dec-2018' );
+            'Date',     '20-Jun-2019' );
 if nargout > 0
     if nargin > 0
         rv = v;