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

Revision 4439 - (show annotations)
Wed Jun 5 02:09:35 2013 UTC (6 years, 1 month ago) by jfenwick
File MIME type: application/x-tex
File size: 3107 byte(s)
some work on install doco

 1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 2 % Copyright (c) 2003-2013 by University of Queensland 3 4 % 5 % Primary Business: Queensland, Australia 6 % Licensed under the Open Software License version 3.0 7 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 to 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 and you have installed the \texttt{escript-doc} package then the documentation 18 will be available in 19 \file{/usr/share/doc/escript-doc}, otherwise (if you haven't done so already) you can download the documentation bundle 20 from launchpad. 21 22 23 24 \esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems. 25 It can be installed in two ways: 26 \begin{enumerate} 27 \item Binary packages -- ready to run with no compilation required. 28 Bundles are available for: 29 \begin{itemize} 30 \item .deb files for Debian and Ubuntu Linux 31 \item $32$bit Windows (requires some other packages to be installed). 32 \end{itemize} 33 Please see Appendix~\ref{winstall} for Windows instructions. 34 The rest of this guide assumes you are using a posix like system. 35 \item From source -- that is, it must be compiled for your machine. 36 This will be required if there is no binary package 37 for your machine or if extra functionality is required such as \mpi parallelisation. 38 \end{enumerate} 39 40 \emph{The major change from the point of view of installation is that we no longer provide binary packages compiled 41 against the support bundles''. 42 This means, there are no longer binary packages for MacOS or generic Linux. 43 } 44 One can still build from source and we have endevoured to make this process as straight forward as possible. 45 46 See the site \url{https://answers.launchpad.net/escript-finley} for online help. 47 Chapter~\ref{chap:bin} describes how to install binary packages on Debian/Ubuntu systems. 48 Chapter~\ref{chap:source} covers installing from source. 49 Appendix~\ref{chap:winstall} gives brief instructions for Windows. 50 51 52 % \section{Significant changes since version 3.3} 53 % 54 % \begin{itemize} 55 % \item The minimum Python version is now $2.6$. 56 % This means among other things that you can no longer build escript using the system Python from OSX Leopard. 57 % \item New [optional] symbolic support requires SymPy. 58 % \item This release contains the \module{downunder} inversion module. Certain operations in this module \emph{may} require either 59 % \module{pyproj}\footnote{python-pyproj in Debian and Ubuntu} or \module{gdal}\footnote{python-gdal in Debian and Ubuntu}. 60 % Escript will warn you if you try to do something which requires either package. 61 % \end{itemize} 62