doc/install/intro.tex



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (c) 2003-2008 by University of Queensland
% Earth Systems Science Computational Center (ESSCC)
% http://www.uq.edu.au/esscc
%
% Primary Business: Queensland, Australia
% Licensed under the Open Software License version 3.0
% http://www.opensource.org/licenses/osl-3.0.php
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section*{Introduction}
This document describes how to install \esfinley on your computer.
To learn how to use \esfinley please see the User guide or, for
more detailed information, the API documentation.

\esfinley is developed primarily on Linux desktop systems,  SGI ICE and MacOS.
Binary distributions (discussed in Chapter~\ref{chap:bin}) are available for the following platforms:
\begin{itemize}
\item Debian and Ubuntu Linux distributions ($32$-bit i686) (.deb package)
\item Linux desktop systems with gcc (stand-alone bundle)
\item MacOS X Leopard systems with gcc (stand-alone bundle)
\item Windows systems with Visual Studio (stand-alone bundle) 
\end{itemize}

Compilation from source is discussed in Chapter~\ref{chap:src}.

You can test your installation using the Python scripts in \filename{examples.zip} or \filename{examples.tar.gz}
\footnote{These will should either be in \filename{escript.d/release/doc} or in the case of Debian, in \filename{/usr/share/doc/escript}.}.
A simple test is
\begin{shellCode}
 escript poission.py
\end{shellCode}
It should produce a file called \filename{u.xml} (which can be removed).
If this is successful, then the main features of \escript have been sucessfully installed.

For visualisation we suggest \filename{visit}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \filename{mayavi}\footnote{\url{http://mayavi.sourceforge.net}}.

For online help, see the site \url{https://answers.launchpad.net/escript-finley}.
1
2
3	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
4	%
5	% Copyright (c) 2003-2008 by University of Queensland
6	% Earth Systems Science Computational Center (ESSCC)
7	% http://www.uq.edu.au/esscc
8	%
9	% Primary Business: Queensland, Australia
10	% Licensed under the Open Software License version 3.0
11	% http://www.opensource.org/licenses/osl-3.0.php
12	%
13	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14
15	\section*{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 MacOS.
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 MacOS X Leopard systems with gcc (stand-alone bundle)
26	\item Windows systems with Visual Studio (stand-alone bundle)
27	\end{itemize}
28
29	Compilation from source is discussed in Chapter~\ref{chap:src}.
30
31	You can test your installation using the Python scripts in \filename{examples.zip} or \filename{examples.tar.gz}
32	\footnote{These will should either be in \filename{escript.d/release/doc} or in the case of Debian, in \filename{/usr/share/doc/escript}.}.
33	A simple test is
34	\begin{shellCode}
35	escript poission.py
36	\end{shellCode}
37	It should produce a file called \filename{u.xml} (which can be removed).
38	If this is successful, then the main features of \escript have been sucessfully installed.
39
40	For visualisation we suggest \filename{visit}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \filename{mayavi}\footnote{\url{http://mayavi.sourceforge.net}}.
41
42	For online help, see the site \url{https://answers.launchpad.net/escript-finley}.