Release 1.3

MATPOWER · May 11, 2024 · c802720 · c802720
1 parent dd9cbcb
commit c802720
Show file tree

Hide file tree

Showing 13 changed files with 888 additions and 817 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,8 +2,11 @@ Change history for MOST
 =======================
 
 
-since 1.2
----------
+Version 1.3 - *May 10, 2024*
+----------------------------
+
+#### 5/10/24
+ - Release 1.3.
 
 #### 4/4/24
  - Tweak tests to avoid warnings and presolve bug with new HiGHS-based

diff --git a/CITATION b/CITATION
@@ -17,12 +17,12 @@ Scheduling Tool (MOST) explicitly acknowledge that fact by citing both the
 The MATPOWER Optimal Scheduling Tool (MOST) 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.2, use:
+For version 1.3, use:
 
  R. D. Zimmerman, C. E. Murillo-Sanchez. MATPOWER Optimal Scheduling
- Tool (MOST) User's Manual, Version 1.2. 2022. [Online].
- Available: https://matpower.org/docs/MOST-manual-1.2.pdf
- doi: 10.5281/zenodo.7434827
+ Tool (MOST) User's Manual, Version 1.3. 2024. [Online].
+ Available: https://matpower.org/docs/MOST-manual-1.3.pdf
+ doi: 10.5281/zenodo.11177189
 
 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
@@ -141,12 +141,12 @@ citing both the 2011 MATPOWER paper and the 2013 MOST paper.
 The [MATPOWER Optimal Scheduling Tool (MOST) 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.2, use:
+appropriate. For version 1.3, use:
 
 >  R. D. Zimmerman, C. E. Murillo-Sanchez. *MATPOWER Optimal Scheduling
- Tool (MOST) User's Manual, Version 1.2*. 2022. [Online].
- Available: https://matpower.org/docs/MOST-manual-1.2.pdf 
- doi: [10.5281/zenodo.7434827](https://doi.org/10.5281/zenodo.7434827)
+ Tool (MOST) User's Manual, Version 1.3*. 2024. [Online].
+ Available: https://matpower.org/docs/MOST-manual-1.3.pdf 
+ doi: [10.5281/zenodo.11177189](https://doi.org/10.5281/zenodo.11177189)
 
 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/MOST-manual.pdf b/docs/MOST-manual.pdf
diff --git a/docs/other/MOST-Release-Checklist.md b/docs/other/MOST-Release-Checklist.md
@@ -12,8 +12,12 @@ Pre-release
  up-to-date.
  - Create `docs/relnotes/MOST-Release-Notes-#.#.md` document from
  Appendix B of `MOST-manual.tex`.
+- Update date in Copyright line in:
+ - `LICENSE`
+ - `docs/sphinx/source/conf.py`.
 - Update version number and date in:
  - `mostver.m`
+ - `docs/sphinx/source/conf.py`
  - `most.m` (copyright line in printout)
  - `lib/Contents.m`
  - `docs/relnotes/MOST-Release-Notes-#.#.md`
@@ -25,7 +29,6 @@ Pre-release
  - Sphinx docs
  - `mp-docs-shared/preamble.tex.txt` - \mostver
  - `mp-docs-shared/prolog.rst.txt` - in URL in raw-html for |MOSTman|
- - Copyright line in `LICENSE`.
 - In `README.md` and `docs/src/MOST-manual/MOST-manual.tex`
  - update output of `test_most` in Section 2.2
  - may require first doing:
@@ -58,7 +61,7 @@ Pre-release
  - Make updates for current version specific citations:
  - version number (3 places)
  - year
- - latest version DOI, current is: 10.5281/zenodo.7434827
+ - latest version DOI, current is: 10.5281/zenodo.11177189
  - (update here each time)
  ... in the following places ...
  - CITATION file
@@ -69,32 +72,31 @@ Pre-release
  - search everywhere for 10.5281/zenodo.3236531 and update year
  - User's Manual
  - search citations in all other projects being updated simultaneously
- (does not exist as of 6/20/19)
+ - MATPOWER User's Manual
  - search everywhere for 10.5281/zenodo.3236519 and update year (MATPOWER User's Manual)
  - User's Manual
 - Copy latest `MATPOWER-manual.aux` to `docs/src/MOST-manual` for
  `\externaldocument`
-- Create `MOST-manual.pdf` from `MOST-manual.tex`
- - move to `docs`
- - make copy named `MOST-manual-x.x.pdf`
- - copy to `docs` directory of `matpower.org-static` git repo
- - update `MOST-manual.pdf` symlink on `https://matpower.org/docs/` to point
- to new `MOST-manual-x.x.pdf` (replaces existing current version)
- - `cd dev/projects/matpower.org-static/docs`
- - `rm MOST-manual.pdf`
- - `ln -s ./MOST-manual-x.x.pdf MOST-manual.pdf`
- - commit & push, then pull to matpower.org
- - upload `MOST-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 `MOST-manual.pdf` from `MOST-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 named `MOST-manual-x.x.pdf`
+ - copy to `docs` directory of `matpower.org-static` git repo
+ - update `MOST-manual.pdf` symlink on `https://matpower.org/docs/` to point
+ to new `MOST-manual-x.x.pdf` (replaces existing current version)
+ - `cd dev/projects/matpower.org-static/docs`
+ - `rm MOST-manual.pdf`
+ - `ln -s ./MOST-manual-x.x.pdf MOST-manual.pdf`
+ - commit & push, then pull to matpower.org
+ - upload `MOST-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/MOST-Release-Notes-1.3.md b/docs/relnotes/MOST-Release-Notes-1.3.md
@@ -0,0 +1,39 @@
+What's New in MOST 1.3
+----------------------
+
+#### Released May 10, 2024
+
+Below is a summary of the changes since version 1.2 of MOST. See the
+[`CHANGES.md`][1] file for all the gory details. For release notes for
+previous versions, see Appendix B of the [MOST User's Manual][2].
+
+#### New Features:
+ - New Sphinx-based [Reference documentation][3].
+
+#### Changes:
+ - Reduce memory requirements for long horizon cases with storage by
+ forming/storing transposes of matrices for storage constraints.
+ *Requires [MP-Opt-Model][4] 4.2 or later.*
+ - Speed up building unit commitment (min up/down time) constraints.
+ Improvement can be quite substantial on large problems.
+
+#### Bugs Fixed:
+ - Fix [issue #37][5] which caused a fatal error in storage input
+ checks with multiple storage units under some circumstances.
+ *Thanks to Keir Steegstra.*
+ - Fix [issue #39][6] in which the value of `mdi.Delta_T`, the number
+ of hours represented by each period, was not being accounted for in
+ most of the terms in the objective function.
+ *Thanks to Stefano Nicolin.*
+
+#### Incompatible Changes:
+ - Remove extra column in `mdo.results.ExpectedRampCost` and ignore for
+ single period.
+
+
+[1]: ../../CHANGES.md
+[2]: ../MOST-manual.pdf
+[3]: https://matpower.org/doc/most/
+[4]: https://github.com/MATPOWER/mp-opt-model/
+[5]: https://github.com/MATPOWER/most/issues/37
+[6]: https://github.com/MATPOWER/most/issues/39
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -22,7 +22,7 @@
 author = 'Ray D. Zimmerman, Carlos E. Murillo-Sánchez'
 
 # The full version, including alpha/beta/rc tags
-release = '1.3+'
+release = '1.3'
 
 
 # -- General configuration ---------------------------------------------------