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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3989 - (show annotations)
Tue Sep 25 02:21:54 2012 UTC (7 years ago) by jfenwick
File MIME type: application/x-tex
File size: 3095 byte(s)
More copyright fixes.
pyvisi traces removed.
Some install doco
1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Copyright (c) 2003-2012 by University of Queensland
4 % http://www.uq.edu.au
5 %
6 % Primary Business: Queensland, Australia
7 % Licensed under the Open Software License version 3.0
8 % http://www.opensource.org/licenses/osl-3.0.php
9 %
10 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 % Development since 2012 by School of Earth Sciences
12 %
13 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14
15 \documentclass{esysdoc}
16 \usepackage{makeidx} %already in the esysdoc class but putting it here prompts kile to run makeidx
17
18 % grab the handy definitions and \usepackage statements etc
19 \input{user_defs}
20 \usepackage{upquote} %used to precent LaTeX from mucking up '
21
22 % \newcommand{\hackscore}{_}
23
24 % title, author, etc stuff
25 \title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
26 \author{Lutz Gross\etal~(Editor)}
27 \authoraddress{
28 Earth Systems Science Computational Centre (ESSCC) \\
29 School of Earth Sciences \\
30 The University of Queensland \\
31 Brisbane, Australia \\
32 Email: \email{esys@esscc.uq.edu.au}
33 }
34 \date{\today}
35
36 \makeindex
37
38 % the actual start of the document
39 \begin{document}
40
41 \maketitle
42
43 % This must be after the make title or latex markup will end up in the title
44 \ifpdf
45 \pdfinfo{
46 /Author (Lutz Gross et al. (Editor))
47 /Title (esys-Escript User's Guide)
48 /Keywords (escript, PDEs)
49 }
50 \fi
51
52 \input{copyrights}
53
54
55 \begin{abstract}\pdfbookmark[0]{Abstract}{abstract}%
56 \escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
57
58
59
60 It consists of three major components
61 \begin{itemize}
62 \item \escript core library
63 \item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
64 \item the meshing interface \pycad
65 \item a model library.
66 \end{itemize}
67 The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
68
69 In this release there are a number of small changes which are not backwards compatible.
70 Please see Appendix~\ref{app:changes} to see if your scripts will be affected.
71
72
73 If you use this software in your research, then we would appreciate (but do not require) a citation.
74 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
75
76 For Python3 support, see Appendix~\ref{app:py3}.
77 \end{abstract}
78 \input{currentdev}
79 \cleardoublepage\pdfbookmark[0]{Contents}{contents}%
80 \tableofcontents
81
82 \include{TutorialPDE}
83 \include{execute}
84 \include{escript}
85 \include{linearPDE}
86 \include{pycad}
87 \include{Models}
88 \include{finley}
89 \include{weipa}
90 \esysappendix %So hyperef builds table of contents links properly
91
92 %\input{modelframe}
93 \include{appendix}
94
95 \cleardoublepage
96 \phantomsection
97 \addcontentsline{toc}{chapter}{\indexname}
98 \printindex
99
100 \cleardoublepage
101 \phantomsection
102 \addcontentsline{toc}{chapter}{Bibliography}
103 \bibliographystyle{plain}
104 \bibliography{esys}
105
106 \end{document}
107

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/lapack2681/doc/user/guide.tex:2682-2741 /branches/pasowrap/doc/user/user.tex:3661-3674 /branches/py3_attempt2/doc/user/user.tex:3871-3891 /branches/restext/doc/user/guide.tex:2610-2624 /branches/ripleygmg_from_3668/doc/user/user.tex:3669-3791 /branches/stage3.0/doc/user/guide.tex:2569-2590 /branches/symbolic_from_3470/doc/user/user.tex:3471-3974 /branches/symbolic_from_3470/ripley/test/python/doc/user/user.tex:3517-3974 /release/3.0/doc/user/guide.tex:2591-2601 /trunk/ripley/test/python/doc/user/user.tex:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26