%-------------Users' Manual (how to run your software)
\chapter{User Manual}

\section{Data Source}

UCSF's IDL dataset can be downloaded free of charge. The dataset contains a README file that explains how to set up the database.

Links to official resources:
\begin{itemize}
    \item Official IDL Website: \\
    \url{https://www.industrydocuments.ucsf.edu/}
    \item Downloadable IDL dataset: \\
    \url{https://ucsf.app.box.com/v/IDL-DataSets}
\end{itemize}

\section{MariaDB}

We used a CentOS Linux 7 machine for development. To install MariaDB 5.5 on CentOS 7, follow these steps:
\begin{itemize}
    \item Install the MariaDB package
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo yum install mariadb-server
    \end{minted}
    
    \item Start and enable the MariaDB service
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo systemctl start mariadb
    \end{minted}
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo systemctl enable mariadb
    \end{minted}
    
    \item Verify that the installation was successful. The output should state "\texttt{Active: active (running)}".
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo systemctl status mariadb
    \end{minted}
\end{itemize}

\section{Python}

We used Python 3, which can be installed on CentOS 7 by following these steps:
\begin{itemize}
    \item Install IUS (Inline with Upstream Stable)
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo yum -y install https://centos7.iuscommunity.org/ius-release.rpm
    \end{minted}
    
    \item Install the most recent version of Python
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    sudo yum -y install python36u
    \end{minted}
    
    \item Verify that the installation was successful. The output should be "\texttt{Python 3.6.8}".
    \begin{minted}[linenos=false,showspaces=false,breaklines=true]{bash}
    python3.6 -V
    \end{minted}
\end{itemize}

\section{Useful Linux Commands}

We have found the following Linux commands to be useful in our work.
\begin{enumerate}
    \item \mintinline{bash}{ssh user1@tobacco.cs.vt.edu}
    
    This command is used to securely log into the remote machine that we used for development.

    \item \mintinline{bash}{mysql -u root}
 
    This command is used to launch the MySQL shell and enter it as the root user.
    
\section{Interaction with other teams}

During the course of this project, we interacted with multiple teams in order to understand the requirements and fulfill them in a timely manner.

\subsection{ElasticSearch team}
We worked closely with the ElasticSearch team to come up with a suitable contract for the metadata and data fields that could be ingested into ElasticSearch. We retrieved the metadata and data from a MySQL database and converted it into a JSON for ElasticSearch ingestion.

\subsection{Text Analytics and Machine Learning team}
We worked with the Text Analytics and Machine Learning team to understand their requirements and provided them with suitable data. We pre-processed the raw data extracted and handed it over to the TML team for further processing. The TML team used the data provided to apply machine learning algorithms to extract patterns, summaries, and recommendations.


\subsection{Front-end and Kibana team}
We worked closely with our client, Dr. Townsend to understand his research needs in order to guide the Front-end and Kibana (FEK) team in terms of insights about features that can be used for visualizations.

\end{enumerate}