From be11125a7f9cbca71339e1c7382faee8556b8f6d Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Thu, 2 Feb 2023 16:37:30 +0100
Subject: [PATCH] chore(usage): reformat, add examples
---
contents/user-usage.tex | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
diff --git a/contents/user-usage.tex b/contents/user-usage.tex
index 9e3feb6..6b261e6 100644
--- a/contents/user-usage.tex
+++ b/contents/user-usage.tex
@@ -13,21 +13,20 @@
\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
+\rotare is entirely 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. 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.
+In order to use \rotare, 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.
+configuration file manually.
\bigskip
+
\begin{lstlisting}[language=matlab]
% Manual selection of input file
rotare
@@ -40,4 +39,6 @@ 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')
+rotare('configs/caradonna1981.m')
+rotare('configs/knight1937.m')
\end{lstlisting}
--
GitLab