Release 1.5.1

MATPOWER · May 11, 2024 · bf7a90b · bf7a90b
1 parent c8bee7a
commit bf7a90b
Show file tree

Hide file tree

Showing 11 changed files with 79 additions and 53 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,15 +2,18 @@ Change history for MIPS
 =======================
 
 
-since 1.5
----------
+Version 1.5.1 - *May 10, 2024*
+------------------------------
+
+#### 5/10/24
+  - Release 1.5.1.
 
 #### 4/16/24
   - Add `full_hist` option to enable saving in `output.hist` trajectories
-    of `x`, `z`, `g`, `h`, `lam`, and `mu` (issue [#4][2]).
+    of `x`, `z`, `g`, `h`, `lam`, and `mu` (issue [#4][3]).
 
 #### 3/12/24
-  - Add Sphinx-based Reference documentation.
+  - Add Sphinx-based [Reference documentation][2].
 
 
 Version 1.5 - *Dec 12, 2022*
@@ -287,4 +290,5 @@ Version 1.0b1 - *Dec 24, 2009* (released with MATPOWER 4.0b1)
 
 ----
 [1]: https://travis-ci.org
-[2]: https://github.com/MATPOWER/mips/issues/4
+[2]: https://matpower.org/doc/mips/
+[3]: https://github.com/MATPOWER/mips/issues/4
diff --git a/CITATION b/CITATION
@@ -10,12 +10,12 @@ the following 2007 paper.
 The MATPOWER Interior Point Solver (MIPS) 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.5, use:
+For version 1.5.1, use:
 
   R. D. Zimmerman, H. Wang. MATPOWER Interior Point Solver (MIPS)
-  User's Manual, Version 1.5. 2022. [Online].
-  Available: https://matpower.org/docs/MIPS-manual-1.5.pdf
-  doi: 10.5281/zenodo.7430306
+  User's Manual, Version 1.5.1. 2024. [Online].
+  Available: https://matpower.org/docs/MIPS-manual-1.5.1.pdf
+  doi: 10.5281/zenodo.11176870
 
 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/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 1996-2022, Power Systems Engineering Research Center (PSERC)
+Copyright (c) 1996-2024, Power Systems Engineering Research Center (PSERC)
 and individual contributors (see AUTHORS file for details).
 All rights reserved.
 

diff --git a/README.md b/README.md
@@ -98,12 +98,12 @@ the following 2007 paper.
 The [MATPOWER Interior Point Solver (MIPS) User's Manual][7] 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.5, use:
+For version 1.5.1, use:
 
 >   R. D. Zimmerman, H. Wang. *MATPOWER Interior Point Solver (MIPS)
-    User's Manual, Version 1.5*. 2022. [Online].
-    Available: https://matpower.org/docs/MIPS-manual-1.5.pdf  
-    doi: [10.5281/zenodo.7430306](https://doi.org/10.5281/zenodo.7430306)
+    User's Manual, Version 1.5.1*. 2024. [Online].
+    Available: https://matpower.org/docs/MIPS-manual-1.5.1.pdf  
+    doi: [10.5281/zenodo.11176870](https://doi.org/10.5281/zenodo.11176870)
 
 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/MIPS-manual.pdf b/docs/MIPS-manual.pdf
diff --git a/docs/other/MIPS-Release-Checklist.md b/docs/other/MIPS-Release-Checklist.md
@@ -12,8 +12,12 @@ Pre-release
     up-to-date.
   - Create `docs/relnotes/MIPS-Release-Notes-#.#.md` document from
     Appendix C of `MIPS-manual.tex`.
+- Update date in Copyright line in:
+  - `LICENSE`
+  - `docs/sphinx/source/conf.py`.
 - Update version number and date in:
   - `mipsver.m`
+  - `docs/sphinx/source/conf.py`
   - `lib/Contents.m`
   - `docs/relnotes/MIPS-Release-Notes-#.#.md`
   - `docs/src/MIPS-manual/MIPS-manual.tex`
@@ -24,7 +28,6 @@ Pre-release
   - Sphinx docs
     - `mp-docs-shared/preamble.tex.txt` - \mipsver
     - `mp-docs-shared/prolog.rst.txt` - in URL in raw-html for |MIPSman|
-  - Copyright line in `LICENSE`.
 - In `README.md` and `docs/src/MIPS-manual/MIPS-manual.tex`
   - update output of:
     - `test_mips` in Section 2.2
@@ -37,7 +40,7 @@ Pre-release
   - Make updates for current version specific citations:
     - version number (3 places)
     - year
-    - latest version DOI, current is: 10.5281/zenodo.7430306
+    - latest version DOI, current is: 10.5281/zenodo.11176870
       - (update here each time)
     ... in the following places ...
     - CITATION file
@@ -50,27 +53,26 @@ Pre-release
       - search citations in all other projects being updated simultaneously
         - MATPOWER-manual.tex
         - MP-Opt-Model-manual.tex
-- Create `MIPS-manual.pdf` from `MIPS-manual.tex`
-  - move to `docs`
-  - make copy named `MIPS-manual-x.x.pdf`
-    - copy to `docs` directory of `matpower.org-static` git repo
-      - update `MIPS-manual.pdf` symlink on `https://matpower.org/docs/` to point
-        to new `MIPS-manual-x.x.pdf` (replaces existing current version)
-        - `cd dev/projects/matpower.org-static/docs`
-        - `rm MIPS-manual.pdf`
-        - `ln -s ./MIPS-manual-x.x.pdf MIPS-manual.pdf`
-      - commit & push, then pull to matpower.org
-    - upload `MIPS-manual-x.x.pdf` to Zenodo and finish entry for "New Version"
-      - update:
-        - Publication date
-        - Version
-        - Identifiers:
-          - version number in "identical to"
-  - add link on `https://matpower.org/doc/manuals/` page
+- Create `MIPS-manual.pdf` from `MIPS-manual.tex` and move to `docs`.
 - Add release notice with date and version in `CHANGES.md`.
 - Commit all changes to `prep-for-release`.
 - Push `prep-for-release` to GitHub.
 - Make sure CI checks are ok.
+- Make copy of `docs/MIPS-manual.pdf` named `MIPS-manual-x.x.pdf`
+  - copy to `docs` directory of `matpower.org-static` git repo
+    - update `MIPS-manual.pdf` symlink on `https://matpower.org/docs/` to point
+      to new `MIPS-manual-x.x.pdf` (replaces existing current version)
+      - `cd dev/projects/matpower.org-static/docs`
+      - `rm MIPS-manual.pdf`
+      - `ln -s ./MIPS-manual-x.x.pdf MIPS-manual.pdf`
+    - commit & push, then pull to matpower.org
+  - upload `MIPS-manual-x.x.pdf` to Zenodo and finish entry for "New Version"
+    - update:
+      - Publication date
+      - Version
+      - Identifiers:
+        - version number in "identical to"
+- Add link on `https://matpower.org/doc/manuals/` page
 
 
 Release

diff --git a/docs/relnotes/MIPS-Release-Notes-1.5.1.md b/docs/relnotes/MIPS-Release-Notes-1.5.1.md
@@ -0,0 +1,20 @@
+What's New in MIPS 1.5.1
+------------------------
+
+#### Released May 10, 2024
+
+Below is a summary of the changes since version 1.5 of MIPS. See the
+[`CHANGES.md`][1] file for all the gory details. For release notes for
+previous versions, see Appendix C of the [MIPS User's Manual][2].
+
+#### New Features:
+  - Add Sphinx-based [Reference documentation][3].
+  - Add `full_hist` option to enable saving in `output.hist`
+    trajectories of `x`, `z`, `g`, `h`, `lam`, and `mu`
+    ([issue #4][4]).
+
+
+[1]: ../../CHANGES.md
+[2]: ../MIPS-manual.pdf
+[3]: https://matpower.org/doc/mips/
+[4]: https://github.com/MATPOWER/mips/issues/4
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Ray D. Zimmerman, Hongye Wang'
 
 # The full version, including alpha/beta/rc tags
-release = '1.5+'
+release = '1.5.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/src/MIPS-manual/MIPS-manual.tex b/docs/src/MIPS-manual/MIPS-manual.tex
@@ -140,22 +140,22 @@
 \newcommand{\mptest}[0]{{MP-Test}}
 \newcommand{\mptesturl}[0]{https://github.com/MATPOWER/mptest}
 \newcommand{\mptestlink}[0]{\href{\mptesturl}{\mptest{}}}
-\newcommand{\mptestver}[0]{8.0b1}
+\newcommand{\mptestver}[0]{8.0}
 \newcommand{\mips}[0]{{MIPS}}
 \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.5}
+\newcommand{\mipsver}[0]{1.5.1}
 \newcommand{\mpom}[0]{\mbox{MP-Opt-Model}}
 \newcommand{\mpomurl}[0]{https://github.com/MATPOWER/mp-opt-model}
 \newcommand{\mpomlink}[0]{\href{\mpomurl}{\mpom{}}}
 \newcommand{\mpomname}[0]{\mpom{}}
 % \newcommand{\mpomname}[0]{{{\bf M}{\sc at}{\bf P}{\sc ower} \textbf{Opt}imization \textbf{Model}}}
-\newcommand{\mpomver}[0]{4.1}
+\newcommand{\mpomver}[0]{4.2}
 \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.2}
+\newcommand{\mostver}[0]{1.3}
 \newcommand{\md}[0]{{\most{} Data struct}}
 \newcommand{\powerweb}[0]{{\sc PowerWeb}}
 \newcommand{\pserc}[0]{{\sc PSerc}}
@@ -228,7 +228,7 @@
 \title{\mipsname{}\\\mips{} \mipsver{}\\
 User's Manual}
 \author{Ray~D.~Zimmerman \and Hongye~Wang}
-%\date{December 12, 2022} % comment this line to display the current date
+\date{May 10, 2024} % 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
@@ -238,7 +238,7 @@
 \vfill
 \begin{center}
 {\scriptsize
-\copyright~2009--2022~\PSERC{}\\
+\copyright~2009--2024~\PSERC{}\\
 All Rights Reserved}
 \end{center}
 
@@ -322,13 +322,13 @@ \subsection{Citing \mips{}}
 
 The \mipsname{} (\mips{}) User's Manual~\cite{mips_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.5,
+DOI can be version-specific or general, as appropriate. For version 1.5.1,
 use:
 
 \begin{quote}
 \footnotesize
-R.~D. Zimmerman, H.~Wang. \mipsname{} (\mips{}) User's Manual, Version 1.5. 2022. [Online]. Available: \url{https://matpower.org/docs/MIPS-manual-1.5.pdf}\\
-\doi{10.5281/zenodo.7430306}
+R.~D. Zimmerman, H.~Wang. \mipsname{} (\mips{}) User's Manual, Version 1.5.1. 2024. [Online]. Available: \url{https://matpower.org/docs/MIPS-manual-1.5.1.pdf}\\
+\doi{10.5281/zenodo.11176870}
 \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:
@@ -681,7 +681,7 @@ \subsection{Example 2}
 \end{Code}
 \begin{Code}
 >> mips_example2
-MATPOWER Interior Point Solver -- MIPS, Version 1.5, 12-Dec-2022
+MATPOWER Interior Point Solver -- MIPS, Version 1.5.1, 10-May-2024
  (using built-in linear solver)
  it    objective   step size   feascond     gradcond     compcond     costcond  
 ----  ------------ --------- ------------ ------------ ------------ ------------
@@ -1328,14 +1328,14 @@ \subsubsection*{New Features}
 \end{itemize}
 
 
-\subsection{Version 1.5.x -- released xxx xx, 202x}
-\label{app:v15x}
+\subsection{Version 1.5.1 -- released May 10, 2024}
+\label{app:v151}
 
-The \href{https://matpower.org/docs/MIPS-manual-1.5.x.pdf}{\mips{} 1.5.x User's Manual} is available online.\footnote{\url{https://matpower.org/docs/MIPS-manual-1.5.x.pdf}}
+The \href{https://matpower.org/docs/MIPS-manual-1.5.1.pdf}{\mips{} 1.5.1 User's Manual} is available online.\footnote{\url{https://matpower.org/docs/MIPS-manual-1.5.1.pdf}}
 
 \subsubsection*{New Features}
 \begin{itemize}
-\item Add Sphinx-based Reference documentation.
+\item Add Sphinx-based Reference documentation.\footnote{\url{https://matpower.org/doc/mips/}}
 \item Add \code{full\_hist} option to enable saving in \code{output.hist}
     trajectories of \code{x}, \code{z}, \code{g}, \code{h}, \code{lam}, and
     \code{mu} (issue \#4).
@@ -1403,7 +1403,7 @@ \subsubsection*{New Features}
 \doi{10.5281/zenodo.3236535}
 
 \bibitem{mips_manual}
-R.~D. Zimmerman, H.~Wang. \mipsname{} (\mips{}) User's Manual. 2022.
+R.~D. Zimmerman, H.~Wang. \mipsname{} (\mips{}) User's Manual. 2024.
 [Online]. Available: \url{https://matpower.org/docs/MIPS-manual.pdf}\\
 \doi{10.5281/zenodo.3236506}
 

diff --git a/lib/Contents.m b/lib/Contents.m
@@ -1,5 +1,5 @@
 % MIPS
-%   Version 1.5         12-Dec-2022
+%   Version 1.5.1       10-May-2024
 %
 %   The MATPOWER Interior Point Solver (MIPS) is a package of MATLAB/Octave
 %   M-files for solving non-linear programming problems (NLPs) using a
@@ -15,7 +15,7 @@
 %   MIPS is covered by the 3-clause BSD License (see LICENSE for details).
 
 %   MIPS
-%   Copyright (c) 2010-2022, Power Systems Engineering Research Center (PSERC)
+%   Copyright (c) 2010-2024, Power Systems Engineering Research Center (PSERC)
 %   by Ray Zimmerman, PSERC Cornell
 %
 %   This file is part of MIPS.

diff --git a/lib/mipsver.m b/lib/mipsver.m
@@ -24,9 +24,9 @@
 %   See https://github.com/MATPOWER/mips for more info.
 
 v = struct( 'Name',     'MIPS', ... 
-            'Version',  '1.5+', ...
+            'Version',  '1.5.1', ...
             'Release',  '', ...
-            'Date',     '16-Apr-2024' );
+            'Date',     '10-May-2024' );
 if nargout > 0
     if nargin > 0
         rv = v;