opm-simulators/doc/handbook/quick-install.tex

74 lines
3.0 KiB
TeX
Raw Normal View History

\section{Installation of \eWoms} \label{quick-install}
This section describes a way of installing \eWoms that works in most
cases, but depending on your operating system of choice, \Cplusplus
2012-11-01 10:34:50 -05:00
compiler and features which you need, some tweaks are possibly
required. As a pre-requisite it is assumed, that you are using a
recent Linux distribution that has the appropriate development
packages (\Cplusplus compiler, autoconf, automake, libtool and
pkg-config amongst possibly others) installed, but that you did not
install \Dune via distribution provided packages. If you need more
information, or if you have \Dune already installed, please have a
look at the detailed installation instructions in Section
\ref{install}.
\subsection{Retrieving the code}
2012-11-01 10:34:50 -05:00
You can retrieve all required \Dune modules by either downloading and
unpacking the tarballs for the \Dune-2.2 release followed by
downloading and unpacking the tarball for the \eWoms 2.2 release, or
by retrieving the code directly from their respective source-code
repositories. If you decide to use the first method, make sure to
unpack all tarballs into the same directory; if you prefer the second
method, make sure that you have the \texttt{git} version control
system with the SVN plug-in installed on your computer and enter the
following code snippet into a terminal:
2012-02-01 14:37:41 -06:00
\begin{lstlisting}[style=Bash]
cd $YOUR_DUNE_ROOT_DIRECTORY
for DUNE_MODULE in common geometry grid istl localfunctions; do \
git svn clone https://svn.dune-project.org/svn/dune-$DUNE_MODULE/branches/release-2.2 $DUNE_MODULE \
done
git clone --branch "release-2.2" git://github.com/OPM/ewoms.git
2012-02-01 14:37:41 -06:00
\end{lstlisting}
%$
2012-02-01 14:37:41 -06:00
\subsection{Building \Dune and \eWoms}
2012-02-01 14:37:41 -06:00
\label{buildIt}
2012-11-01 10:34:50 -05:00
\eWoms is a \Dune module and is recommended to build it using the \Dune
build system~\cite{DUNE-BS}. To simplify things, \eWoms ships with a
few option files for \Dune's build script, \texttt{dunecontrol}. If
2012-11-01 10:34:50 -05:00
you are using \eWoms the first time, we recommend to use the options
optimized for the debugging experience, \texttt{debug.opts}:
2012-02-01 14:37:41 -06:00
\begin{lstlisting}[style=Bash]
cd $YOUR_DUNE_ROOT_DIRECTORY
./dune-common/bin/dunecontrol --opts=ewoms/debug.opts all
2012-02-01 14:37:41 -06:00
\end{lstlisting}
%$
2012-02-01 14:37:41 -06:00
Once you have finished developing and testing your own code on
small-scale problems, re-compile everything with compiler
optimizations enabled before a production run in order to speed things
up by a factor of approximately 10:
2012-02-01 14:37:41 -06:00
\begin{lstlisting}[style=Bash]
cd $YOUR_DUNE_ROOT_DIRECTORY
./dune-common/bin/dunecontrol --opts=ewoms/optim.opts all
2012-02-01 14:37:41 -06:00
\end{lstlisting}
%$
2012-02-01 14:37:41 -06:00
2012-11-01 10:34:50 -05:00
Sometimes it is necessary to have additional options which might be
specific to the operating system of your choice, or if you have
special requirements. For this reason, the option files mentioned
above should be rather understood as a starting point for your own
option files than as something fixed; feel free to copy and modify
2012-11-01 10:34:50 -05:00
them. To avoid confusion, it is helpful to rename your
customized option files, though.
%%% Local Variables:
%%% mode: latex
%%% TeX-master: "ewoms-handbook"
%%% End: