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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5279 - (show annotations)
Thu Nov 27 00:26:18 2014 UTC (4 years, 6 months ago) by sshaw
File MIME type: application/x-tex
File size: 3308 byte(s)
adding ripley and speckley to user guide, a bit barebones still
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 % Copyright (c) 2003-2014 by University of Queensland
3 % http://www.uq.edu.au
4 %
5 % Primary Business: Queensland, Australia
6 % Licensed under the Open Software License version 3.0
7 % http://www.opensource.org/licenses/osl-3.0.php
8 %
9 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
10 % Development 2012-2013 by School of Earth Sciences
11 % Development from 2014 by Centre for Geoscience Computing (GeoComp)
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 \usepackage{graphicx, subfigure}
22
23 % \newcommand{\hackscore}{_}
24
25 % title, author, etc stuff
26 \title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
27 \author{Lutz Gross\etal~(Editor)}
28 \authoraddress{
29 Centre for Geoscience Computing (GeoComp) \\
30 School of Earth Sciences \\
31 The University of Queensland \\
32 Brisbane, Australia \\
33 %Email: \email{esys@esscc.uq.edu.au}
34 }
35 \date{\today}
36 %\release{3.4.1}
37 \release{development}
38
39 \makeindex
40
41 % the actual start of the document
42 \begin{document}
43
44 \maketitle
45
46 % This must be after the make title or latex markup will end up in the title
47 \ifpdf
48 \pdfinfo{
49 /Author (Lutz Gross et al. (Editor))
50 /Title (esys-Escript User's Guide)
51 /Keywords (escript, PDEs)
52 }
53 \fi
54
55
56 \input{copyrights}
57 \input{docguide}
58
59 \begin{abstract}\pdfbookmark[0]{Abstract}{abstract}%
60 \escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
61
62
63
64 It consists of five major components
65 \begin{itemize}
66 \item \escript core library
67 \item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
68 \item the meshing interface \pycad
69 \item a model library.
70 \item an inversion library.
71 \end{itemize}
72 The current version supports parallelization through both MPI for distributed
73 memory and OpenMP for shared memory.
74
75 In this release there are a number of small changes which are not backwards compatible.
76 Please see Appendix~\ref{app:changes} to see if your scripts will be affected.
77
78 If you use this software in your research, then we would appreciate (but do not require) a citation.
79 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
80
81 For Python 3 support, see Appendix~\ref{app:py3}.
82 \end{abstract}
83 \input{currentdev}
84 \cleardoublepage\pdfbookmark[0]{Contents}{contents}%
85 \tableofcontents
86
87 \include{TutorialPDE}
88 \include{execute}
89 \include{escript}
90 \include{linearPDE}
91 \include{pycad}
92 \include{Models}
93 \include{finley}
94 \include{ripley}
95 \include{speckley}
96 \include{weipa}
97 \include{symbolic}
98
99 \esysappendix %So hyperef builds table of contents links properly
100
101 %\input{modelframe}
102 \include{appendix}
103
104 \cleardoublepage
105 \phantomsection
106 \addcontentsline{toc}{chapter}{\indexname}
107 \printindex
108
109 \cleardoublepage
110 \phantomsection
111 \addcontentsline{toc}{chapter}{Bibliography}
112 \bibliographystyle{plain}
113 \bibliography{esys}
114
115 \end{document}

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/3.4/doc/user/user.tex:4453-4490 /branches/diaplayground/doc/user/user.tex:4940-5147 /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/release3.4/doc/user/user.tex:4452 /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