Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Updating landing page, remove file tree figure #450

Merged
merged 6 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions doc/shared/SundialsOrganization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,10 @@ nonlinear solver interfaces (abstract base classes), and the corresponding class
implementations provided with SUNDIALS. For classes that provide interfaces to
third-party libraries (i.e., LAPACK, KLU, SuperLU_MT, SuperLU_DIST, *hypre*,
PETSc, Trilinos, and Raja) users will need to download and compile those
packages independently of SUNDIALS. The directory structure is shown in
:numref:`Organization.Sundials.DirectoryStructure`.
packages independently of SUNDIALS.

.. _Organization.Sundials.HighLevelDiagram:
.. figure:: /figs/sunorg1.png
:align: center

High-level diagram of the SUNDIALS suite.

.. _Organization.Sundials.DirectoryStructure:
.. figure:: /figs/sunorg2.png
:align: center

Directory structure of the SUNDIALS source tree.
19 changes: 0 additions & 19 deletions doc/superbuild/source/Organization_link.rst
gardner48 marked this conversation as resolved.
Show resolved Hide resolved

This file was deleted.

2 changes: 2 additions & 0 deletions doc/superbuild/source/arkode/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _ARKODE:

********************
ARKODE Documentation
********************
Expand Down
2 changes: 2 additions & 0 deletions doc/superbuild/source/cvode/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _CVODE:

*******************
CVODE Documentation
*******************
Expand Down
2 changes: 2 additions & 0 deletions doc/superbuild/source/cvodes/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _CVODES:

********************
CVODES Documentation
********************
Expand Down
2 changes: 2 additions & 0 deletions doc/superbuild/source/ida/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _IDA:

*******************
IDA Documentation
*******************
Expand Down
2 changes: 2 additions & 0 deletions doc/superbuild/source/idas/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _IDAS:

******************
IDAS Documentation
******************
Expand Down
58 changes: 39 additions & 19 deletions doc/superbuild/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,11 @@
SUNDIALS Documentation
######################

This is the documentation for the `SUNDIALS
<https://computing.llnl.gov/projects/sundials>`_ suite of
nonlinear and differential/algebraic equation solvers.

SUNDIALS is developed on `GitHub <https://github.com/LLNL/sundials>`_.

.. toctree::
:maxdepth: 1
:numbered:
:hidden:

Organization_link.rst
sundials/index.rst
arkode/index.rst
cvode/index.rst
Expand All @@ -46,22 +39,35 @@ SUNDIALS is developed on `GitHub <https://github.com/LLNL/sundials>`_.
developers/index.rst
References

The `SUNDIALS <https://computing.llnl.gov/projects/sundials>`_ library of time
integrators and nonlinear solvers provides robust and efficient numerical
methods for ordinary differential equations (ODEs), differential-algebraic
equations (DAEs), and nonlinear algebraic systems. SUNDIALS is freely available
and developed on `GitHub <https://github.com/LLNL/sundials>`_.

Contributors
============
SUNDIALS is comprised of following 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.
* :ref:`ARKODE <ARKODE>`, a solver with one-step methods for stiff, nonstiff,
mixed stiff-nonstiff, and multirate ODE systems.

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,
Hilari C. Tiedeman, Chris White, Ting Yan, and Ulrike M. Yang.
* :ref:`CVODE <CVODE>`, a solver with Adams and BDF methods for stiff and
nonstiff ODE systems.

* :ref:`CVODES <CVODES>`, an extension of CVODE with forward and adjoint
sensitivity analysis capabilities for stiff and nonstiff ODE systems.

* :ref:`IDA <IDA>`, a solver with BDF methods for DAE systems.

* :ref:`IDAS <IDAS>`, an extension of IDA with forward and adjoint sensitivity
analysis capabilities for DAE systems.

* :ref:`KINSOL <KINSOL>`, a solver for nonlinear algebraic systems.

The SUNDIALS packages share many components and are organized as a family built
on a common infrastructure including abstract interfaces for vectors, matrices,
and algebraic solvers. Several implementations of these interfaces are provided
with SUNDIALS supporting a range of parallel computing paradigms including
shared-memory, distributed memory, and GPU computing.

Citing
======
Expand Down Expand Up @@ -152,6 +158,20 @@ they are using rather than the combined SUNDIALS online guide:
howpublished = {\url{https://sundials.readthedocs.io/en/latest/kinsol}}
}

Contributors
============

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.

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,
Hilari C. Tiedeman, Chris White, Ting Yan, and Ulrike M. Yang.

SUNDIALS License and Notices
============================
Expand Down
2 changes: 2 additions & 0 deletions doc/superbuild/source/kinsol/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
SUNDIALS Copyright End
----------------------------------------------------------------

.. _KINSOL:

********************
KINSOL Documentation
********************
Expand Down
8 changes: 3 additions & 5 deletions doc/superbuild/source/sundials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@
Using SUNDIALS
**************

As discussed in :numref:`Organization`, the six solvers packages
(CVODE(S), IDA(S), ARKODE, KINSOL) that make up SUNDIALS are built upon common
classes/modules for vectors, matrices, and algebraic solvers. In addition, the
six packages all leverage some other common infrastructure, which we discuss
in this section.
The packages that make up SUNDIALS are built upon shared classes for vectors,
matrices, and algebraic solvers. In addition, the packages all leverage some
other common infrastructure, which we discuss in this section.

.. toctree::
:maxdepth: 1
Expand Down
Loading