--- trunk/esys2/doc/user/guide.tex 2005/05/06 04:26:16 121 +++ temp_trunk_copy/doc/user/guide.tex 2008/01/11 02:29:38 1384 @@ -1,22 +1,37 @@ +% % $Id$ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% Copyright 2003-2007 by ACceSS MNRF +% Copyright 2007 by University of Queensland +% +% http://esscc.uq.edu.au +% 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 Users Guide} +\title{\esys Users Guide: Solving Partial Differential Equations With Escript and Finley} \author{Lutz Gross et. al.(Editor)} \authoraddress{ Earth Systems Science Computational Centre (ESSCC) \\ The University of Queensland \\ -Australia \\ +Brisbane, Australia \\ Email: \email{esys@access.edu.au} } \date{\today} \release{$Revision$} -\setreleaseinfo{} +\setreleaseinfo{Beta} \setshortversion{} \makeindex @@ -29,24 +44,38 @@ \input{copyrights} \begin{abstract} -This document is a guide of how to use the \ESyS software and -associated tools. +\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 -\input{introduction} +\input{Installation} \input{TutorialPDE} + \input{escript} \input{linearPDE} -\input{timeseries} + +\input{pycad} + +\input{pyvisi} + +\input{finley} +% \input{MPI} + \input{modelframe} -\input{pdetools} %\input{bruce} -\input{finley} -\input{troubleshooting} \makemodindex \printindex