%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Copyright (c) 2003-2026 by the esys.escript Group
% https://github.com/LutzGross/esys-escript.github.io
%
% Primary Business: Queensland, Australia
% Licensed under the Apache License, version 2.0
% http://www.apache.org/licenses/LICENSE-2.0
%
% See CREDITS file for contributors and development history
%
%%%%%%%%%%%XX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\documentclass{esysdoc}
\usepackage{makeidx} %already in the esysdoc class but putting it here prompts kile to run makeidx

% grab the handy definitions and \usepackage statements etc
\input{user_defs}
\usepackage{upquote} %used to prevent LaTeX from mucking up '
\usepackage{graphicx, subfigure}


\input{verinfo}
% \newcommand{\hackscore}{_}

% title, author, etc stuff
\title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
\author{Lutz Gross\etal~(Editor)}
\authoraddress{
Brisbane, Australia. \\
Email: \email{lutz.gross@gmail.com}
}
\date{\reldate}
\release{\relver}
%\release{development}

\makeindex

% the actual start of the document
\begin{document}

\maketitle

% This must be after the make title or latex markup will end up in the title
\ifpdf
\pdfinfo{
/Author (Lutz Gross et al. (Editor))
/Title (esys-Escript User's Guide)
/Keywords (escript, PDEs)
}
\fi


\input{copyrights}

\begin{abstract}\pdfbookmark[0]{Abstract}{abstract}%
\escript is a \PYTHON-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
It consists of four major components:
\begin{itemize}
\item \escript core library
\item PDE solver interface
\item finite element solvers \finley, \ripley, \speckley and \oxley
\item interface to visualization tools
\end{itemize}

All \escript modules require \PYTHON 3 (version 3.7 or later).
The current version supports parallelization through \MPI for distributed
memory, \OPENMP for shared memory on CPUs, as well as \CUDA for some GPU-based
solvers.

This release comes with some significant changes and new features.
Please see the RELEASE\_NOTES file for a detailed list.
In particular, if you wish to solve PDEs with complex coefficients, please consult the install guide regarding Trilinos support.

If you use this software in your research, then we would appreciate (but do not
require) a citation.
Please see the README.md file for relevant references.
\end{abstract}

\cleardoublepage\pdfbookmark[0]{Contents}{contents}%
\tableofcontents

\include{TutorialPDE}
\include{execute}
\include{escript}
\include{linearPDE}
\include{finley}
\include{ripley}
\include{speckley}
\include{weipa}
\include{trilinos}
\include{symbolic}
\include{mpi4py}

\esysappendix %So hyperef builds table of contents links properly 

\include{appendix}

\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{\indexname}
\printindex

\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Bibliography}
\bibliographystyle{plain}
\bibliography{esys}

\end{document}
