Skip to content

Commit

Permalink
Update version, date, etc. where missed.
Browse files Browse the repository at this point in the history
  • Loading branch information
rdzman committed May 21, 2024
1 parent e619141 commit aa8af4f
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
6 changes: 6 additions & 0 deletions docker/Docker-Build-Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,12 @@ When a new MATPOWER version _X.Y_ is released ...
docker tag matpower/matpower:<X.Y> matpower/matpower:<X.Y>c
```

- Push to [Docker Hub][4].
```
docker push matpower/matpower:<X.Y>
docker push matpower/matpower:<X.Y>c
docker push matpower/matpower:latest
```
To build a new MATPOWER image from the latest `master` branch ...
```
docker build --build-arg MP_SRC=github -f docker/Dockerfile -t matpower/matpower:dev-<YYYY-MM-DD> .
Expand Down
2 changes: 1 addition & 1 deletion docker/MATPOWER-Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ GitHub repositories.
| **_release versions_** | | |
| `latest` | _current release_ | _current release_ |
| `<X.Y>c` | _X.Y_ | _current release_ |
| `8.0b1` | 8.0b1 | 7.3.0 |
| `8.0` | 8.0 | 9.1.0 |
| `7.1` | 7.1 | 5.2.0 |
| `7.0` | 7.0 | 5.1.0 |
| `6.0` | 6.0 | 4.2.2 |
Expand Down
24 changes: 14 additions & 10 deletions docs/other/MATPOWER-Release-Checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ Pre-release
`docs/relnotes/MATPOWER-Release-Notes-#.#.md`.
- Update version number and date in:
- `mpver.m`
- `docs/sphinx/source/conf.py`
- version in `release = 'X.Y'`
- date in `latex_elements.maketitle`
- `lib/Contents.m`
- `docs/relnotes/MATPOWER-Release-Notes-#.#.md`
- `docs/relnotes/MATPOWER-Announce-#.#.md`
Expand Down Expand Up @@ -96,7 +99,7 @@ Pre-release
- CITATION file
- Citing ... section of README.md
- Citing ... section of User's Manual
- Citing ... section of website (https://matpower.org/citing/)
- Citing ... section of website (https://matpower.org/citing/), (use code editor)
- Make updates for non-version specific citations:
- search everywhere for 10.5281/zenodo.3236535 and update year
- User's Manual
Expand Down Expand Up @@ -141,7 +144,7 @@ Release
- Push `master` to GitHub.
- create archive with MATPOWER-Extras
- `cd matpower/untracked/`
- `ship_it.sh 7.0b1`
- `ship_it.sh 8.0`
- (obsolete) copy resulting `matpower#.#.zip` file to
`https://matpower.org/downloads/#.#/`
- upload to Zenodo and finish entry for "New Version"
Expand All @@ -162,7 +165,7 @@ Release
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3236535.svg)](https://doi.org/10.5281/zenodo.3236535)

Version Specific DOI:
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3251119.svg)](https://doi.org/10.5281/zenodo.3251119)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11212330.svg)](https://doi.org/10.5281/zenodo.11212330)
- (obsolete)
- Add version number to
- `https://matpower.org/sw-download-config.php`
Expand Down Expand Up @@ -209,13 +212,14 @@ Post-release
- comment out date line so it uses current date
- new dev version number
- update web site
- `cd /usr/local/matpower/dist`
- `git clone --branch 7.1 [email protected]:MATPOWER/matpower.git matpower-version7_1`
- `cd /usr/local/matpower/dist/matpower-version7_1`
- `rm -rf .git`
- `git clone --branch 7.1 [email protected]:MATPOWER/matpower-extras.git extras`
- `cd extras`
- `rm -rf .git`
- add official release version on local machine
- `cd /usr/local/matpower/dist`
- `git clone --branch 8.0 [email protected]:MATPOWER/matpower.git matpower-version8_0`
- `cd /usr/local/matpower/dist/matpower-version8_0`
- `rm -rf .git`
- `git clone --branch 8.0 [email protected]:MATPOWER/matpower-extras.git extras`
- `cd extras`
- `rm -rf .git`


To create the Online Function Reference
Expand Down
8 changes: 4 additions & 4 deletions docs/sphinx/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
author = 'Ray D. Zimmerman, Carlos E. Murillo-Sánchez, Hongye Wang, et. al.'

# The full version, including alpha/beta/rc tags
release = '8.0b1'
release = '8.0'


# -- General configuration ---------------------------------------------------
Expand Down Expand Up @@ -130,12 +130,12 @@
( 'dev-manual/index',
'matpower_dev_manual.tex',
'\\matpower{} \\textrm{Developers\'s Manual}',
'Ray D. Zimmerman, et. al.',\
'Ray D. Zimmerman',\
'manual'),
( 'ref-manual/index',
'matpower_ref_manual.tex',
'\\matpower{} \\textrm{Reference Manual}',
'Ray D. Zimmerman, et. al.',\
'Ray D. Zimmerman',\
'manual'),
# ( 'users-manual-legacy/index',
# 'matpower_users_manual_legacy.tex',
Expand All @@ -151,7 +151,7 @@
'printindex': r'\footnotesize\raggedright\printindex',
'maxlistdepth': '8',
'extraclassoptions': 'openany', # chapters can start on any page
'maketitle': r'\date{May 7, 2024}\newcommand\sphinxbackoftitlepage{\begin{center}{~\vfill\copyright~1996--2024~\PSERC\\All Rights Reserved}\end{center}}\sphinxmaketitle',
'maketitle': r'\date{May 17, 2024}\newcommand\sphinxbackoftitlepage{\begin{center}{~\vfill\copyright~1996--2024~\PSERC\\All Rights Reserved}\end{center}}\sphinxmaketitle',
'extrapackages': r"""\usepackage{bm}
\usepackage{upgreek}
\usepackage{amsfonts}
Expand Down
6 changes: 3 additions & 3 deletions docs/sphinx/source/howto/three-phase.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ Below is an example run.

>> mpopt = mpoption('verbose', 2);
>> run_pf('t_case3p_a', mpopt, 'mpx', mp.xt_3p)
MATPOWER Version 8.0b1+, 15-Feb-2024

MATPOWER Version 8.0, 17-May-2024
Power Flow -- AC-polar-power formulation
it max residual max ∆x
Expand All @@ -35,7 +35,7 @@ Below is an example run.
Newton's method converged in 5 iterations.
PF successful
PF succeeded in 0.23 seconds (0.22 setup + 0.01 solve)
PF succeeded in 0.17 seconds (0.16 setup + 0.01 solve)
================================================================================
| System Summary |
================================================================================
Expand Down

0 comments on commit aa8af4f

Please sign in to comment.