doc/install/intro.tex

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Copyright (c) 2003-2018 by The University of Queensland
% http://www.uq.edu.au
%
% Primary Business: Queensland, Australia
% Licensed under the Apache License, version 2.0
% http://www.apache.org/licenses/LICENSE-2.0
%
% Development until 2012 by Earth Systems Science Computational Center (ESSCC)
% Development 2012-2013 by School of Earth Sciences
% Development from 2014 by Centre for Geoscience Computing (GeoComp)
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\chapter{Introduction}
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.
To learn how to use \esfinley please see the Cookbook, User's guide or the API documentation.

\esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems.
It can be installed in several ways:
\begin{enumerate}
  \item Binary packages -- ready to run with no compilation required.
  These are available in Debian and Ubuntu repositories, so just use your normal package manager (so you don't need this guide). They are also available for Anaconda Python 3.
  \item Using flatpak
  \item From source -- that is, it must be compiled for your machine.
This is the topic of this guide.
\end{enumerate}

See the site \url{https://answers.launchpad.net/escript-finley} for online help.
Chapter~\ref{chap:source} covers installing from source.
Appendix~\ref{app:cxxfeatures} lists some c++ features which your compiler must support in order to compile escript.
This version of escript has the option of using \texttt{Trilinos} in addition to our regular solvers.
Appendix~\ref{app:trilinos} covers features of \texttt{Trilinos} which escript needs.
1	jfenwick	3989	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2	jfenwick	6651	% Copyright (c) 2003-2018 by The University of Queensland
3	jfenwick	3989	% http://www.uq.edu.au
4	jfenwick	2289	%
5			% Primary Business: Queensland, Australia
6	jfenwick	6112	% Licensed under the Apache License, version 2.0
7			% http://www.apache.org/licenses/LICENSE-2.0
8	jfenwick	2289	%
9	jfenwick	3989	% Development until 2012 by Earth Systems Science Computational Center (ESSCC)
10	jfenwick	4657	% Development 2012-2013 by School of Earth Sciences
11			% Development from 2014 by Centre for Geoscience Computing (GeoComp)
12	jfenwick	3989	%
13			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14	jfenwick	2289
15	jfenwick	2529	\chapter{Introduction}
16	jfenwick	4439	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.
17	jfenwick	3339	To learn how to use \esfinley please see the Cookbook, User's guide or the API documentation.
18	jfenwick	2333
19	caltinay	2538	\esfinley is primarily developed on Linux desktop, SGI ICE and \macosx systems.
20	aellery	6919	It can be installed in several ways:
21	caltinay	2538	\begin{enumerate}
22	aellery	6919	\item Binary packages -- ready to run with no compilation required.
23	uqaeller	7011	These are available in Debian and Ubuntu repositories, so just use your normal package manager (so you don't need this guide). They are also available for Anaconda Python 3.
24	aellery	6919	\item Using flatpak
25	jfenwick	4383	\item From source -- that is, it must be compiled for your machine.
26	jfenwick	6391	This is the topic of this guide.
27	caltinay	2538	\end{enumerate}
28
29	jfenwick	3970	See the site \url{https://answers.launchpad.net/escript-finley} for online help.
30	jfenwick	4439	Chapter~\ref{chap:source} covers installing from source.
31	jfenwick	6592	Appendix~\ref{app:cxxfeatures} lists some c++ features which your compiler must support in order to compile escript.
32			This version of escript has the option of using \texttt{Trilinos} in addition to our regular solvers.
33	aellery	6919	Appendix~\ref{app:trilinos} covers features of \texttt{Trilinos} which escript needs.