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

Annotation of /trunk/doc/user/user.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3310 - (hide annotations)
Tue Oct 26 03:58:17 2010 UTC (8 years, 6 months ago) by jfenwick
Original Path: trunk/doc/user/guide.tex
File MIME type: application/x-tex
File size: 2708 byte(s)
Fixed some pdf bookmarks and added the index package

1 ksteube 1811
2     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 ksteube 1316 %
4 jfenwick 2881 % Copyright (c) 2003-2010 by University of Queensland
5 ksteube 1811 % 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 caltinay 3293 \documentclass{esysdoc}
16 jgs 82
17     % grab the handy definitions and \usepackage statements etc
18     \input{guide_defs}
19    
20 jfenwick 3295 % \newcommand{\hackscore}{_}
21 caltinay 3293
22 jgs 82 % title, author, etc stuff
23 jfenwick 2336 \title{\module{esys} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
24 caltinay 1963 \author{Lutz Gross\etal~(Editor)}
25 jgs 82 \authoraddress{
26     Earth Systems Science Computational Centre (ESSCC) \\
27 gross 2370 School of Earth Sciences \\
28 jgs 82 The University of Queensland \\
29 ksteube 1316 Brisbane, Australia \\
30 gross 2100 Email: \email{esys@esscc.uq.edu.au}
31 caltinay 3293 }
32     \date{\today}
33 jgs 82
34     \makeindex
35    
36     % the actual start of the document
37     \begin{document}
38    
39     \maketitle
40    
41 caltinay 3293 % This must be after the make title or latex markup will end up in the title
42 jfenwick 2944 \ifpdf
43 caltinay 3293 \pdfinfo{
44 caltinay 3306 /Author (Lutz Gross et al. (Editor))
45 jfenwick 2944 /Title (escript User's Guide)
46     /Keywords (escript, PDEs)
47     }
48     \fi
49    
50 jgs 82 \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 jfenwick 2540 % \item VTK visualization interface \pyvisi
61 gross 2558 \item a model library.
62 gross 722 \end{itemize}
63 caltinay 3293 The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
64 jfenwick 2923
65     \emph{Please see Chapter~\ref{EXECUTION} for changes to the way to launch \escript scripts.}
66 jfenwick 2540 For more info on this and other changes from previous releases see Appendix~\ref{app:changes}.
67 jfenwick 2463
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 jgs 82 \end{abstract}
71    
72 jfenwick 3310 \etableofcontents
73 jgs 82
74 jfenwick 1955 \include{TutorialPDE}
75 gross 2316 \include{execute}
76 jfenwick 1955 \include{escript}
77     \include{linearPDE}
78     \include{pycad}
79     \include{Models}
80 gross 2415 \include{finley}
81 jfenwick 3302 \esysappendix %So hyperef builds table of contents links properly
82 gross 568
83 gross 1859 %\input{modelframe}
84 jfenwick 1955 \include{appendix}
85 jfenwick 3301 %\include{pyvisi}
86 jfenwick 2540
87 caltinay 3307 \cleardoublepage
88     \phantomsection
89     \addcontentsline{toc}{chapter}{\indexname}
90     \printindex
91    
92     \cleardoublepage
93     \phantomsection
94     \addcontentsline{toc}{chapter}{Bibliography}
95 jgs 102 \bibliographystyle{plain}
96     \bibliography{esys}
97    
98 jgs 82 \end{document}
99 caltinay 3293

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26