Release/v6.3.0 (#185)

* bump version

* add release PR template with checklist

* add a step to template

* add step about Spack

* fix updateVersion script handling of CITATIONS.md

* run release tests on release PR

Co-authored-by: David J. Gardner <gardner48@llnl.gov>

.github/PULL_REQUEST_TEMPLATE/release.md

@@ -0,0 +1,50 @@
+This is a list of tasks that need to be done before a SUNDIALS release.
+
+## Before Merging
+
+- [ ] Create release branch from develop in the Git repository
+
+- [ ] If this is a major release, search the SUNDIALS code for 'DEPRECATION NOTICE' and 'SUNDIALS_DEPRECATED'. All deprecated functions should be removed (unless this is the first version that they are deprecated).
+
+- [ ] Regenerate the Fortran 2003 interfaces. It is possible nothing will be updated.
+
+- [ ] Update the "Changes in ..." sections in all user guides. The changes should be sorted so that major new features are above bug fixes.
+
+- [ ] Update version numbers and release date information using the `updateVerson.sh` script. This will update the following files:
+
+   * `CITATIONS.md`
+   * `CHANGELOG.md`
+   * `CMakeLists.txt`
+   * `README.md`
+   * `src/arkode/README`
+   * `src/cvode/README`
+   * `src/cvodes/README`
+   * `src/ida/README`
+   * `src/idas/README`
+   * `src/kinsol/README`
+   * `doc/arkode/examples/source/conf.py`
+   * `doc/shared/versions.py`
+   * `doc/shared/History.rst`
+   * `doc/shared/sundials.bib`
+   * `doc/sundials/biblio.bib`
+   * `scripts/tarscript`
+
+   The following files are no longer maintaianed:
+
+   * `html/main.html` (This is no longer maintained as of at least 2016)
+   * `sundialsTB/install_STB.m` (This is no longer maintained as of 2016)
+
+- [ ] Update version numbers of third party libraries in the Install Guide in doc directory.
+
+## After Merging
+
+- [ ] Tag the release on main
+
+- [ ] Sync develop with main
+
+- [ ] Update internal web pages for SUNDIALS:
+   https://computing-staging.llnl.gov/user
+
+- [ ] After web changes are pushed to production, verify content and functionality of https://computing.llnl.gov/projects/sundials.
+
+- [ ] Add the new release to the SUNDIALS Spack package

CHANGELOG.md

@@ -1,6 +1,6 @@
 # SUNDIALS Changelog
 
-## Changes to SUNDIALS in release x.x.x
+## Changes to SUNDIALS in release 6.3.0
 
 Added `GetUserData` functions in each package to retrieve the user data pointer
 provided to `SetUserData` functions. See `ARKStepGetUserData`,

CITATIONS.md

@@ -62,7 +62,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Cody J. Balos},
   title  = {User Documentation for ARKODE},
   year   = {2022},
-  note   = {v5.2.0}
+  note   = {v5.3.0}
 }
 ```
 
@@ -71,7 +71,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for CVODE},
   year   = {2022},
-  note   = {v6.2.0}
+  note   = {v6.3.0}
 }
 ```
 
@@ -80,7 +80,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for CVODES},
   year   = {2022},
-  note   = {v6.2.0}
+  note   = {v6.3.0}
 }
 ```
 
@@ -89,7 +89,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for IDA},
   year   = {2022},
-  note   = {v6.2.0}
+  note   = {v6.3.0}
 }
 ```
 
@@ -98,7 +98,7 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for IDAS},
   year   = {2022},
-  note   = {v5.2.0}
+  note   = {v5.3.0}
 }
 ```
 
@@ -107,6 +107,6 @@ they are using rather than the combined SUNDIALS online guide:
   author = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
   title  = {User Documentation for KINSOL},
   year   = {2022},
-  note   = {v6.2.0}
+  note   = {v6.3.0}
 }
 ```

CMakeLists.txt

@@ -42,7 +42,7 @@ include(FindPackageHandleStandardArgs)
 # Set some variables with info on the SUNDIALS project
 set(PACKAGE_BUGREPORT "sundials-users@llnl.gov")
 set(PACKAGE_NAME "SUNDIALS")
-set(PACKAGE_STRING "SUNDIALS 6.2.0")
+set(PACKAGE_STRING "SUNDIALS 6.3.0")
 set(PACKAGE_TARNAME "sundials")
 
 # Set SUNDIALS version numbers
@@ -51,7 +51,7 @@ message(STATUS "SUNDIALS_GIT_VERSION: ${SUNDIALS_GIT_VERSION}")
 
 # (use "" for the version label if none is needed)
 set(PACKAGE_VERSION_MAJOR "6")
-set(PACKAGE_VERSION_MINOR "2")
+set(PACKAGE_VERSION_MINOR "3")
 set(PACKAGE_VERSION_PATCH "0")
 set(PACKAGE_VERSION_LABEL "")
 
@@ -67,37 +67,37 @@ endif()
 
 # Specify the VERSION and SOVERSION for shared libraries
 
-set(arkodelib_VERSION "5.2.0")
+set(arkodelib_VERSION "5.3.0")
 set(arkodelib_SOVERSION "5")
 
-set(cvodelib_VERSION "6.2.0")
+set(cvodelib_VERSION "6.3.0")
 set(cvodelib_SOVERSION "6")
 
-set(cvodeslib_VERSION "6.2.0")
+set(cvodeslib_VERSION "6.3.0")
 set(cvodeslib_SOVERSION "6")
 
-set(idalib_VERSION "6.2.0")
+set(idalib_VERSION "6.3.0")
 set(idalib_SOVERSION "6")
 
-set(idaslib_VERSION "5.2.0")
+set(idaslib_VERSION "5.3.0")
 set(idaslib_SOVERSION "5")
 
-set(kinsollib_VERSION "6.2.0")
+set(kinsollib_VERSION "6.3.0")
 set(kinsollib_SOVERSION "6")
 
 set(cpodeslib_VERSION "0.0.0")
 set(cpodeslib_SOVERSION "0")
 
-set(nveclib_VERSION "6.2.0")
+set(nveclib_VERSION "6.3.0")
 set(nveclib_SOVERSION "6")
 
-set(sunmatrixlib_VERSION "4.2.0")
+set(sunmatrixlib_VERSION "4.3.0")
 set(sunmatrixlib_SOVERSION "4")
 
-set(sunlinsollib_VERSION "4.2.0")
+set(sunlinsollib_VERSION "4.3.0")
 set(sunlinsollib_SOVERSION "4")
 
-set(sunnonlinsollib_VERSION "3.2.0")
+set(sunnonlinsollib_VERSION "3.3.0")
 set(sunnonlinsollib_SOVERSION "3")
 
 set(sundialslib_VERSION

README.md

@@ -1,5 +1,5 @@
 # SUNDIALS: SUite of Nonlinear and DIfferential/ALgebraic equation Solvers #
-### Version 6.2.0 (Apr 2022) ###
+### Version 6.3.0 (Aug 2022) ###
 
 **Center for Applied Scientific Computing, Lawrence Livermore National Laboratory**
 

doc/shared/History.rst

@@ -21,6 +21,8 @@ Appendix: SUNDIALS Release History
 +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Date     | SUNDIALS          | ARKODE            | CVODE             | CVODES            | IDA               | IDAS              | KINSOL            |
 +==========+===================+===================+===================+===================+===================+===================+===================+
+| Aug 2022 | 6.3.0             | 5.3.0             | 6.3.0             | 6.3.0             | 6.3.0             | 5.3.0             | 6.3.0             |
++----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Apr 2022 | 6.2.0             | 5.2.0             | 6.2.0             | 6.2.0             | 6.2.0             | 5.2.0             | 6.2.0             |
 +----------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+-------------------+
 | Feb 2022 | 6.1.1             | 5.1.1             | 6.1.1             | 6.1.1             | 6.1.1             | 5.1.1             | 6.1.1             |

doc/shared/sundials.bib

@@ -27,7 +27,7 @@
 %
 @techreport{arkode_ug,
 author      = {Daniel R. Reynolds and David J. Gardner and Carol S. Woodward and Rujeko Chinomona and Cody J. Balos},
-title       = {{User Documentation for ARKODE v5.2.0}},
+title       = {{User Documentation for ARKODE v5.3.0}},
 institution = {LLNL},
 number      = {LLNL-SM-668082},
 year        = 2022
@@ -37,7 +37,7 @@ @techreport{arkode_ug
 %
 @techreport{arkode_ex,
 author      = {Daniel R. Reynolds},
-title       = {{Example Programs for ARKODE v5.2.0}},
+title       = {{Example Programs for ARKODE v5.3.0}},
 institution = {Southern Methodist University},
 year        = 2022
 }
@@ -46,7 +46,7 @@ @techreport{arkode_ex
 %
 @techreport{cvode_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for CVODE v6.2.0}},
+title       = {{User Documentation for CVODE v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208108},
 year        = 2022
@@ -56,7 +56,7 @@ @techreport{cvode_ug
 %
 @techreport{cvode_ex,
 author      = {Alan C. Hindmarsh and Radu Serban},
-title       = {{Example Programs for CVODE v6.2.0}},
+title       = {{Example Programs for CVODE v6.3.0}},
 institution = {LLNL},
 note        = {UCRL-SM-208110},
 year        = 2022
@@ -66,7 +66,7 @@ @techreport{cvode_ex
 %
 @techreport{cvodes_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for CVODES v6.2.0}},
+title       = {{User Documentation for CVODES v6.3.0}},
 institution = {LLNL},
 note        = {UCRL-SM-208111},
 year        = 2022
@@ -76,7 +76,7 @@ @techreport{cvodes_ug
 %
 @techreport{cvodes_ex,
 author      = {Radu Serban and Alan C. Hindmarsh},
-title       = {{Example Programs for CVODES v6.2.0}},
+title       = {{Example Programs for CVODES v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208115},
 year        = 2022
@@ -86,7 +86,7 @@ @techreport{cvodes_ex
 %
 @techreport{ida_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for IDA v6.2.0}},
+title       = {{User Documentation for IDA v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208112},
 year        = 2022
@@ -96,7 +96,7 @@ @techreport{ida_ug
 %
 @techreport{ida_ex,
 author      = {Alan C. Hindmarsh and Radu Serban and Aaron Collier},
-title       = {{Example Programs for IDA v6.2.0}},
+title       = {{Example Programs for IDA v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208113},
 year        = 2022
@@ -106,7 +106,7 @@ @techreport{ida_ex
 %
 @techreport{idas_ug,
 author      = {Radu Serban and Cosmin Petra and Alan C. Hindmarsh and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for IDAS v5.2.0}},
+title       = {{User Documentation for IDAS v5.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-234051},
 year        = 2022
@@ -116,7 +116,7 @@ @techreport{idas_ug
 %
 @techreport{idas_ex,
 author      = {Radu Serban and Alan C. Hindmarsh},
-title       = {{Example Programs for IDAS v5.2.0}},
+title       = {{Example Programs for IDAS v5.3.0}},
 institution = {LLNL},
 number      = {LLNL-TR-437091},
 year        = 2022
@@ -126,7 +126,7 @@ @techreport{idas_ex
 %
 @techreport{kinsol_ug,
 author      = {Alan C. Hindmarsh and Radu Serban and Cody J. Balos and David J. Gardner and Daniel R. Reynolds and Carol S. Woodward},
-title       = {{User Documentation for KINSOL v6.2.0}},
+title       = {{User Documentation for KINSOL v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208116},
 year        = 2022
@@ -136,7 +136,7 @@ @techreport{kinsol_ug
 %
 @techreport{kinsol_ex,
 author      = {Aaron M. Collier and Radu Serban},
-title       = {{Example Programs for KINSOL v6.2.0}},
+title       = {{Example Programs for KINSOL v6.3.0}},
 institution = {LLNL},
 number      = {UCRL-SM-208114},
 year        = 2022

doc/shared/versions.py

@@ -9,11 +9,11 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # SUNDIALS Copyright End
 # ----------------------------------------------------------------
-sundials_version = 'v6.2.0'
-arkode_version = 'v5.2.0'
-cvode_version = 'v6.2.0'
-cvodes_version = 'v6.2.0'
-ida_version = 'v6.2.0'
-idas_version = 'v5.2.0'
-kinsol_version = 'v6.2.0'
+sundials_version = 'v6.3.0'
+arkode_version = 'v5.3.0'
+cvode_version = 'v6.3.0'
+cvodes_version = 'v6.3.0'
+ida_version = 'v6.3.0'
+idas_version = 'v5.3.0'
+kinsol_version = 'v6.3.0'
 year = '2022'