diff --git a/contents/user-install.tex b/contents/user-install.tex index 56e1ec69be862a8d4d7dddd98e35bc2405a11f38..4509d8ce78cc22baac812320cca474dc0bc12599 100644 --- a/contents/user-install.tex +++ b/contents/user-install.tex @@ -12,3 +12,65 @@ \chapter{Install guide} \label{chap:user:install} + +\rotare does not require any specific external program to be installed. So the +install process is just a question of downloading the \matlab script and +functions and placing them in at the correct place. + +There are multiple possibilities to install \rotare on your system. As \rotare +code uses libraries as sub modules, the preferred install method is to use \git. +This will ensure everything is up-to-date and installed at the correct place +automatically. If \git is not available, you can manually download the archives +for \rotare and each of its libraries. The libraries will then have to extracted +and moved to the correct place. + + +\section{Install using \git (recommended)} +\label{sec:user:install:git} + +Navigate to the directory where you want to place \rotare and then simply use +\lst{git --recursive} to download the source code and its libraries. + +\begin{lstlisting}[language=bash] +cd ~/Documents/ +git clone --recursive https://gitlab.uliege.be/thlamb/rotare +\end{lstlisting} + +This is it. You now have the latest stable version of \rotare installed on your +computer. You can now open Matlab and navigate to +\directory{Documents/rotare/src/} to start using \rotare. + + +\section{Manual install} +\label{sec:user:install:manual} + +For the manual install you must download the \href{\rotareReleaseURL}{latest +stable release} of \rotare and extract the archive where you want. + +You must then download each library used by \rotare as well and place it in its +appropriate spot in \directory{rotare/src/llibs/}. +\begin{itemize} + \item \href{\afToolsReleaseURL}{matlab\_airfoil\_toolbox} +\end{itemize} + +Once everything is extracted and placed in the correct space, \rotare should +work as expected. + + +\section{Update} +\label{sec:user:install:update} +Before any update, it is recommended to \textbf{make a backup of your existing +configuration files and results} outside of \rotare's working directory. + +\subsection{Using \git} +Navigate to \rotare's directory and simply run +\begin{lstlisting}[language=bash] +git pull --recurse-submodules +\end{lstlisting} +This will update \rotare and its libraries. This should not modify your +configuration files or the results you generated. + +\subsection{Manually} +Repeat the steps described in Section~\ref{sec:user:install:manual} and copy the +new files over the older ones. You could also just extract it somewhere else and +move your configurations files and results to the new directory.