/[escript]/trunk/doc/user/user.tex
ViewVC logotype

Contents of /trunk/doc/user/user.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3307 - (show annotations)
Tue Oct 26 01:19:19 2010 UTC (8 years, 5 months ago) by caltinay
Original Path: trunk/doc/user/guide.tex
File MIME type: application/x-tex
File size: 2707 byte(s)
Put index back in and added link to index and biblio to the TOC.

1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % Copyright (c) 2003-2010 by University of Queensland
5 % Earth Systems Science Computational Center (ESSCC)
6 % http://www.uq.edu.au/esscc
7 %
8 % 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 %
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13
14
15 \documentclass{esysdoc}
16
17 % grab the handy definitions and \usepackage statements etc
18 \input{guide_defs}
19
20 % \newcommand{\hackscore}{_}
21
22 % title, author, etc stuff
23 \title{\module{esys} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
24 \author{Lutz Gross\etal~(Editor)}
25 \authoraddress{
26 Earth Systems Science Computational Centre (ESSCC) \\
27 School of Earth Sciences \\
28 The University of Queensland \\
29 Brisbane, Australia \\
30 Email: \email{esys@esscc.uq.edu.au}
31 }
32 \date{\today}
33
34 \makeindex
35
36 % the actual start of the document
37 \begin{document}
38
39 \maketitle
40
41 % This must be after the make title or latex markup will end up in the title
42 \ifpdf
43 \pdfinfo{
44 /Author (Lutz Gross et al. (Editor))
45 /Title (escript User's Guide)
46 /Keywords (escript, PDEs)
47 }
48 \fi
49
50 \input{copyrights}
51
52 \begin{abstract}
53 \escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
54
55 It consists of four major components
56 \begin{itemize}
57 \item \escript core library
58 \item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
59 \item the meshing interface \pycad
60 % \item VTK visualization interface \pyvisi
61 \item a model library.
62 \end{itemize}
63 The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
64
65 \emph{Please see Chapter~\ref{EXECUTION} for changes to the way to launch \escript scripts.}
66 For more info on this and other changes from previous releases see Appendix~\ref{app:changes}.
67
68 If you use this software in your research, then we would appreciate (but do not require) a citation.
69 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
70 \end{abstract}
71
72 \tableofcontents
73
74 \include{TutorialPDE}
75 \include{execute}
76 \include{escript}
77 \include{linearPDE}
78 \include{pycad}
79 \include{Models}
80 \include{finley}
81 \esysappendix %So hyperef builds table of contents links properly
82
83 %\input{modelframe}
84 \include{appendix}
85 %\include{pyvisi}
86
87 \cleardoublepage
88 \phantomsection
89 \addcontentsline{toc}{chapter}{\indexname}
90 \printindex
91
92 \cleardoublepage
93 \phantomsection
94 \addcontentsline{toc}{chapter}{Bibliography}
95 \bibliographystyle{plain}
96 \bibliography{esys}
97
98 \end{document}
99

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26