From 4bf75e19e220383955b8ca409504767e4cc5bd88 Mon Sep 17 00:00:00 2001 From: Steven Roberts Date: Wed, 31 Jul 2024 21:26:30 -0700 Subject: [PATCH 1/4] Update README links and equations --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c410afb6ca..694ddd5d1b 100644 --- a/README.md +++ b/README.md @@ -15,29 +15,36 @@ 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 [online install guide](https://sundials.readthedocs.io/en/latest/Install_link.html). +Directions are also available in the [released package tarballs](https://github.com/LLNL/sundials/releases) +in INSTALL_GUIDE.pdf and the installation chapter of the user guides. 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 @@ -46,8 +53,9 @@ 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. +and in the [doc](./doc) directory of the [released package tarballs](https://github.com/LLNL/sundials/releases). +Additionally, the [doc](./doc) directory contains documentation for the package +example programs. For information on recent changes to SUNDIALS see the [CHANGELOG](./CHANGELOG.md) or the introduction chapter of any package user guide. @@ -58,7 +66,8 @@ For dealing with systems with unphysical 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). +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 +85,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 ## From 412b4dd6633c9aa45ad2a0ed0e7c071cfae2583f Mon Sep 17 00:00:00 2001 From: Steven Roberts Date: Wed, 31 Jul 2024 21:29:27 -0700 Subject: [PATCH 2/4] Add missing comma --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 694ddd5d1b..0566c8253e 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ nonlinear algebraic systems: ## Installation ## -For installation directions see the [online install guide](https://sundials.readthedocs.io/en/latest/Install_link.html). +For installation directions, see the [online install guide](https://sundials.readthedocs.io/en/latest/Install_link.html). Directions are also available in the [released package tarballs](https://github.com/LLNL/sundials/releases) in INSTALL_GUIDE.pdf and the installation chapter of the user guides. From 7014bfdf596eec72751d23b65e983f630c7ec0a2 Mon Sep 17 00:00:00 2001 From: Steven Roberts Date: Fri, 2 Aug 2024 13:14:53 -0700 Subject: [PATCH 3/4] Apply suggestions from code review Co-authored-by: David Gardner --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0566c8253e..a9c994692a 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,8 @@ nonlinear algebraic systems: ## Installation ## -For installation directions, see the [online install guide](https://sundials.readthedocs.io/en/latest/Install_link.html). -Directions are also available in the [released package tarballs](https://github.com/LLNL/sundials/releases) -in INSTALL_GUIDE.pdf and the installation chapter of the user guides. +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 @@ -52,10 +51,8 @@ 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 of the [released package tarballs](https://github.com/LLNL/sundials/releases). -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. From 683837605877d382d243d65fe9613951ecf0714b Mon Sep 17 00:00:00 2001 From: "David J. Gardner" Date: Fri, 2 Aug 2024 15:44:46 -0600 Subject: [PATCH 4/4] wrap long lines --- README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a9c994692a..1d84b9b6e2 100644 --- a/README.md +++ b/README.md @@ -42,29 +42,35 @@ nonlinear algebraic systems: ## Installation ## -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. +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). -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). +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 as a [GitHub issue](https://github.com/LLNL/sundials/issues) or 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 ## @@ -100,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.