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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3339 - (show annotations)
Fri Nov 5 05:30:31 2010 UTC (8 years, 2 months ago) by jfenwick
File MIME type: application/x-tex
File size: 3268 byte(s)
Fixed more package clashing problems.
Package install.pdf not install.tex
Changed title on most documents to esys-Escript except for the cookbook coz I like ti that way.
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 %
3 % Copyright (c) 2003-2010 by University of Queensland
4 % Earth Systems Science Computational Center (ESSCC)
5 % http://www.uq.edu.au/esscc
6 %
7 % Primary Business: Queensland, Australia
8 % Licensed under the Open Software License version 3.0
9 % http://www.opensource.org/licenses/osl-3.0.php
10 %
11 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
12
13 \chapter{Introduction}
14 This document describes how to install \emph{esys-Escript}\footnote{For the rest of the document we will drop the \emph{esys-}} on your computer.
15 To learn how to use \esfinley please see the Cookbook, User's guide or the API documentation.
16 If you use the Debian or Ubuntu packages to install then the documentation will be available in
17 \file{/usr/share/doc/escript}, otherwise (if you haven't done so already) you can download the documentation bundle
18 from launchpad.
19
20 \esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems.
21 It is distributed in two forms:
22 \begin{enumerate}
23 \item Binary bundles -- these are great for first time users or for those who want to start using \esfinley immediately
24 \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.
25 \end{enumerate}
26
27 The binary bundles are currently available for the following platforms:
28 \begin{itemize}
29 \item Debian and Ubuntu Linux distributions ($32$-bit i686) (.deb package)
30 \item Linux desktop systems with gcc (stand-alone bundle)
31 \item \macosx Leopard systems with gcc (stand-alone bundle)
32 \end{itemize}
33
34 Hopefully, a Windows version(stand-alone) of this release will be available soon.
35
36 See Chapter~\ref{chap:bin} for instructions on how to set these up and run \esfinley.
37 If you choose to compile from source your options are to
38 \begin{itemize}
39 \item install dependencies (e.g. using your package manager) and only compile \esfinley, OR
40 \item compile everything from source.
41 \end{itemize}
42
43 Compiling \esfinley when its dependencies are already installed is discussed in Chapter~\ref{chap:essrc}.
44 To compile \esfinley and all dependencies from source please see Chapter~\ref{chap:allsrc}.
45 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.
46
47 Once everything is installed you can test your installation using the Python scripts in \file{examples.zip} or \file{examples.tar.gz}\footnote{These should either be in \file{escript.d/release/doc} or in the case of Debian, in \file{/usr/share/doc/escript}.}.
48 Unpack the examples and try to run the following from a terminal:
49 \begin{shellCode}
50 run-escript poission.py
51 \end{shellCode}
52 If this produces a VTK file called \file{u.vtu} then you are likely to have a functional \esfinley installation.
53 You can try and visualize the VTK data or delete the file.
54 For visualization we suggest using \file{VisIt}\footnote{\url{https://wci.llnl.gov/codes/visit/}} or \file{MayaVi}\footnote{\url{http://mayavi.sourceforge.net}} which are both freely available.
55
56 See the site \url{https://answers.launchpad.net/escript-finley} for online help.

  ViewVC Help
Powered by ViewVC 1.1.26