Skip to content
Snippets Groups Projects
Verified Commit 48e481e7 authored by Thomas Lambert's avatar Thomas Lambert :helicopter:
Browse files

feat(usage): basic usage guide

parent f4686193
No related branches found
No related tags found
No related merge requests found
Pipeline #8626 passed
......@@ -12,3 +12,32 @@
\chapter{Usage}
\label{chap:user:usage}
\rotare is fully controlled by a single input file, where the user specifies the
simulation parameters, the rotor geometry, the flow conditions, etc. See
Chapter~\ref{chap:user:input} for details about this configuration file. In
theory this is the only place that requires user's attention.
First of all, make sure you are in the \directory{rotare/src/} directory, or
that it is in \matlab's Path.
\rotare can be called directly with a configuration file or without one. If no
configuration file is provided, the user will be prompted to select a
configuration file manually. This feature allows the user to call \rotare from
an other script and simplifies the interfacing between \rotare and other
scripts.
\bigskip
\begin{lstlisting}[language=matlab]
% Manual selection of input file
rotare
% With a specific config file
rotare('configs/my_config.m')
\end{lstlisting}
\rotare comes with a few test configs (a template file and some reproduction of
experimental results). You can verify that everything is working as intended by
running any of these files:
\begin{lstlisting}[language=matlab]
rotare('configs/template.m')
\end{lstlisting}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment