doc/user/guide.tex


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (c) 2003-2008 by University of Queensland
% Earth Systems Science Computational Center (ESSCC)
% http://www.uq.edu.au/esscc
%
% Primary Business: Queensland, Australia
% Licensed under the Open Software License version 3.0
% http://www.opensource.org/licenses/osl-3.0.php
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\documentclass{manual}

% grab the handy definitions and \usepackage statements etc
\input{guide_defs}

% title, author, etc stuff
\title{\module{esys} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}

\ifpdf
\pdfinfo {
/Author (Lutz Gross et al (Editor))
/Title (escript User's Guide)
/Keywords (escript, PDEs)
}
\fi

\author{Lutz Gross\etal~(Editor)}
\authoraddress{
Earth Systems Science Computational Centre (ESSCC) \\
The University of Queensland \\
Brisbane, Australia \\
Email: \email{esys@esscc.uq.edu.au}
}                                                                                         
\date{\today}      
\release{Revision: \RepVersion}
\setreleaseinfo{Beta} 
\setshortversion{}

\makeindex

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

\maketitle

\input{copyrights}

\begin{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 finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
\item the meshing interface \pycad
\item VTK visualization interface \pyvisi
\item model library modellib
\end{itemize}
The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory. 
\end{abstract}

\tableofcontents

\include{TutorialPDE}
\include{execute}

\include{escript}
\include{linearPDE}

\include{pycad}

\include{pyvisi}

\include{Models}

\include{finley}
% \input{MPI}

%\input{modelframe}

\include{appendix}

\makemodindex

\printindex
%\input{guide.ind}

\bibliographystyle{plain}
\bibliography{esys}

\end{document}
1	ksteube	1811
2			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3	ksteube	1316	%
4	ksteube	1811	% Copyright (c) 2003-2008 by University of Queensland
5			% Earth Systems Science Computational Center (ESSCC)
6			% http://www.uq.edu.au/esscc
7	gross	625	%
8	ksteube	1811	% Primary Business: Queensland, Australia
9			% Licensed under the Open Software License version 3.0
10			% http://www.opensource.org/licenses/osl-3.0.php
11	gross	625	%
12	ksteube	1811	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13	ksteube	1316
14	ksteube	1811
15	jgs	82	\documentclass{manual}
16
17			% grab the handy definitions and \usepackage statements etc
18			\input{guide_defs}
19
20			% title, author, etc stuff
21	jfenwick	2336	\title{\module{esys} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
22	jgs	82
23	jfenwick	2336	\ifpdf
24			\pdfinfo {
25			/Author (Lutz Gross et al (Editor))
26			/Title (escript User's Guide)
27			/Keywords (escript, PDEs)
28			}
29			\fi
30	jfenwick	2335
31	caltinay	1963	\author{Lutz Gross\etal~(Editor)}
32	jgs	82	\authoraddress{
33			Earth Systems Science Computational Centre (ESSCC) \\
34			The University of Queensland \\
35	ksteube	1316	Brisbane, Australia \\
36	gross	2100	Email: \email{esys@esscc.uq.edu.au}
37	jgs	82	}
38			\date{\today}
39	jfenwick	2338	\release{Revision: \RepVersion}
40	gross	625	\setreleaseinfo{Beta}
41	jgs	82	\setshortversion{}
42
43			\makeindex
44
45			% the actual start of the document
46			\begin{document}
47
48			\maketitle
49
50			\input{copyrights}
51
52			\begin{abstract}
53	ksteube	1316	\escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
54	gross	722
55			It consists of four major components
56			\begin{itemize}
57	gross	999	\item \escript core library
58	ksteube	1316	\item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
59	gross	999	\item the meshing interface \pycad
60	ksteube	1316	\item VTK visualization interface \pyvisi
61	gross	722	\item model library modellib
62			\end{itemize}
63	ksteube	1316	The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
64	jgs	82	\end{abstract}
65
66			\tableofcontents
67
68	jfenwick	1955	\include{TutorialPDE}
69	gross	2316	\include{execute}
70	jgs	82
71	jfenwick	1955	\include{escript}
72			\include{linearPDE}
73	gross	999
74	jfenwick	1955	\include{pycad}
75	gross	999
76	jfenwick	1955	\include{pyvisi}
77	gross	999
78	jfenwick	1955	\include{Models}
79	gross	1859
80	jfenwick	1955	\include{finley}
81	bcumming	790	% \input{MPI}
82	gross	568
83	gross	1859	%\input{modelframe}
84	jgs	82
85	jfenwick	1955	\include{appendix}
86	lgraham	1700
87	jgs	82	\makemodindex
88
89			\printindex
90			%\input{guide.ind}
91
92	jgs	102	\bibliographystyle{plain}
93			\bibliography{esys}
94
95	jgs	82	\end{document}
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision