Merge branch 'develop' into cmake/lapack-target

README.md

@@ -15,50 +15,62 @@ equation (ODE) systems, differential-algebraic equation (DAE) systems, and
 nonlinear algebraic systems:
 
 * ARKODE - for integrating stiff, nonstiff, and multirate ODEs of the form
+
   $$M(t) \\, y' = f_1(t,y) + f_2(t,y), \quad y(t_0) = y_0$$
 
 * CVODE - for integrating stiff and nonstiff ODEs of the form
+
   $$y' = f(t,y), \quad y(t_0) = y_0$$
 
 * CVODES - for integrating and sensitivity analysis (forward and adjoint) of
   ODEs of the form
+
   $$y' = f(t,y,p), \quad y(t_0) = y_0(p)$$
 
 * IDA - for integrating DAEs of the form
+
   $$F(t,y,y') = 0, \quad y(t_0) = y_0, \quad y'(t_0) = y_0'$$
 
 * IDAS - for integrating and sensitivity analysis (forward and adjoint) of DAEs
   of the form
+
   $$F(t,y,y',p) = 0, \quad y(t_0) = y_0(p), \quad y'(t_0) = y_0'(p)$$
 
 * KINSOL - for solving nonlinear algebraic systems of the form
+
   $$F(u) = 0 \quad \text{or} \quad G(u) = u$$
 
 ## Installation ##
 
-For installation directions see the [online install guide](https://sundials.readthedocs.io/en/latest/Install_link.html),
-the installation chapter in any of the package user guides, or INSTALL_GUIDE.pdf.
+For installation directions, see the [getting started](https://sundials.readthedocs.io/en/latest/sundials/index.html#getting-started)
+section in the online documentation. In the [released tarballs](https://github.com/LLNL/sundials/releases),
+installation directions are also available in `INSTALL_GUIDE.pdf` and the
+installation chapter of the user guides in the `doc` directory.
 
 Warning to users who receive more than one of the individual packages at
-different times: Mixing old and new versions of SUNDIALS may fail. To avoid
-such failures, obtain all desired package at the same time.
+different times: Mixing old and new versions of SUNDIALS may fail. To avoid such
+failures, obtain all desired package at the same time.
 
 ## Support ##
 
-Full user guides for all of the SUNDIALS packages are available [online](https://sundials.readthedocs.io)
-and in the [doc](./doc) directory. Additionally, the [doc](./doc) directory
-contains documentation for the package example programs.
+Full user guides for all of the SUNDIALS packages are available [online](https://sundials.readthedocs.io).
+In the [released tarballs](https://github.com/LLNL/sundials/releases), the `doc`
+directory includes PDFs of the user guides and documentation for the example
+programs. The example program documentation PDFs are also available on the
+[releases page](https://github.com/LLNL/sundials/releases).
 
 For information on recent changes to SUNDIALS see the [CHANGELOG](./CHANGELOG.md)
 or the introduction chapter of any package user guide.
 
 A list of Frequently Asked Questions on build and installation procedures as
-well as common usage issues is available on the SUNDIALS [FAQ](https://computing.llnl.gov/projects/sundials/faq).
-For dealing with systems with unphysical solutions or discontinuities see the
-SUNDIALS [usage notes](https://computing.llnl.gov/projects/sundials/usage-notes).
+well as common usage issues is available on the SUNDIALS
+[FAQ](https://computing.llnl.gov/projects/sundials/faq). For dealing with
+systems with nonphysical solutions or discontinuities see the SUNDIALS
+[usage notes](https://computing.llnl.gov/projects/sundials/usage-notes).
 
-If you have a question not covered in the FAQ or usage notes, please submit
-your question to the SUNDIALS [mailing list](https://computing.llnl.gov/projects/sundials/mailing-list).
+If you have a question not covered in the FAQ or usage notes, please submit your
+question as a [GitHub issue](https://github.com/LLNL/sundials/issues) or to the
+SUNDIALS [mailing list](https://computing.llnl.gov/projects/sundials/mailing-list).
 
 ## Contributing ##
 
@@ -76,14 +88,15 @@ any publications reporting work done using SUNDIALS packages.
 
 The SUNDIALS library has been developed over many years by a number of
 contributors. The current SUNDIALS team consists of Cody J. Balos,
-David J. Gardner, Alan C. Hindmarsh, Daniel R. Reynolds, and Carol S. Woodward.
-We thank Radu Serban for significant and critical past contributions.
+David J. Gardner, Alan C. Hindmarsh, Daniel R. Reynolds, Steven B. Roberts, and
+Carol S. Woodward. We thank Radu Serban for significant and critical past
+contributions.
 
 Other contributors to SUNDIALS include: James Almgren-Bell, Lawrence E. Banks,
 Peter N. Brown, George Byrne, Rujeko Chinomona, Scott D. Cohen, Aaron Collier,
 Keith E. Grant, Steven L. Lee, Shelby L. Lockhart, John Loffeld, Daniel McGreer,
-Yu Pan, Slaven Peles, Cosmin Petra, Steven B. Roberts, H. Hunter Schwartz,
-Jean M. Sexton, Dan Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor,
+Yu Pan, Slaven Peles, Cosmin Petra, H. Hunter Schwartz, Jean M. Sexton,
+Dan Shumaker, Steve G. Smith, Shahbaj Sohal, Allan G. Taylor,
 Hilari C. Tiedeman, Chris White, Ting Yan, and Ulrike M. Yang.
 
 ## License ##
@@ -93,7 +106,7 @@ and [NOTICE](./NOTICE) files for details. All new contributions must be made
 under the BSD 3-clause license.
 
 **Please Note** If you are using SUNDIALS with any third party libraries linked
-in (e.g., LAPACK, KLU, SuperLU_MT, PETSc, or *hypre*), be sure to review the
+in (e.g., LAPACK, KLU, SuperLU_MT, PETSc, *hypre*, etc.), be sure to review the
 respective license of the package as that license may have more restrictive
 terms than the SUNDIALS license.
 

doc/arkode/guide/source/Butcher.rst

@@ -915,7 +915,7 @@ or :c:func:`ARKodeButcherTable_LoadERK`.
 Accessible via the string ``"ARKODE_VERNER_8_5_6"`` to
 :c:func:`ARKStepSetTableName`, :c:func:`ERKStepSetTableName` or
 :c:func:`ARKodeButcherTable_LoadERKByName`.
-This is the default 6th order explicit method (from :cite:p:`Ver:78`).
+This is the default 6th order explicit method (from :cite:p:`HEJ:76`).
 
 .. math::
 

doc/shared/sundials.bib

@@ -1880,6 +1880,14 @@ @article{Gust:94
   doi     = {10.1145/198429.198437}
 }
 
+@techreport{HEJ:76,
+  title = {User's guide for {DVERK}: {A} subroutine for solving non-stiff {ODE}'s},
+  author = {Hull, TE and Enright, WH and Jackson, KR},
+  year = {1976},
+  number = {100},
+  institution={University of Toronto. Department of Computer Science}
+}
+
 @article{Jay:21,
   title     = {Symplecticness conditions of some low order partitioned methods for non-autonomous Hamiltonian systems},
   author    = {Jay, Laurent O},
@@ -2133,17 +2141,6 @@ @article{Sof:04
   doi = {10.1016/j.mcm.2005.01.010}
 }
 
-@article{Ver:78,
-  author  = {Verner, J.H},
-  title   = {Explicit Runge-Kutta methods with estimates of the local truncation error},
-  journal = {SIAM Journal of Numerical Analysis},
-  volume  = {15},
-  number  = {4},
-  pages   = {772-790},
-  year    = {1978},
-  doi     = {10.1137/0715051}
-}
-
 @article{Ver:10,
   author  = {Verner, J.H},
   title   = {Numerically optimal {Runge–Kutta} pairs with interpolants},