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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3989 - (show annotations)
Tue Sep 25 02:21:54 2012 UTC (7 years ago) by jfenwick
File MIME type: application/x-tex
File size: 3901 byte(s)
More copyright fixes.
pyvisi traces removed.
Some install doco
1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2 % Copyright (c) 2003-2012 by University of Queensland
3 % http://www.uq.edu.au
4 %
5 % Primary Business: Queensland, Australia
6 % Licensed under the Open Software License version 3.0
7 % http://www.opensource.org/licenses/osl-3.0.php
8 %
9 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
10 % Development since 2012 by School of Earth Sciences
11 %
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13
14 \chapter{Introduction}
15 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.
16 To learn how to use \esfinley please see the Cookbook, User's guide or the API documentation.
17 If you use the Debian or Ubuntu packages to install then the documentation will be available in
18 \file{/usr/share/doc/escript}, otherwise (if you haven't done so already) you can download the documentation bundle
19 from launchpad.
20
21 \esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems.
22 It is distributed in two forms:
23 \begin{enumerate}
24 \item Binary bundles -- these are great for first time users or for those who want to start using
25 \esfinley immediately.
26 Bundles are available for:
27 \begin{itemize}
28 \item Debian and Ubuntu Linux distributions ($32$/$64$-bit i686) (.deb package)
29 \item Linux desktop systems with gcc (stand-alone bundle)
30 \item \macosx Leopard systems (also tested on Lion) with gcc (stand-alone bundle)
31 \item $32$bit Windows (requires some other packages to be installed).
32 \end{itemize}
33 Please see Chapter~\ref{chap:bin} for instructions on how to install the binary bundles \esfinley.
34 \item Source bundles -- these require compilation and should be used if the binary bundles
35 don't work on the target machine or if extra functionality is required such as \mpi parallelisation.
36 See Chapter~\ref{chap:compiler} for detailed instructions.
37 \end{enumerate}
38
39 See the site \url{https://answers.launchpad.net/escript-finley} for online help.
40
41 \section{Significant changes since version 3.3}
42 \begin{itemize}
43 \item \texttt{SymPy} is now required to compile or run \escript.
44 This means you will need to download sympy in addition to the support bundle from previous releases.
45 \item The minimum Python version is now $2.6$.
46 \end{itemize}
47
48 % \noindent If you choose to compile from source your options are to
49 % \begin{itemize}
50 % \item install dependencies (e.g. using your package manager) and only compile \esfinley, OR
51 % \item compile everything from source.
52 % \end{itemize}
53 % Either way, please see Chapter~\ref{chap:compiler} for a discussion of compiler features.
54 % Compiling \esfinley when its dependencies are already installed is discussed in Chapter~\ref{chap:essrc}.
55 % To compile \esfinley and all dependencies from source please see Chapter~\ref{chap:allsrc}.
56 % 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.
57 %
58 % 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}.}.
59 % Unpack the examples and try to run the following from a terminal:
60 % \begin{shellCode}
61 % run-escript poission.py
62 % \end{shellCode}
63 % If this produces a VTK file called \file{u.vtu} then you are likely to have a functional \esfinley installation.
64 % You can try and visualize the VTK data or delete the file.
65 % 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.
66
67
68
69
70

  ViewVC Help
Powered by ViewVC 1.1.26