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{\esys User's Guide: Solving Partial Differential Equations with Escript and Finley}

\author{Lutz Gross\etal~(Editor)}
\authoraddress{
Earth Systems Science Computational Centre (ESSCC) \\
The University of Queensland \\
Brisbane, Australia \\
Email: \email{esys@access.edu.au}
}                                                                                         
\date{\today}      
\release{$Revision$}
\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{Installation}
\include{TutorialPDE}


\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	caltinay	1963	\title{\esys User's Guide: Solving Partial Differential Equations with Escript and Finley}
22	jgs	82
23	caltinay	1963	\author{Lutz Gross\etal~(Editor)}
24	jgs	82	\authoraddress{
25			Earth Systems Science Computational Centre (ESSCC) \\
26			The University of Queensland \\
27	ksteube	1316	Brisbane, Australia \\
28	jgs	82	Email: \email{esys@access.edu.au}
29			}
30			\date{\today}
31	gross	722	\release{$Revision$}
32	gross	625	\setreleaseinfo{Beta}
33	jgs	82	\setshortversion{}
34
35			\makeindex
36
37			% the actual start of the document
38			\begin{document}
39
40			\maketitle
41
42			\input{copyrights}
43
44			\begin{abstract}
45	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.
46	gross	722
47			It consists of four major components
48			\begin{itemize}
49	gross	999	\item \escript core library
50	ksteube	1316	\item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
51	gross	999	\item the meshing interface \pycad
52	ksteube	1316	\item VTK visualization interface \pyvisi
53	gross	722	\item model library modellib
54			\end{itemize}
55	ksteube	1316	The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
56	jgs	82	\end{abstract}
57
58			\tableofcontents
59
60	jfenwick	1955	\include{Installation}
61			\include{TutorialPDE}
62	jgs	82
63	gross	565
64	jfenwick	1955	\include{escript}
65			\include{linearPDE}
66	gross	999
67	jfenwick	1955	\include{pycad}
68	gross	999
69	jfenwick	1955	\include{pyvisi}
70	gross	999
71	jfenwick	1955	\include{Models}
72	gross	1859
73	jfenwick	1955	\include{finley}
74	bcumming	790	% \input{MPI}
75	gross	568
76	gross	1859	%\input{modelframe}
77	jgs	82
78	jfenwick	1955	\include{appendix}
79	lgraham	1700
80	jgs	82	\makemodindex
81
82			\printindex
83			%\input{guide.ind}
84
85	jgs	102	\bibliographystyle{plain}
86			\bibliography{esys}
87
88	jgs	82	\end{document}
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision