loic/esds
1
0
Fork 0
mirror of https://gitlab.com/manzerbredes/esds.git synced 2025-04-06 10:06:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update manual

Browse source
This commit is contained in:
Loic Guegan 2022-09-13 19:56:22 +02:00
parent 4bb27d9279
commit 024a5a0179
2 changed files with 26 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
manual/manual.pdf
View file

Binary file not shown.

32
manual/manual.tex
View file

@ -21,7 +21,7 @@
\newcommand{\version}{\InputIfFileExists{version}{}{version}} \newcommand{\version}{\InputIfFileExists{version}{}{version}}
\newcommand*{\addsource}[2]{\vspace{0.3cm}\begin{tcolorbox}[breakable,enhanced,arc=1.4mm,arc is angular,title=\textbf{\small#1}]\inputminted[breaklines,fontsize=\scriptsize]{#2}{#1}\end{tcolorbox}} \newcommand*{\addsource}[2]{\vspace{0.3cm}\begin{tcolorbox}[breakable,enhanced,arc=1.4mm,arc is angular,title=\textbf{\small#1}]\inputminted[breaklines,fontsize=\scriptsize]{#2}{#1}\end{tcolorbox}}
\newenvironment{tabminted}[1] \newenvironment{tabminted}[1]
{\VerbatimEnvironment\begin{minipage}{2.5in}\begin{tcolorbox}[frame empty]\begin{minted}{#1}} {\VerbatimEnvironment\begin{minipage}{2.65in}\begin{tcolorbox}[frame empty]\begin{minted}{#1}}
{\end{minted}\end{tcolorbox}\end{minipage}} {\end{minted}\end{tcolorbox}\end{minipage}}
% Document % Document
@ -122,29 +122,49 @@ As explain in Section \ref{sec:firstsimulation:platform}, esds platform files co
Lets see in details the format of each section. Lets see in details the format of each section.
\subsection{General} \subsection{General}
This section is used to settings up the overall parameters of esds. Table\ref{keywords:general} reference all the keywords for this section of the platform file. This section is used to settings up the overall parameters of esds. Table \ref{keywords:general} reference all the keywords for this section of the platform file.
\begin{table}[] \begin{table}[]
\centering \centering
\begin{tabular}{llp{0.4\textwidth}} \begin{tabular}{m{0.25\textwidth}m{0.3\textwidth}p{0.4\textwidth}}
\toprule \toprule
\textbf{Keyword} & \textbf{Description} & \textbf{Example} \\ \midrule \textbf{Keyword} & \textbf{Description} & \textbf{Example} \\ \midrule
\textbf{interferences} & \makecell[l]{Turn on/off interferences detection\\ during wireless communications} & \textbf{interferences} & Turn on/off interferences detection during wireless communications &
\begin{tabminted}{yaml} \begin{tabminted}{yaml}
interferences: on interferences: on
\end{tabminted} \end{tabminted}
\\ \cmidrule{1-3} \\ \cmidrule{1-3}
\textbf{debug} & \makecell[l]{Turn on/off esds debugging\\mode (generate a debug file)} & \textbf{debug} & Turn on/off esds debugging mode (generate a debug file) &
\begin{tabminted}{yaml} \begin{tabminted}{yaml}
debug: on debug: on
\end{tabminted} \end{tabminted}
\\ \cmidrule{1-3} \\ \cmidrule{1-3}
\textbf{debug\_file} & \makecell[l]{Specify the file to use as output\\for the debugging} & \textbf{debug\_file} & Specify the file to use as output for the debugging &
\begin{tabminted}{yaml} \begin{tabminted}{yaml}
debug_file: "./myfile.txt" debug_file: "./myfile.txt"
\end{tabminted}
\\ \cmidrule{1-3}
\textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds should interrupt and call the specified callback &
\begin{tabminted}{yaml}
breakpoints: [5, 6, 7]
\end{tabminted}
\\ \cmidrule{1-3}
\textbf{breakpoints\_every} & Specify an interval of time (in seconds) at which esds will interrupt and call the specified callback &
\begin{tabminted}{yaml}
breakpoints_every: 5
\end{tabminted}
\\ \cmidrule{1-3}
\textbf{breakpoints\_callback} & Tell esds where how to reach the callback used during breakpoints &
\begin{tabminted}{yaml}
breakpoints_callback:
file: "platform_callback.py"
callback: "callback"
\end{tabminted} \end{tabminted}
\\ \bottomrule \\ \bottomrule
\end{tabular} \end{tabular}