/[escript]/trunk/doc/install/intro.tex
ViewVC logotype

Diff of /trunk/doc/install/intro.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2537 by caltinay, Thu Jul 16 23:53:07 2009 UTC revision 2538 by caltinay, Fri Jul 17 06:24:15 2009 UTC
# Line 1  Line 1 
   
   
1  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2  %  %
3  % Copyright (c) 2003-2008 by University of Queensland  % Copyright (c) 2003-2008 by University of Queensland
# Line 14  Line 12 
12    
13  \chapter{Introduction}  \chapter{Introduction}
14  This document describes how to install \esfinley on your computer.  This document describes how to install \esfinley on your computer.
15  To learn how to use \esfinley please see the User guide or, for  To learn how to use \esfinley please see the User's guide or, for more detailed
16  more detailed information, the API documentation.  information, the API documentation.
17    
18  \esfinley is developed primarily on Linux desktop systems, SGI ICE and \macosx.  \esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems.
19  Binary distributions (discussed in Chapter~\ref{chap:bin}) are available for the following platforms:  It is distributed in two forms:
20    \begin{enumerate}
21        \item Binary bundles -- these are great for first time users or for those who want to start using \esfinley immediately
22        \item Source bundles -- these require compilation and should be used if the binary bundles don't work on the target machine or if extra functionality is required such as \mpi parallelisation.
23    \end{enumerate}
24    
25    The binary bundles are currently available for the following platforms:
26  \begin{itemize}  \begin{itemize}
27  \item Debian and Ubuntu Linux distributions ($32$-bit i686) (.deb package)      \item Debian and Ubuntu Linux distributions ($32$-bit i686) (.deb package)
28  \item Linux desktop systems with gcc (stand-alone bundle)      \item Linux desktop systems with gcc (stand-alone bundle)
29  \item \macosx Leopard systems with gcc (stand-alone bundle)      \item \macosx Leopard systems with gcc (stand-alone bundle)
30  \item Windows systems with Visual Studio (stand-alone bundle)      \item Windows systems with Visual Studio (stand-alone bundle)
31  \end{itemize}  \end{itemize}
32    
33  Compiling escript when its dependencies are already installed is discussed in Chapter~\ref{chap:essrc}.  See \Chap{chap:bin} for instructions on how to set these up and run \esfinley.
34  To compile escript and its dependencies from source please see Chapter~\ref{chap:allsrc}.  If you choose to compile from source your options are to
35    \begin{itemize}
36        \item install dependencies (e.g. using your package manager) and only compile \esfinley, OR
37        \item compile everything from source.
38    \end{itemize}
39    
40    Compiling \esfinley when its dependencies are already installed is discussed in \Chap{chap:essrc}.
41    To compile \esfinley and all dependencies from source please see \Chap{chap:allsrc}.
42    The latter option takes a significant amount of time and is only required if the versions of the dependent libraries available on your system do not work with \esfinley.
43    
44  You can test your installation using the Python scripts in \filename{examples.zip} or \filename{examples.tar.gz}  Once everything is installed you can test your installation using the Python scripts in \filename{examples.zip} or \filename{examples.tar.gz}\footnote{These should either be in \filename{escript.d/release/doc} or in the case of Debian, in \filename{/usr/share/doc/escript}.}.
45  \footnote{These should either be in \filename{escript.d/release/doc} or in the case of Debian, in \filename{/usr/share/doc/escript}.}.  Unpack the examples and try to run the following from a terminal:
 To test your installation try to run the following from a terminal:  
46  \begin{shellCode}  \begin{shellCode}
47   escript poission.py   escript poission.py
48  \end{shellCode}  \end{shellCode}
49  This should produce a VTK file called \filename{u.vtu} (which can be removed).  If this produces a VTK file called \filename{u.vtu} then you are likely to have a functional \esfinley installation.
50  If this is successful, then the main features of \escript have been sucessfully installed.  You can try and visualise the VTK data or delete the file.
51    For visualisation we suggest using \filename{VisIt}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \filename{MayaVi}\footnote{\url{http://mayavi.sourceforge.net}} which are both freely available.
 For visualisation we suggest \filename{visit}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \filename{mayavi}\footnote{\url{http://mayavi.sourceforge.net}}.  
52    
53  See the site \url{https://answers.launchpad.net/escript-finley} for online help.  See the site \url{https://answers.launchpad.net/escript-finley} for online help.

Legend:
Removed from v.2537  
changed lines
  Added in v.2538

  ViewVC Help
Powered by ViewVC 1.1.26