Commit 555af7ef authored by Dominic Etienne Charrier's avatar Dominic Etienne Charrier
Browse files

Update a few sections in download chapter.

parent 9dd25e2b
......@@ -53,9 +53,7 @@ libraries are required.
\section{Obtaining ExaHyPE}
\exahype\ is available as source code only. We discuss several variants how to
obtain the code below\footnote{Please note that the \exahype\ consortium uses
internally a private repository, i.e.~all remarks here refer to the public
\exahype\ release.}.
obtain the code below.
\exahype\ is built on top of the AMR framework Peano.
If you download a complete snapshot of \exahype\ (the \texttt{tar.gz} files), a
snapshot of Peano is included.
......@@ -64,69 +62,75 @@ If you clone the repository (Variant 2), you have to add Peano manually.
\subsection*{Variant 1: Download an \exahype\ release}
%\textcolor{red}{TODO Dominic: dead link, whole part seems not up to date}
Open a browser and go to \url{http://www.peano-framework.org}.
Here, click on \texttt{Request Repository Access} and fill
out the application form. Click on \texttt{Register}. The application will
trigger a creation of a LRZ account linked to the Peano and \exahype\ projects.
Eventually, you will get reporter access to the software repositories via
\url{https://gitlab.lrz.de}. You will get notified by mail as soon
as this is the case. The process can take a few days.
Open a browser and go to \url{http://csdemo.ddns.net/hpcsoftware/exahype}.
Switch to the \texttt{Download} tab, where you should find a section \texttt{Download of Snapshots}.
Find the release of your choice and download it.
% A minimalistic \exahype\ version requires \texttt{ExaHyPE.tar.gz} and
% %\linebreak
% \texttt{ExaHyPE.jar}.
% Unzip them.
\subsection*{Variant 2: Clone the \exahype\ release repository}
Alternatively, you might also want to clone the \exahype\ git repository
which has the advantage that you can quickly get new releases.
We host it on a gitlab at Leibniz Supercomputing Centre and grant free access to all sources and documentation.
However, we ask users who want to actively access the repository, the maillist, the bug lists, and so forth to register.
Once you have access to the repository you can download the repository using
something along the lines of
The \exahype\ repository can then be cloned via:
\begin{code}
> git clone https://gitlab.lrz.de/exahype/ExaHyPE-Engine.git
\end{code}
or
\begin{code}
> git clone git@gitlab.lrz.de:exahype/ExaHyPE-Engine.git
\end{code}
There is consequently no need to unzip anything manually if you follow this variant.
While we do provide snapshots of Peano, \exahype's underlying meshing component,
with \exahype\ snapshots (the tar.gz files we offer), Peano itself is not
mirrored in the repository.
You therefore have to download Peano separately:
Visit \href{http://www.peano-framework.org}{peano-framework.org} and follow the
descriptions there.
Afterwards, add two symbolic links from \exahype's \texttt{Peano} directory to
your Peano installation\footnote{If you grab the Peano repository, the
sources are held in a subdirectory \texttt{src} as the checkout also comes
along with many other things such as development tools or documentation.
If you download the tarball from the webpage, it usually holds only Peano's
sources. In this case, you might have to omit the \texttt{src} subdirectory in
the symbolic links.}:
\begin{code}
> cd Peano
> ls
mpibalancing multiscalelinkedcell sharedmemoryoracles
> ln -s yourPeanodirectory/src/peano
> ln -s yourPeanodirectory/src/tarch
> ls
mpibalancing multiscalelinkedcell peano sharedmemoryoracles tarch
> git@gitlab.lrz.de:exahype/ExaHyPE-Engine.git
\end{code}
\noindent
We do trigger that Peano is updated regularly and \exahype's build environment
does validate your Peano version against its on requirements.
Yet, as Peano is an independent package with a different release
model/schedule, we cannot enure that a tarball of Peano obtained from
SourceForge or \href{http://www.peano-framework.org}{peano-framework.org} is fully compatible with the
current ExaHyPE release.
If you encounter problems, we therefore recommend that you use the snapshot of
Peano provided in \texttt{ExaHyPE.tar.gz}.
It is guaranteed to be compatible with the ExaHyPE.
% \subsection*{Variant 2: Clone the \exahype\ release repository}
%
% Alternatively, you might also want to clone the \exahype\ git repository
% which has the advantage that you can quickly get new releases.
% We host it on a gitlab at Leibniz Supercomputing Centre and grant free access to all sources and documentation.
% However, we ask users who want to actively access the repository, the maillist, the bug lists, and so forth to register.
%
% Once you have access to the repository you can download the repository using
% something along the lines of
% \begin{code}
% > git clone https://gitlab.lrz.de/exahype/ExaHyPE-Engine.git
% \end{code}
% or
% \begin{code}
% > git clone git@gitlab.lrz.de:exahype/ExaHyPE-Engine.git
% \end{code}
% There is consequently no need to unzip anything manually if you follow this variant.
%
%
% While we do provide snapshots of Peano, \exahype's underlying meshing component,
% with \exahype\ snapshots (the tar.gz files we offer), Peano itself is not
% mirrored in the repository.
% You therefore have to download Peano separately:
% Visit \href{http://www.peano-framework.org}{peano-framework.org} and follow the
% descriptions there.
% Afterwards, add two symbolic links from \exahype's \texttt{Peano} directory to
% your Peano installation\footnote{If you grab the Peano repository, the
% sources are held in a subdirectory \texttt{src} as the checkout also comes
% along with many other things such as development tools or documentation.
% If you download the tarball from the webpage, it usually holds only Peano's
% sources. In this case, you might have to omit the \texttt{src} subdirectory in
% the symbolic links.}:
% \begin{code}
% > cd Peano
% > ls
% mpibalancing multiscalelinkedcell sharedmemoryoracles
% > ln -s yourPeanodirectory/src/peano
% > ln -s yourPeanodirectory/src/tarch
% > ls
% mpibalancing multiscalelinkedcell peano sharedmemoryoracles tarch
% \end{code}
%
% \noindent
% We do trigger that Peano is updated regularly and \exahype's build environment
% does validate your Peano version against its on requirements.
% Yet, as Peano is an independent package with a different release
% model/schedule, we cannot enure that a tarball of Peano obtained from
% SourceForge or \href{http://www.peano-framework.org}{peano-framework.org} is fully compatible with the
% current ExaHyPE release.
% If you encounter problems, we therefore recommend that you use the snapshot of
% Peano provided in \texttt{ExaHyPE.tar.gz}.
% It is guaranteed to be compatible with the ExaHyPE.
% \subsection*{Variant 3: Download \exahype\ as archives from the
......@@ -148,17 +152,21 @@ It is guaranteed to be compatible with the ExaHyPE.
\section*{Obtaining the dependencies}
ExaHyPE's development environment relies on a few Python 3 dependencies. They are
all registered as git submodule to the project.
Peano is also registered as a git submodule
all registered as git submodule to the project. Peano is also registered as a
git submodule
To obtain them, run the update script:
\begin{code}
> ./Submodules/updateSubmodules.sh
\end{code}
A few options are proposed and can be seen using the \texttt{-h} flag.
Different options to modify the download procedure are listed if
you call the script with option ``\texttt{-h}'', e.g.
use \texttt{git clone} with the \texttt{git} (``\texttt{-s}'') or \texttt{https}
protocol (``\texttt{-w}''),
We ensured that ExaHyPE can be setup on systems where you are
required to create an SSH tunnel to \texttt{github.com} or
\texttt{gitlab.lrz.de}.
\section*{Finish the setup}
Once you have unzipped all the archives into a directory of your choice, you
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment