Skip to content
Snippets Groups Projects
Commit f90494c9 authored by Ivo Peterek's avatar Ivo Peterek
Browse files

ENH: added requiremets and and gui startup instructions to Readme #7

parent 0a576022
No related branches found
No related tags found
No related merge requests found
\section{Configuring and other features}
\subsection{LaTeX report dialog} \label{dialog}
\section{RADAR GUI requirements}
In order to run RADAR GUI following list of software must be installed in your computer:
\begin{itemize}
\item Python3
\item PyQt5
\item scikit-learn
\item matplotlib
\item pydot
\end{itemize}
\section{RADAR GUI startup}
In our repository we have two versions of RADAR GUI application one of them is used only for creating configuration file for RADAR, second application also visualize results of RADAR analysis. This section describes walkthrough of RADAR configuration in both of them.
\subsection{RADAR GUI with analysis results}
To use RADAR GUI with analysis results a user should run file named ''\texttt{runRadarGUI\_analyze.py}". After startup a user will see dialog in Figure \ref{startupAnalysis}.
\begin{figure}[H]
\centering
\includegraphics[width=.8\textwidth]{img/runRadarGUIanalyze.png}
\caption{''\texttt{runRadarGUI\_analyze.py}" startup dialog}
\label{startupAnalysis}
\end{figure}
There are three ways to proceed from this dialog.
\begin{itemize}
\item Enter path to MERIC measurement data and click on button Configure for first creating new configuration file with desired measurement data.
\item Enter path to RADAR configuration file for either editing existing configuration file or for directly running RADAR analysis.
\item Enter both data path and configuration file path for editing of existing configuration file with new data saved in another directory.
\end{itemize}
After clicking to Configure button chapter \ref{configRadarAnalysis} follows. When choosing option two and directly running analysis continue with chapter \ref{mainMenu}.
\subsubsection{Configuraton of RADAR}\label{configRadarAnalysis}
Window for RADAR configuration consits of two tabs Regions (Figure \ref{configureWindowRegions}) and Data parameters (Figure \ref{configureWindowDataParams}).
\begin{figure}[H]
\centering
\includegraphics[width=.8\textwidth]{img/texDialogGUI.png}
\caption{First appearance of the report dialog}
\includegraphics[width=.8\textwidth]{img/configure.png}
\caption{Example of RADAR configuration window - Regions tab}
\label{configureWindowRegions}
\end{figure}
In Regions tab a user should change Main region to correct value corresponding to data measurement. Then select desired nested regions for following analysis. For quick selection of nested regions a filtering by time can be used, if none of nested regions is selected the filter will select all regions with run time higher than set value or if some of nested regions are already selected the filter will remove from your selection those with run time which is less than set value. To view region structure with run times for each region click on Show region tree button. Example of region structure is shown in Figure \ref{regTreeCOnfig}. User may also set up iteration region, this option is not required(default value is None).
\begin{figure}[H]
\centering
\includegraphics[width=.8\textwidth]{img/regTreeConfig.png}
\caption{Example of region tree}
\label{regTreeCOnfig}
\end{figure}
dodelat
\begin{figure}[H]
\centering
\includegraphics[width=.8\textwidth]{img/texDialog2.png}
\caption{More detailed structure of the report dialog}
\includegraphics[width=.8\textwidth]{img/configDataParams.png}
\caption{Example of RADAR configuration window - Data parameters tab}
\label{configureWindowDataParams}
\end{figure}
\ No newline at end of file
No preview for this file type
......@@ -36,7 +36,9 @@
\tableofcontents
\newpage
\setcounter{page}{1}
\section{Main menu}
\input{config_etc}
\newpage
\section{Main menu}\label{mainMenu}
\begin{figure}[H]
\centering
\includegraphics[width=.4\textwidth]{img/mainMenu.png}
......@@ -46,6 +48,4 @@
\newpage
\input{apps}
\newpage
\input{config_etc}
\end{document}
\ No newline at end of file
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