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
90eaa6e3
Verified
Commit
90eaa6e3
authored
2 years ago
by
Thomas Lambert
Browse files
Options
Downloads
Patches
Plain Diff
fix(install): reformulate, add minor details
parent
48e481e7
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#8627
passed
2 years ago
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
contents/user-install.tex
+16
-9
16 additions, 9 deletions
contents/user-install.tex
rotare-doc.tex
+7
-0
7 additions, 0 deletions
rotare-doc.tex
with
23 additions
and
9 deletions
contents/user-install.tex
+
16
−
9
View file @
90eaa6e3
...
...
@@ -29,7 +29,7 @@ and moved to the correct place.
\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.
\lst
{
git
clone
--recursive
}
to download the source code and its libraries.
\begin{lstlisting}
[language=bash]
cd ~/Documents/
...
...
@@ -37,8 +37,8 @@ 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
.
computer. You can open Matlab and navigate to
\directory
{
Documents/rotare/src/
}
to start using
\rotare
.
\section
{
Manual install
}
...
...
@@ -47,19 +47,20 @@ computer. You can now open Matlab and navigate to
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/
}
.
You must then download each library used by
\rotare
as well and place
them in
their
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 s
pace
,
\rotare
should
work as expected.
Once everything is extracted and placed in the correct s
ub-directory
,
\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
In principle, the update process should never touch any of your files. However,
before any update, it is advised to
\textbf
{
make a backup of your existing
configuration files and results
}
outside of
\rotare
's working directory.
\subsection
{
Using
\git
}
...
...
@@ -68,9 +69,15 @@ Navigate to \rotare's directory and simply run
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.
configuration files or the results you generated. However, if you modified some
portions of the source code, it may fail to update. In that case, follow
\git
's
instructions to either remove your changes, or commit them and resolve the merge
conflict.
\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.
Note that if you modified some files of the source code, a simple copy/past will
erase these changes.
This diff is collapsed.
Click to expand it.
rotare-doc.tex
+
7
−
0
View file @
90eaa6e3
...
...
@@ -131,6 +131,13 @@ draft=false, % toggle if draft version
\input
{
contents/titlepage
}
% Titlepage
\cleardoublepage
% TODO: Add a copyright notice
% Documentation and images are CC-BY-SA-4.0
% Code is MIT
\currentpdfbookmark
{
\contentsname
}{
toc
}
\setcounter
{
tocdepth
}{
2
}
% define depth of toc
\tableofcontents
% display table of contents
...
...
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