Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Rotare
Documentation
Commits
92f7ad3e
Verified
Commit
92f7ad3e
authored
2 years ago
by
Thomas Lambert
Browse files
Options
Downloads
Patches
Plain Diff
feat(install): basic install guide
parent
42ddf4a6
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
contents/user-install.tex
+62
-0
62 additions, 0 deletions
contents/user-install.tex
with
62 additions
and
0 deletions
contents/user-install.tex
+
62
−
0
View file @
92f7ad3e
...
...
@@ -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.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment