# Contents of /trunk/doc/install/intro.tex

Revision 2536 - (show annotations)
Thu Jul 16 23:53:07 2009 UTC (10 years, 1 month ago) by caltinay
File MIME type: application/x-tex
File size: 2062 byte(s)
installguide: Fixed typos, minor semantics, repetitions and whitespace issues.


 1 2 3 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 4 % 5 % Copyright (c) 2003-2008 by University of Queensland 6 % Earth Systems Science Computational Center (ESSCC) 7 8 % 9 % Primary Business: Queensland, Australia 10 % Licensed under the Open Software License version 3.0 11 12 % 13 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 14 15 \chapter{Introduction} 16 This document describes how to install \esfinley on your computer. 17 To learn how to use \esfinley please see the User guide or, for 18 more detailed information, the API documentation. 19 20 \esfinley is developed primarily on Linux desktop systems, SGI ICE and \macosx. 21 Binary distributions (discussed in Chapter~\ref{chap:bin}) are available for the following platforms: 22 \begin{itemize} 23 \item Debian and Ubuntu Linux distributions ($32$-bit i686) (.deb package) 24 \item Linux desktop systems with gcc (stand-alone bundle) 25 \item \macosx Leopard systems with gcc (stand-alone bundle) 26 \item Windows systems with Visual Studio (stand-alone bundle) 27 \end{itemize} 28 29 Compiling escript when its dependencies are already installed is discussed in Chapter~\ref{chap:essrc}. 30 To compile escript and its dependencies from source please see Chapter~\ref{chap:allsrc}. 31 32 You can test your installation using the Python scripts in \filename{examples.zip} or \filename{examples.tar.gz} 33 \footnote{These should either be in \filename{escript.d/release/doc} or in the case of Debian, in \filename{/usr/share/doc/escript}.}. 34 To test your installation try to run the following from a terminal: 35 \begin{shellCode} 36 escript poission.py 37 \end{shellCode} 38 This should produce a VTK file called \filename{u.vtu} (which can be removed). 39 If this is successful, then the main features of \escript have been sucessfully installed. 40 41 For visualisation we suggest \filename{visit}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \filename{mayavi}\footnote{\url{http://mayavi.sourceforge.net}}. 42 43 See the site \url{https://answers.launchpad.net/escript-finley} for online help.