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-14 08:24:29 +02:00
parent 800b2098ae
commit e4b742cff3
3 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
manual/.gitignore vendored
View file

@ -4,5 +4,6 @@ _minted-manual
*.log *.log
*.out *.out
*.pre *.pre
*.toc
svg-inkscape svg-inkscape
version version

BIN
manual/manual.pdf
View file

Binary file not shown.

20
manual/manual.tex
View file

@ -48,6 +48,8 @@
\end{titlepage} \end{titlepage}
\pagebreak \pagebreak
\tableofcontents
\pagebreak
\section{Architecture of ESDS} \section{Architecture of ESDS}
@ -88,7 +90,7 @@ the last \verb|platform.yaml| file:
\subsection{Execution} \subsection{Execution}
\label{sec:firstsimulation:execution} \label{sec:firstsimulation:execution}
To execute our first simulation, the following command should be executed from the same folder To run our first simulation, the following command can be run:
that contains \verb|platform.yaml| and \verb|node.py|: that contains \verb|platform.yaml| and \verb|node.py|:
\begin{verbatim} \begin{verbatim}
> esds run platform.yaml > esds run platform.yaml
@ -120,7 +122,7 @@ As explain in Section \ref{sec:firstsimulation:platform}, esds platform files co
\end{enumerate} \end{enumerate}
Lets see in details the format of each section. Lets see in details the format of each section.
\subsection{General} \subsection{The general section}
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}
@ -148,7 +150,7 @@ debug_file: "./myfile.txt"
\end{tabminted} \end{tabminted}
\\ \cmidrule{1-3} \\ \cmidrule{1-3}
\textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds should interrupt and call the specified callback & \textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds must interrupt and call the specified callback &
\begin{tabminted}{yaml} \begin{tabminted}{yaml}
breakpoints: [5, 6, 7] breakpoints: [5, 6, 7]
\end{tabminted} \end{tabminted}
@ -173,7 +175,7 @@ breakpoints_callback:
\label{keywords:general} \label{keywords:general}
\end{table} \end{table}
\subsection{Node} \subsection{The node section}
The node section is used configure the simulated node of esds. Table \ref{keywords:nodes} references The node section is used configure the simulated node of esds. Table \ref{keywords:nodes} references
all the keywords used in the nodes section. all the keywords used in the nodes section.
@ -198,7 +200,7 @@ implementations:
\end{tabminted} \end{tabminted}
\\ \cmidrule{1-3} \\ \cmidrule{1-3}
\textbf{arguments} & Define the arguments that should be pass to each node implementation (keys of each element uses \textbf{the range syntax}) & \textbf{arguments} & Define the arguments that will be passed to each node implementation (keys of each element uses \textbf{the range syntax}) &
\begin{tabminted}{yaml} \begin{tabminted}{yaml}
arguments: { arguments: {
"all": 2 "all": 2
@ -211,16 +213,16 @@ arguments: {
\label{keywords:nodes} \label{keywords:nodes}
\end{table} \end{table}
Many entries in the platform file use a \textbf{range syntax} to map informations (node Several entries in the platform file use a \textbf{range syntax} to map informations (node
implementations, links etc.) to node ids. Indeed, when running a simulation with $p$ nodes, each implementations, links etc.) to node $ids$. Indeed, when running a simulation with $p$ nodes, each
node will have an allocated $id$ such that $id \in [0,1,...,p-1]$. Here are examples of the range node will have an allocated $id$ such that $id \in [0,1,...,p-1]$. Here are examples of valid range
syntax for a simulation that uses 5 nodes: syntax for a simulation that uses 5 nodes:
\begin{itemize} \begin{itemize}
\item \makebox[2cm]{\textbf{0,1,2,3}\hfill} Node 0,1,2 and 3 \item \makebox[2cm]{\textbf{0,1,2,3}\hfill} Node 0,1,2 and 3
\item \makebox[2cm]{\textbf{0-2}\hfill} Node 0,1 and 2 \item \makebox[2cm]{\textbf{0-2}\hfill} Node 0,1 and 2
\item \makebox[2cm]{\textbf{all}\hfill} Node 0,1,2,3 and 4 \item \makebox[2cm]{\textbf{all}\hfill} Node 0,1,2,3 and 4
\item \makebox[2cm]{\textbf{2-@}\hfill} Node 2,3 and 4 \item \makebox[2cm]{\textbf{2-@}\hfill} Node 2,3 and 4
\item \makebox[2cm]{\textbf{0-@}\hfill} Node 0,1,2,3 and 4 \item \makebox[2cm]{\textbf{0-@}\hfill} Node 0,1,2,3 and 4 (same as \textbf{all})
\end{itemize} \end{itemize}
\end{document} \end{document}